info.magnolia.module.blossom.annotation
Enum TernaryBoolean

java.lang.Object
  java.lang.Enum<TernaryBoolean>
      info.magnolia.module.blossom.annotation.TernaryBoolean

All Implemented Interfaces:

Serializable, Comparable<TernaryBoolean>

public enum TernaryBoolean
extends Enum<TernaryBoolean>

Enumeration used for representing a ternary boolean value, true, false or unspecified.

Since:

2.0

Enum Constant Summary

FALSE

TRUE

UNSPECIFIED

Method Summary

static Boolean	toBoolean(TernaryBoolean t)
static TernaryBoolean	valueOf(String name) Returns the enum constant of this type with the specified name.
static TernaryBoolean[]	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

TRUE

public static final TernaryBoolean TRUE

FALSE

public static final TernaryBoolean FALSE

UNSPECIFIED

public static final TernaryBoolean UNSPECIFIED

Method Detail

values

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

Returns:

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

valueOf

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

toBoolean

public static Boolean toBoolean(TernaryBoolean t)