org.grouplens.lenskit.core

Enum ModelDisposition

java.lang.Object

java.lang.Enum<ModelDisposition>

org.grouplens.lenskit.core.ModelDisposition

All Implemented Interfaces:

Serializable, Comparable<ModelDisposition>

public enum ModelDisposition
extends Enum<ModelDisposition>

The way components should be handled when building a LensKit recommender.

Since:

2.1

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXCLUDED Exclude components in the model.
INCLUDED Include components in the model.

Method Summary

Modifier and Type	Method and Description
static ModelDisposition	valueOf(String name) Returns the enum constant of this type with the specified name.
static ModelDisposition[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INCLUDED

public static final ModelDisposition INCLUDED

Include components in the model. When applied to a configuration, components set up by that configuration will be included in the model (recommender engine).

EXCLUDED

public static final ModelDisposition EXCLUDED

Exclude components in the model. When applied to configuration, components set up by that configuration will be removed from the model. The resulting model will not work unless the required components are re-supplied.

Method Detail

values

public static ModelDisposition[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ModelDisposition c : ModelDisposition.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ModelDisposition valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null