net.morimekta.providence.model

Enum FunctionType._Field

java.lang.Object

java.lang.Enum<FunctionType._Field>

net.morimekta.providence.model.FunctionType._Field

All Implemented Interfaces:

Serializable, Comparable<FunctionType._Field>, PField

Enclosing class:

FunctionType

public static enum FunctionType._Field
extends Enum<FunctionType._Field>
implements PField

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANNOTATIONS
DOCUMENTATION
EXCEPTIONS
NAME
ONE_WAY
PARAMS
RETURN_TYPE

Method Summary

Modifier and Type	Method and Description
static FunctionType._Field	fieldForId(int id)
static FunctionType._Field	fieldForName(String name)
static FunctionType._Field	findById(int id)
static FunctionType._Field	findByName(String name)
Object	getDefaultValue()
PDescriptor	getDescriptor()
int	getId()
String	getName()
PRequirement	getRequirement()
boolean	hasDefaultValue()
String	toString()
static FunctionType._Field	valueOf(String name) Returns the enum constant of this type with the specified name.
static FunctionType._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

asString, getType

Enum Constant Detail

DOCUMENTATION

public static final FunctionType._Field DOCUMENTATION

ONE_WAY

public static final FunctionType._Field ONE_WAY

RETURN_TYPE

public static final FunctionType._Field RETURN_TYPE

NAME

public static final FunctionType._Field NAME

PARAMS

public static final FunctionType._Field PARAMS

EXCEPTIONS

public static final FunctionType._Field EXCEPTIONS

ANNOTATIONS

public static final FunctionType._Field ANNOTATIONS

Method Detail

values

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

getRequirement

public PRequirement getRequirement()

Specified by:

getRequirement in interface PField

getDescriptor

public PDescriptor getDescriptor()

Specified by:

getDescriptor in interface PField

getName

public String getName()

Specified by:

getName in interface PField

hasDefaultValue

public boolean hasDefaultValue()

Specified by:

hasDefaultValue in interface PField

getDefaultValue

public Object getDefaultValue()

Specified by:

getDefaultValue in interface PField

toString

public String toString()

Overrides:

toString in class Enum<FunctionType._Field>

findById

public static FunctionType._Field findById(int id)

Parameters:

id - Field name

Returns:

The identified field or null

findByName

public static FunctionType._Field findByName(String name)

Parameters:

name - Field name

Returns:

The named field or null

fieldForId

public static FunctionType._Field fieldForId(int id)

Parameters:

id - Field name

Returns:

The identified field

Throws:

IllegalArgumentException - If no such field

fieldForName

public static FunctionType._Field fieldForName(String name)

Parameters:

name - Field name

Returns:

The named field

Throws:

IllegalArgumentException - If no such field