Package adams.core

Enum TriState

java.lang.Object

java.lang.Enum<TriState>

adams.core.TriState

All Implemented Interfaces:

EnumWithCustomDisplay<TriState>, EnumWithCustomParsing<TriState>, Serializable, Comparable<TriState>

public enum TriState
extends Enum<TriState>
implements EnumWithCustomDisplay<TriState>

Enum that enhances a boolean to have a third state: not set.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Enum Constant Summary

Enum Constants

Enum Constant	Description
FALSE	false.
NOT_SET	not set.
TRUE	true.

Method Summary

Modifier and Type	Method	Description
boolean	matches(Boolean state)	Checks whether the boolean state corresponds to TRUE or FALSE.
TriState	parse(String s)	Parses the given string and returns the associated enum.
Boolean	toBoolean()	Turns the state into a boolean object with not-set corresponding to null.
String	toDisplay()	Returns the display string.
String	toRaw()	Returns the raw enum string.
String	toString()	Returns the display string.
static String	toString(AbstractOption option, Object object)	Returns the enum as string.
static TriState	valueOf(AbstractOption option, String str)	Returns an enum generated from the string.
static TriState	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TriState[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TRUE

public static final TriState TRUE

true.

FALSE

public static final TriState FALSE

false.

NOT_SET

public static final TriState NOT_SET

not set.

Method Detail

values

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

Returns:

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

valueOf

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

toDisplay

public String toDisplay()

Returns the display string.

Specified by:

toDisplay in interface EnumWithCustomDisplay<TriState>

Returns:

the display string

toRaw

public String toRaw()

Returns the raw enum string.

Specified by:

toRaw in interface EnumWithCustomDisplay<TriState>

Returns:

the raw enum string

toString

public String toString()

Returns the display string.

Overrides:

toString in class Enum<TriState>

Returns:

the display string

matches

public boolean matches(Boolean state)

Checks whether the boolean state corresponds to TRUE or FALSE.

Parameters:

state - the state to compare with

Returns:

true if "TRUE && true" or "FALSE && false" or "NOT_SET && null"

toBoolean

public Boolean toBoolean()

Turns the state into a boolean object with not-set corresponding to null.

Returns:

the boolean object

parse

public TriState parse(String s)

Parses the given string and returns the associated enum.

Specified by:

parse in interface EnumWithCustomParsing<TriState>

Parameters:

s - the string to parse

Returns:

the enum or null if not found

toString

public static String toString(AbstractOption option,
                              Object object)

Returns the enum as string.

Parameters:

option - the current option

object - the enum object to convert

Returns:

the generated string

valueOf

public static TriState valueOf(AbstractOption option,
                               String str)

Returns an enum generated from the string.

Parameters:

option - the current option

str - the string to convert to an enum

Returns:

the generated enum or null in case of error