Package net.morimekta.providence.util

Enum Empty._Field

java.lang.Object

java.lang.Enum<Empty._Field>

net.morimekta.providence.util.Empty._Field

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Empty._Field>, PField

Enclosing class:

Empty

public static enum Empty._Field
extends java.lang.Enum<Empty._Field>
implements PField

Method Summary

Modifier and Type	Method	Description
static Empty._Field	fieldForId(int id)
static Empty._Field	fieldForName(java.lang.String name)
static Empty._Field	findById(int id)
static Empty._Field	findByName(java.lang.String name)
java.lang.Object	getDefaultValue()
PDescriptor	getDescriptor()
int	getId()
java.lang.String	getName()
PRequirement	getRequirement()
boolean	hasDefaultValue()
java.lang.String	toString()
static Empty._Field	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static Empty._Field[]	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

Methods inherited from interface net.morimekta.providence.descriptor.PField

getType

Method Detail

values

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

Returns:

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

valueOf

public static Empty._Field valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getId

public int getId()

Specified by:

getId in interface PField

Returns:

The field numeric ID or key.

getRequirement

public PRequirement getRequirement()

Specified by:

getRequirement in interface PField

Returns:

How the field is required for validity.

getDescriptor

public PDescriptor getDescriptor()

Specified by:

getDescriptor in interface PField

Returns:

The type descriptor for the field data type.

getName

public java.lang.String getName()

Specified by:

getName in interface PField

Returns:

The field name (original).

hasDefaultValue

public boolean hasDefaultValue()

Specified by:

hasDefaultValue in interface PField

Returns:

Whether the field has an explicit default value.

getDefaultValue

public java.lang.Object getDefaultValue()

Specified by:

getDefaultValue in interface PField

Returns:

The default value or null if none. This should return value also where the field has an implicit default value, e.g. numerical types.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Empty._Field>

findById

public static Empty._Field findById(int id)

Parameters:

id - Field name

Returns:

The identified field or null

findByName

public static Empty._Field findByName(java.lang.String name)

Parameters:

name - Field name

Returns:

The named field or null

fieldForId

public static Empty._Field fieldForId(int id)

Parameters:

id - Field name

Returns:

The identified field

Throws:

java.lang.IllegalArgumentException - If no such field

fieldForName

public static Empty._Field fieldForName(java.lang.String name)

Parameters:

name - Field name

Returns:

The named field

Throws:

java.lang.IllegalArgumentException - If no such field