Enum Class CAIncludeDeleted

java.lang.Object

java.lang.Enum<CAIncludeDeleted>

com.io7m.cardant.model.CAIncludeDeleted

All Implemented Interfaces:

Serializable, Comparable<CAIncludeDeleted>, Constable

public enum CAIncludeDeleted
extends Enum<CAIncludeDeleted>

Whether to include deleted data.

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
INCLUDE_BOTH_LIVE_AND_DELETED	Include data regardless of whether it has been deleted.
INCLUDE_ONLY_DELETED	Include only data that has been deleted.
INCLUDE_ONLY_LIVE	Include only data that has not been deleted.

Method Summary

Modifier and Type	Method	Description
static CAIncludeDeleted	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CAIncludeDeleted[]	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

Enum Constant Details

INCLUDE_ONLY_LIVE

public static final CAIncludeDeleted INCLUDE_ONLY_LIVE

Include only data that has not been deleted.

INCLUDE_ONLY_DELETED

public static final CAIncludeDeleted INCLUDE_ONLY_DELETED

Include only data that has been deleted.

INCLUDE_BOTH_LIVE_AND_DELETED

public static final CAIncludeDeleted INCLUDE_BOTH_LIVE_AND_DELETED

Include data regardless of whether it has been deleted.

Method Details

values

public static CAIncludeDeleted[] 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 CAIncludeDeleted 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