net.morimekta.providence.model

Enum FieldRequirement

java.lang.Object

java.lang.Enum<FieldRequirement>

net.morimekta.providence.model.FieldRequirement

All Implemented Interfaces:

Serializable, Comparable<FieldRequirement>, PEnumValue<FieldRequirement>, PValue<FieldRequirement>, net.morimekta.util.Numeric, net.morimekta.util.Stringable

@Generated(value="providence-maven-plugin")
public enum FieldRequirement
extends Enum<FieldRequirement>
implements PEnumValue<FieldRequirement>

The requirement of the field.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FieldRequirement._Builder

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT
OPTIONAL
REQUIRED

Field Summary

Fields

Modifier and Type	Field and Description
static PEnumDescriptor<FieldRequirement>	kDescriptor

Method Summary

Modifier and Type	Method and Description
int	asInteger()
String	asString()
PEnumDescriptor<FieldRequirement>	descriptor()
static FieldRequirement	findById(int id) Find a value based in its ID
static FieldRequirement	findById(Integer id) Find a value based in its ID
static FieldRequirement	findByName(String name) Find a value based in its name
static PEnumDescriptorProvider<FieldRequirement>	provider()
static FieldRequirement	valueForId(int id) Get a value based in its ID
static FieldRequirement	valueForName(String name) Get a value based in its name
static FieldRequirement	valueOf(String name) Returns the enum constant of this type with the specified name.
static FieldRequirement[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.morimekta.providence.PEnumValue

getId, getName, getValue

Methods inherited from interface java.lang.Comparable

compareTo

Enum Constant Detail

DEFAULT

public static final FieldRequirement DEFAULT

OPTIONAL

public static final FieldRequirement OPTIONAL

REQUIRED

public static final FieldRequirement REQUIRED

Field Detail

kDescriptor

public static final PEnumDescriptor<FieldRequirement> kDescriptor

Method Detail

values

public static FieldRequirement[] 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 (FieldRequirement c : FieldRequirement.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FieldRequirement 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

asInteger

public int asInteger()

Specified by:

asInteger in interface net.morimekta.util.Numeric

asString

@Nonnull
public String asString()

Specified by:

asString in interface net.morimekta.util.Stringable

findById

public static FieldRequirement findById(int id)

Find a value based in its ID

Parameters:

id - Id of value

Returns:

Value found or null

findById

public static FieldRequirement findById(Integer id)

Find a value based in its ID

Parameters:

id - Id of value

Returns:

Value found or null

findByName

public static FieldRequirement findByName(String name)

Find a value based in its name

Parameters:

name - Name of value

Returns:

Value found or null

valueForId

@Nonnull
public static FieldRequirement valueForId(int id)

Get a value based in its ID

Parameters:

id - Id of value

Returns:

Value found

Throws:

IllegalArgumentException - If no value for id is found

valueForName

@Nonnull
public static FieldRequirement valueForName(String name)

Get a value based in its name

Parameters:

name - Name of value

Returns:

Value found

Throws:

IllegalArgumentException - If no value for name is found, or null name

descriptor

public PEnumDescriptor<FieldRequirement> descriptor()

Specified by:

descriptor in interface PEnumValue<FieldRequirement>

Specified by:

descriptor in interface PValue<FieldRequirement>

provider

public static PEnumDescriptorProvider<FieldRequirement> provider()