net.morimekta.providence.descriptor

Class PEnumDescriptor<T extends PEnumValue<T>>

java.lang.Object

net.morimekta.providence.descriptor.PDeclaredDescriptor<T>

net.morimekta.providence.descriptor.PEnumDescriptor<T>

All Implemented Interfaces:

PDescriptor<T>

public abstract class PEnumDescriptor<T extends PEnumValue<T>>
extends PDeclaredDescriptor<T>

The definition of a thrift enum.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_FIRST_VALUE

Constructor Summary

Constructors

Constructor and Description
PEnumDescriptor(String comment, String packageName, String name, PEnumBuilderFactory<T> provider)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
PEnumBuilderFactory<T>	factory() Get the builder for the given declared type.
PType	getType()
abstract T	getValueById(int id)
abstract T	getValueByName(String name)
abstract T[]	getValues()
String	toString()

Methods inherited from class net.morimekta.providence.descriptor.PDeclaredDescriptor

getComment, getName, getPackageName, getQualifiedName

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_FIRST_VALUE

public static final int DEFAULT_FIRST_VALUE

See Also:

Constant Field Values

Constructor Detail

PEnumDescriptor

public PEnumDescriptor(String comment,
                       String packageName,
                       String name,
                       PEnumBuilderFactory<T> provider)

Method Detail

getType

public PType getType()

Returns:

Get the field type.

getValues

public abstract T[] getValues()

Returns:

The array of enum instances.

getValueById

public abstract T getValueById(int id)

Parameters:

id - Value to look up enum from.

Returns:

Enum if found, null otherwise.

getValueByName

public abstract T getValueByName(String name)

Parameters:

name - Name to look up enum from.

Returns:

Enum if found, null otherwise.

factory

public PEnumBuilderFactory<T> factory()

Description copied from class: PDeclaredDescriptor

Get the builder for the given declared type.

Specified by:

factory in class PDeclaredDescriptor<T extends PEnumValue<T>>

Returns:

The type specific builder provider.

toString

public String toString()

Overrides:

toString in class PDeclaredDescriptor<T extends PEnumValue<T>>

equals

public boolean equals(Object o)

Overrides:

equals in class Object