PApplicationException._Field (Providence Core 2.6.1 API)

java.lang.Object
- java.lang.Enum<PApplicationException._Field>
- - net.morimekta.providence.PApplicationException._Field

All Implemented Interfaces:

Serializable, Comparable<PApplicationException._Field>, PField<PApplicationException>

Enclosing class:

PApplicationException
```
public static enum PApplicationException._Field
extends Enum<PApplicationException._Field>
implements PField<PApplicationException>
```

Enum Constant Summary

Enum Constants
Enum Constant and Description

MESSAGE

TYPE

Enum Constants
Enum Constant and Description
`MESSAGE`
`TYPE`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PApplicationException._Field`	`fieldForId(int id)`
`static PApplicationException._Field`	`fieldForName(String name)`
`static PApplicationException._Field`	`fieldForPojoName(String name)`
`static PApplicationException._Field`	`findById(int id)`
`static PApplicationException._Field`	`findByName(String name)`
`static PApplicationException._Field`	`findByPojoName(String name)`
`PStructDescriptor`	`getArgumentsType()` If present, is the params type to be used for parameterizable field content, e.g. with GraphQL.
`Object`	`getDefaultValue()`
`PDescriptor`	`getDescriptor()`
`int`	`getId()`
`String`	`getName()`
`String`	`getPojoName()`
`PRequirement`	`getRequirement()`
`boolean`	`hasDefaultValue()`
`PMessageDescriptor<PApplicationException>`	`onMessageType()` The message type the field is on.
`String`	`toString()`
`static PApplicationException._Field`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static PApplicationException._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
  - MESSAGE
```
public static final PApplicationException._Field MESSAGE
```
  - TYPE
```
public static final PApplicationException._Field TYPE
```
- Method Detail
  - values
```
public static PApplicationException._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 (PApplicationException._Field c : PApplicationException._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 PApplicationException._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 PField<PApplicationException>
    
    Returns:
    
    The field numeric ID or key.
  - getRequirement
```
@Nonnull
public PRequirement getRequirement()
```
    Specified by:
    
    getRequirement in interface PField<PApplicationException>
    
    Returns:
    
    How the field is required for validity.
  - getDescriptor
```
@Nonnull
public PDescriptor getDescriptor()
```
    Specified by:
    
    getDescriptor in interface PField<PApplicationException>
    
    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<PApplicationException>
    
    Returns:
    
    The params type, or null if not parameterizable.
  - getName
```
@Nonnull
public String getName()
```
    Specified by:
    
    getName in interface PField<PApplicationException>
    
    Returns:
    
    The field name (original).
  - getPojoName
```
@Nonnull
public String getPojoName()
```
    Specified by:
    
    getPojoName in interface PField<PApplicationException>
    
    Returns:
    
    The field's pojo name.
  - hasDefaultValue
```
public boolean hasDefaultValue()
```
    Specified by:
    
    hasDefaultValue in interface PField<PApplicationException>
    
    Returns:
    
    Whether the field has an explicit default value.
  - getDefaultValue
```
@Nullable
public Object getDefaultValue()
```
    Specified by:
    
    getDefaultValue in interface PField<PApplicationException>
    
    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<PApplicationException> onMessageType()
```
    Description copied from interface: PField
    
    The message type the field is on.
    
    Specified by:
    
    onMessageType in interface PField<PApplicationException>
    
    Returns:
    
    The fields message type.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<PApplicationException._Field>
  - findById
```
public static PApplicationException._Field findById(int id)
```
    Parameters:
    
    id - Field ID
    
    Returns:
    
    The identified field or null
  - findByName
```
public static PApplicationException._Field findByName(String name)
```
    Parameters:
    
    name - Field name
    
    Returns:
    
    The named field or null
  - findByPojoName
```
public static PApplicationException._Field findByPojoName(String name)
```
    Parameters:
    
    name - Field POJO name
    
    Returns:
    
    The named field or null
  - fieldForId
```
public static PApplicationException._Field fieldForId(int id)
```
    Parameters:
    
    id - Field ID
    
    Returns:
    
    The identified field
    
    Throws:
    
    IllegalArgumentException - If no such field
  - fieldForName
```
public static PApplicationException._Field fieldForName(String name)
```
    Parameters:
    
    name - Field name
    
    Returns:
    
    The named field
    
    Throws:
    
    IllegalArgumentException - If no such field
  - fieldForPojoName
```
public static PApplicationException._Field fieldForPojoName(String name)
```
    Parameters:
    
    name - Field POJO name
    
    Returns:
    
    The named field
    
    Throws:
    
    IllegalArgumentException - If no such field

Enum PApplicationException._Field

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface net.morimekta.providence.descriptor.PField

Enum Constant Detail

MESSAGE

TYPE

Method Detail

values

valueOf

getId

getRequirement

getDescriptor

getArgumentsType

getName

getPojoName

hasDefaultValue

getDefaultValue

onMessageType

toString

findById

findByName

findByPojoName

fieldForId

fieldForName

fieldForPojoName