Enum Class Inclusion

java.lang.Object

java.lang.Enum<Inclusion>

org.deltava.beans.Inclusion

All Implemented Interfaces:

Serializable, Comparable<Inclusion>, Constable, ComboAlias, EnumDescription

public enum Inclusion
extends Enum<Inclusion>
implements EnumDescription

An enumeration to store inclusion/exclusion values.

Since:

8.6

Version:

9.0

Author:

Luke

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL
EXCLUDE
INCLUDE

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.deltava.beans.EnumDescription

getComboAlias, getComboName, getDescription, name

Enum Constant Details

ALL

public static final Inclusion ALL

INCLUDE

public static final Inclusion INCLUDE

EXCLUDE

public static final Inclusion EXCLUDE

Method Details

values

public static Inclusion[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Inclusion valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null