Package net.morimekta.providence.model
Enum ProgramType._Field
- java.lang.Object
-
- java.lang.Enum<ProgramType._Field>
-
- net.morimekta.providence.model.ProgramType._Field
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<ProgramType._Field>
,PField<ProgramType>
- Enclosing class:
- ProgramType
public static enum ProgramType._Field extends java.lang.Enum<ProgramType._Field> implements PField<ProgramType>
-
-
Enum Constant Summary
Enum Constants Enum Constant Description DECL
DOCUMENTATION
INCLUDES
NAMESPACES
PROGRAM_NAME
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ProgramType._Field
fieldForId(int id)
static ProgramType._Field
fieldForName(java.lang.String name)
static ProgramType._Field
fieldForPojoName(java.lang.String name)
static ProgramType._Field
findById(int id)
static ProgramType._Field
findByName(java.lang.String name)
static ProgramType._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<ProgramType>
onMessageType()
The message type the field is on.java.lang.String
toString()
static ProgramType._Field
valueOf(java.lang.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.
-
-
-
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(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 namejava.lang.NullPointerException
- if the argument is null
-
getId
public int getId()
- Specified by:
getId
in interfacePField<ProgramType>
- Returns:
- The field numeric ID or key.
-
getRequirement
@Nonnull public PRequirement getRequirement()
- Specified by:
getRequirement
in interfacePField<ProgramType>
- Returns:
- How the field is required for validity.
-
getDescriptor
@Nonnull public PDescriptor getDescriptor()
- Specified by:
getDescriptor
in interfacePField<ProgramType>
- 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 interfacePField<ProgramType>
- Returns:
- The params type, or null if not parameterizable.
-
getName
@Nonnull public java.lang.String getName()
- Specified by:
getName
in interfacePField<ProgramType>
- Returns:
- The field name (original).
-
getPojoName
@Nonnull public java.lang.String getPojoName()
- Specified by:
getPojoName
in interfacePField<ProgramType>
- Returns:
- The field's pojo name.
-
hasDefaultValue
public boolean hasDefaultValue()
- Specified by:
hasDefaultValue
in interfacePField<ProgramType>
- Returns:
- Whether the field has an explicit default value.
-
getDefaultValue
@Nullable public java.lang.Object getDefaultValue()
- Specified by:
getDefaultValue
in interfacePField<ProgramType>
- 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<ProgramType> onMessageType()
Description copied from interface:PField
The message type the field is on.- Specified by:
onMessageType
in interfacePField<ProgramType>
- Returns:
- The fields message type.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.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(java.lang.String name)
- Parameters:
name
- Field name- Returns:
- The named field or null
-
findByPojoName
public static ProgramType._Field findByPojoName(java.lang.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:
java.lang.IllegalArgumentException
- If no such field
-
fieldForName
public static ProgramType._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 ProgramType._Field fieldForPojoName(java.lang.String name)
- Parameters:
name
- Field POJO name- Returns:
- The named field
- Throws:
java.lang.IllegalArgumentException
- If no such field
-
-