org.compass.annotations
Enum NABoolean

java.lang.Object
  java.lang.Enum<NABoolean>
      org.compass.annotations.NABoolean

All Implemented Interfaces:

Serializable, Comparable<NABoolean>

public enum NABoolean
extends Enum<NABoolean>

A three state boolean, with TRUE, FALSE, and NA (which usually means that eitehr a global setting or system wide default value will control it).

Author:

kimchy

Enum Constant Summary

FALSE

NA

TRUE

Method Summary

static NABoolean	valueOf(String name) Returns the enum constant of this type with the specified name.
static NABoolean[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TRUE

public static final NABoolean TRUE

FALSE

public static final NABoolean FALSE

NA

public static final NABoolean NA

Method Detail

values

public static final NABoolean[] values()

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

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

Returns:

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

valueOf

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