net.morimekta.providence.model

Enum FieldType._Field

java.lang.Object

java.lang.Enum<FieldType._Field>

net.morimekta.providence.model.FieldType._Field

All Implemented Interfaces:

Serializable, Comparable<FieldType._Field>, net.morimekta.providence.descriptor.PField<FieldType>

Enclosing class:

FieldType

public static enum FieldType._Field
extends Enum<FieldType._Field>
implements net.morimekta.providence.descriptor.PField<FieldType>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANNOTATIONS
DEFAULT_VALUE
DOCUMENTATION
ID
NAME
REQUIREMENT
TYPE

Method Summary

Modifier and Type	Method and Description
static FieldType._Field	fieldForId(int id)
static FieldType._Field	fieldForName(String name)
static FieldType._Field	fieldForPojoName(String name)
static FieldType._Field	findById(int id)
static FieldType._Field	findByName(String name)
static FieldType._Field	findByPojoName(String name)
net.morimekta.providence.descriptor.PStructDescriptor	getArgumentsType()
Object	getDefaultValue()
net.morimekta.providence.descriptor.PDescriptor	getDescriptor()
int	getId()
String	getName()
String	getPojoName()
net.morimekta.providence.descriptor.PRequirement	getRequirement()
boolean	hasDefaultValue()
net.morimekta.providence.descriptor.PMessageDescriptor<FieldType>	onMessageType()
String	toString()
static FieldType._Field	valueOf(String name) Returns the enum constant of this type with the specified name.
static FieldType._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

asIfString, asString, getType

Enum Constant Detail

DOCUMENTATION

public static final FieldType._Field DOCUMENTATION

ID

public static final FieldType._Field ID

REQUIREMENT

public static final FieldType._Field REQUIREMENT

TYPE

public static final FieldType._Field TYPE

NAME

public static final FieldType._Field NAME

DEFAULT_VALUE

public static final FieldType._Field DEFAULT_VALUE

ANNOTATIONS

public static final FieldType._Field ANNOTATIONS

Method Detail

values

public static FieldType._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 (FieldType._Field c : FieldType._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 FieldType._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 net.morimekta.providence.descriptor.PField<FieldType>

getRequirement

@Nonnull
public net.morimekta.providence.descriptor.PRequirement getRequirement()

Specified by:

getRequirement in interface net.morimekta.providence.descriptor.PField<FieldType>

getDescriptor

@Nonnull
public net.morimekta.providence.descriptor.PDescriptor getDescriptor()

Specified by:

getDescriptor in interface net.morimekta.providence.descriptor.PField<FieldType>

getArgumentsType

@Nullable
public net.morimekta.providence.descriptor.PStructDescriptor getArgumentsType()

Specified by:

getArgumentsType in interface net.morimekta.providence.descriptor.PField<FieldType>

getName

@Nonnull
public String getName()

Specified by:

getName in interface net.morimekta.providence.descriptor.PField<FieldType>

getPojoName

@Nonnull
public String getPojoName()

Specified by:

getPojoName in interface net.morimekta.providence.descriptor.PField<FieldType>

hasDefaultValue

public boolean hasDefaultValue()

Specified by:

hasDefaultValue in interface net.morimekta.providence.descriptor.PField<FieldType>

getDefaultValue

@Nullable
public Object getDefaultValue()

Specified by:

getDefaultValue in interface net.morimekta.providence.descriptor.PField<FieldType>

onMessageType

@Nonnull
public net.morimekta.providence.descriptor.PMessageDescriptor<FieldType> onMessageType()

Specified by:

onMessageType in interface net.morimekta.providence.descriptor.PField<FieldType>

toString

public String toString()

Overrides:

toString in class Enum<FieldType._Field>

findById

public static FieldType._Field findById(int id)

Parameters:

id - Field ID

Returns:

The identified field or null

findByName

public static FieldType._Field findByName(String name)

Parameters:

name - Field name

Returns:

The named field or null

findByPojoName

public static FieldType._Field findByPojoName(String name)

Parameters:

name - Field POJO name

Returns:

The named field or null

fieldForId

public static FieldType._Field fieldForId(int id)

Parameters:

id - Field ID

Returns:

The identified field

Throws:

IllegalArgumentException - If no such field

fieldForName

public static FieldType._Field fieldForName(String name)

Parameters:

name - Field name

Returns:

The named field

Throws:

IllegalArgumentException - If no such field

fieldForPojoName

public static FieldType._Field fieldForPojoName(String name)

Parameters:

name - Field POJO name

Returns:

The named field

Throws:

IllegalArgumentException - If no such field