Module org.refcodes.data

Package org.refcodes.data

Enum BooleanLiterals

java.lang.Object

java.lang.Enum<BooleanLiterals>

org.refcodes.data.BooleanLiterals

All Implemented Interfaces:

Serializable, Comparable<BooleanLiterals>

public enum BooleanLiterals
extends Enum<BooleanLiterals>

Some values's literal (String) representation useful when parsing or evaluating texts.

Enum Constant Summary

Enum Constants

Enum Constant	Description
FALSE	Strings representing a "false" boolean value.
TRUE	Strings representing a "true" boolean value.

Method Summary

Modifier and Type	Method	Description
String[]	getNames()	An array of the names representing the set of folder names.
static boolean	isFalse(String aValue)	Returns true in case the given String equals (ignoring the case) one of the false literals as of FALSE and getNames().
static boolean	isTrue(String aValue)	Returns true in case the given String equals (ignoring the case) one of the true literals as of TRUE and getNames().
static BooleanLiterals	valueOf(String name)	Returns the enum constant of this type with the specified name.
static BooleanLiterals[]	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 BooleanLiterals TRUE

Strings representing a "true" boolean value.

FALSE

public static final BooleanLiterals FALSE

Strings representing a "false" boolean value.

Method Detail

values

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

Returns:

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

valueOf

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

getNames

public String[] getNames()

An array of the names representing the set of folder names.

Returns:

The array of folder names representing this set.

isTrue

public static boolean isTrue(String aValue)

Returns true in case the given String equals (ignoring the case) one of the true literals as of TRUE and getNames().

Parameters:

aValue - The value to be tested whether it represents a true literal.

Returns:

True in case we have a true literal, else false.

isFalse

public static boolean isFalse(String aValue)

Returns true in case the given String equals (ignoring the case) one of the false literals as of FALSE and getNames().

Parameters:

aValue - The value to be tested whether it represents a false literal.

Returns:

True in case we have a false literal, else false.