net.morimekta.providence.model

Enum ProgramType._Field

java.lang.Object

java.lang.Enum<ProgramType._Field>

net.morimekta.providence.model.ProgramType._Field

All Implemented Interfaces:

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

Enclosing class:

ProgramType

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
DECL
DOCUMENTATION
INCLUDES
NAMESPACES
PROGRAM_NAME

Method Summary

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

PROGRAM_NAME

public static final ProgramType._Field PROGRAM_NAME

INCLUDES

public static final ProgramType._Field INCLUDES

NAMESPACES

public static final ProgramType._Field NAMESPACES

DECL

public static final ProgramType._Field DECL

Method Detail

values

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

getRequirement

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

Specified by:

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

getDescriptor

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

Specified by:

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

getArgumentsType

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

Specified by:

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

getName

@Nonnull
public String getName()

Specified by:

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

getPojoName

@Nonnull
public String getPojoName()

Specified by:

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

hasDefaultValue

public boolean hasDefaultValue()

Specified by:

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

getDefaultValue

@Nullable
public Object getDefaultValue()

Specified by:

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

onMessageType

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

Specified by:

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

toString

public String toString()

Overrides:

toString in class Enum<ProgramType._Field>

findById

public static ProgramType._Field findById(int id)

Parameters:

id - Field ID

Returns:

The identified field or null

findByName

public static ProgramType._Field findByName(String name)

Parameters:

name - Field name

Returns:

The named field or null

findByPojoName

public static ProgramType._Field findByPojoName(String name)

Parameters:

name - Field POJO name

Returns:

The named field or null

fieldForId

public static ProgramType._Field fieldForId(int id)

Parameters:

id - Field ID

Returns:

The identified field

Throws:

IllegalArgumentException - If no such field

fieldForName

public static ProgramType._Field fieldForName(String name)

Parameters:

name - Field name

Returns:

The named field

Throws:

IllegalArgumentException - If no such field

fieldForPojoName

public static ProgramType._Field fieldForPojoName(String name)

Parameters:

name - Field POJO name

Returns:

The named field

Throws:

IllegalArgumentException - If no such field