Package net.morimekta.providence.model

Enum ProgramMeta._Field

java.lang.Object

java.lang.Enum<ProgramMeta._Field>

net.morimekta.providence.model.ProgramMeta._Field

All Implemented Interfaces:

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

Enclosing class:

ProgramMeta

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

Enum Constant Summary

Enum Constants

Enum Constant	Description
FILE_LINES
FILE_PATH
INCLUDES
PROGRAM

Method Summary

Modifier and Type	Method	Description
static ProgramMeta._Field	fieldForId(int id)
static ProgramMeta._Field	fieldForName(java.lang.String name)
static ProgramMeta._Field	fieldForPojoName(java.lang.String name)
static ProgramMeta._Field	findById(int id)
static ProgramMeta._Field	findByName(java.lang.String name)
static ProgramMeta._Field	findByPojoName(java.lang.String name)
PStructDescriptor	getArgumentsType()	If present, is the params type to be used for parameterizable field content, e.g. with GraphQL.
java.lang.Object	getDefaultValue()
PDescriptor	getDescriptor()
int	getId()
java.lang.String	getName()
java.lang.String	getPojoName()
PRequirement	getRequirement()
boolean	hasDefaultValue()
PMessageDescriptor<ProgramMeta>	onMessageType()	The message type the field is on.
java.lang.String	toString()
static ProgramMeta._Field	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static ProgramMeta._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

Enum Constant Detail

FILE_PATH

public static final ProgramMeta._Field FILE_PATH

FILE_LINES

public static final ProgramMeta._Field FILE_LINES

PROGRAM

public static final ProgramMeta._Field PROGRAM

INCLUDES

public static final ProgramMeta._Field INCLUDES

Method Detail

values

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

Returns:

The field numeric ID or key.

getRequirement

@Nonnull
public PRequirement getRequirement()

Specified by:

getRequirement in interface PField<ProgramMeta>

Returns:

How the field is required for validity.

getDescriptor

@Nonnull
public PDescriptor getDescriptor()

Specified by:

getDescriptor in interface PField<ProgramMeta>

Returns:

The type descriptor for the field data type.

getArgumentsType

@Nullable
public PStructDescriptor getArgumentsType()

Description copied from interface: PField

If present, is the params type to be used for parameterizable field content, e.g. with GraphQL.

Specified by:

getArgumentsType in interface PField<ProgramMeta>

Returns:

The params type, or null if not parameterizable.

getName

@Nonnull
public java.lang.String getName()

Specified by:

getName in interface PField<ProgramMeta>

Returns:

The field name (original).

getPojoName

@Nonnull
public java.lang.String getPojoName()

Specified by:

getPojoName in interface PField<ProgramMeta>

Returns:

The field's pojo name.

hasDefaultValue

public boolean hasDefaultValue()

Specified by:

hasDefaultValue in interface PField<ProgramMeta>

Returns:

Whether the field has an explicit default value.

getDefaultValue

@Nullable
public java.lang.Object getDefaultValue()

Specified by:

getDefaultValue in interface PField<ProgramMeta>

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.

onMessageType

@Nonnull
public PMessageDescriptor<ProgramMeta> onMessageType()

Description copied from interface: PField

The message type the field is on.

Specified by:

onMessageType in interface PField<ProgramMeta>

Returns:

The fields message type.

toString

public java.lang.String toString()

Overrides:

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

findById

public static ProgramMeta._Field findById(int id)

Parameters:

id - Field ID

Returns:

The identified field or null

findByName

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

Parameters:

name - Field name

Returns:

The named field or null

findByPojoName

public static ProgramMeta._Field findByPojoName(java.lang.String name)

Parameters:

name - Field POJO name

Returns:

The named field or null

fieldForId

public static ProgramMeta._Field fieldForId(int id)

Parameters:

id - Field ID

Returns:

The identified field

Throws:

java.lang.IllegalArgumentException - If no such field

fieldForName

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

Parameters:

name - Field name

Returns:

The named field

Throws:

java.lang.IllegalArgumentException - If no such field

fieldForPojoName

public static ProgramMeta._Field fieldForPojoName(java.lang.String name)

Parameters:

name - Field POJO name

Returns:

The named field

Throws:

java.lang.IllegalArgumentException - If no such field