org.refcodes.data

Enum Literal

java.lang.Object

java.lang.Enum<Literal>

org.refcodes.data.Literal

All Implemented Interfaces:

Serializable, Comparable<Literal>, org.refcodes.mixin.NameAccessor

public enum Literal
extends Enum<Literal>
implements org.refcodes.mixin.NameAccessor

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

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.NameAccessor

org.refcodes.mixin.NameAccessor.NameBuilder<B extends org.refcodes.mixin.NameAccessor.NameBuilder<B>>, org.refcodes.mixin.NameAccessor.NameMutator, org.refcodes.mixin.NameAccessor.NameProperty

Enum Constant Summary

Enum Constants

Enum Constant and Description
FALSE
LOCALHOST
NO
NULL
OFF
ON
TRUE
YES

Method Summary

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

NULL

public static final Literal NULL

TRUE

public static final Literal TRUE

YES

public static final Literal YES

ON

public static final Literal ON

FALSE

public static final Literal FALSE

NO

public static final Literal NO

OFF

public static final Literal OFF

LOCALHOST

public static final Literal LOCALHOST

Method Detail

values

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

Returns:

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

valueOf

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

getName

public String getName()

Specified by:

getName in interface org.refcodes.mixin.NameAccessor