net.morimekta.providence.util

Enum Any._Field

java.lang.Object

java.lang.Enum<Any._Field>

net.morimekta.providence.util.Any._Field

All Implemented Interfaces:

Serializable, Comparable<Any._Field>, PField

Enclosing class:

Any

public static enum Any._Field
extends Enum<Any._Field>
implements PField

Enum Constant Summary

Enum Constants

Enum Constant and Description
DATA
MEDIA_TYPE
TEXT
TYPE

Method Summary

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

asString, getType

Enum Constant Detail

TYPE

public static final Any._Field TYPE

MEDIA_TYPE

public static final Any._Field MEDIA_TYPE

DATA

public static final Any._Field DATA

TEXT

public static final Any._Field TEXT

Method Detail

values

public static Any._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 (Any._Field c : Any._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 Any._Field 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

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 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 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 String toString()

Overrides:

toString in class Enum<Any._Field>

findById

public static Any._Field findById(int id)

Parameters:

id - Field name

Returns:

The identified field or null

findByName

public static Any._Field findByName(String name)

Parameters:

name - Field name

Returns:

The named field or null

fieldForId

public static Any._Field fieldForId(int id)

Parameters:

id - Field name

Returns:

The identified field

Throws:

IllegalArgumentException - If no such field

fieldForName

public static Any._Field fieldForName(String name)

Parameters:

name - Field name

Returns:

The named field

Throws:

IllegalArgumentException - If no such field