org.cyclos.model

Enum Availability

java.lang.Object

java.lang.Enum<Availability>

org.cyclos.model.Availability

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Availability>, HasMessageKey

public enum Availability
extends java.lang.Enum<Availability>
implements HasMessageKey

Utility enum with the Possible values regarding availability of some data.

Author:

ameyer

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLED The data is disabled
OPTIONAL The data is enabled and optional
REQUIRED The data is enabled and required

Method Summary

Modifier and Type	Method and Description
MessageKey	getMessageKey()
static Availability	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Availability[]	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

OPTIONAL

public static final Availability OPTIONAL

The data is enabled and optional

REQUIRED

public static final Availability REQUIRED

The data is enabled and required

DISABLED

public static final Availability DISABLED

The data is disabled

Method Detail

values

public static Availability[] 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 (Availability c : Availability.values())
    System.out.println(c);

Returns:

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

valueOf

public static Availability valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getMessageKey

public MessageKey getMessageKey()

Specified by:

getMessageKey in interface HasMessageKey