net.morimekta.providence.model

Enum Decl._Field

java.lang.Object

java.lang.Enum<Decl._Field>

net.morimekta.providence.model.Decl._Field

All Implemented Interfaces:

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

Enclosing interface:

Decl

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOCUMENTATION
NAME

Method Summary

Modifier and Type	Method and Description
static Decl._Field	fieldForId(int id)
static Decl._Field	fieldForName(String name)
static Decl._Field	fieldForPojoName(String name)
static Decl._Field	findById(int id)
static Decl._Field	findByName(String name)
static Decl._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	onMessageType()
String	toString()
static Decl._Field	valueOf(String name) Returns the enum constant of this type with the specified name.
static Decl._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 Decl._Field DOCUMENTATION

NAME

public static final Decl._Field NAME

Method Detail

values

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

getRequirement

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

Specified by:

getRequirement in interface net.morimekta.providence.descriptor.PField

getDescriptor

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

Specified by:

getDescriptor in interface net.morimekta.providence.descriptor.PField

getArgumentsType

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

Specified by:

getArgumentsType in interface net.morimekta.providence.descriptor.PField

getName

@Nonnull
public String getName()

Specified by:

getName in interface net.morimekta.providence.descriptor.PField

getPojoName

@Nonnull
public String getPojoName()

Specified by:

getPojoName in interface net.morimekta.providence.descriptor.PField

hasDefaultValue

public boolean hasDefaultValue()

Specified by:

hasDefaultValue in interface net.morimekta.providence.descriptor.PField

getDefaultValue

@Nullable
public Object getDefaultValue()

Specified by:

getDefaultValue in interface net.morimekta.providence.descriptor.PField

onMessageType

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

Specified by:

onMessageType in interface net.morimekta.providence.descriptor.PField

toString

public String toString()

Overrides:

toString in class Enum<Decl._Field>

findById

public static Decl._Field findById(int id)

Parameters:

id - Field name

Returns:

The identified field or null

findByName

public static Decl._Field findByName(String name)

Parameters:

name - Field name

Returns:

The named field or null

findByPojoName

public static Decl._Field findByPojoName(String name)

Parameters:

name - Field POJO name

Returns:

The named field or null

fieldForId

public static Decl._Field fieldForId(int id)

Parameters:

id - Field name

Returns:

The identified field

Throws:

IllegalArgumentException - If no such field

fieldForName

public static Decl._Field fieldForName(String name)

Parameters:

name - Field name

Returns:

The named field

Throws:

IllegalArgumentException - If no such field

fieldForPojoName

public static Decl._Field fieldForPojoName(String name)

Parameters:

name - Field POJO name

Returns:

The named field

Throws:

IllegalArgumentException - If no such field