com.viaoa.util

Enum OAFlagEnum

java.lang.Object

java.lang.Enum<OAFlagEnum>

com.viaoa.util.OAFlagEnum

All Implemented Interfaces:

Serializable, Comparable<OAFlagEnum>

public enum OAFlagEnum
extends Enum<OAFlagEnum>

used as an 3-state flag

Author:

vvia

Enum Constant Summary

Enum Constants

Enum Constant and Description
Either
False
True

Method Summary

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

False

public static final OAFlagEnum False

True

public static final OAFlagEnum True

Either

public static final OAFlagEnum Either

Method Detail

values

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

Returns:

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

valueOf

public static OAFlagEnum 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