uk.ac.ed.epcc.webapp.model.data.convert

Class EnumProducer<E extends java.lang.Enum<E>>

java.lang.Object

uk.ac.ed.epcc.webapp.model.data.convert.EnumProducer<E>

Type Parameters:

E -

All Implemented Interfaces:

EnumeratingTypeConverter<E,java.lang.String>, TypeConverter<E,java.lang.String>, TypeProducer<E,java.lang.String>, Selector<Input<? extends java.lang.String>>, Targetted<E>

public class EnumProducer<E extends java.lang.Enum<E>>
extends java.lang.Object
implements TypeProducer<E,java.lang.String>, EnumeratingTypeConverter<E,java.lang.String>

A TypeProducer for producing Enum values from a String field

Constructor Summary

Constructors

Constructor and Description
EnumProducer(java.lang.Class<E> clazz, java.lang.String field)

Method Summary

Modifier and Type	Method and Description
E	find(java.lang.String o) Find the required object.
java.lang.String	getField() Name of the Database field we index.
FieldType<java.lang.String>	getFieldType(E def) Create a FieldType to create an appropriate field.
java.lang.String	getIndex(E value) Get the underlying data representation corresponding to the value
Input<java.lang.String>	getInput() get the Input associated with this object.
java.lang.Class<E>	getTarget() Get the type of the returned object as far as it is known.
java.util.Iterator<E>	getValues() Get an iterator over all supported targets.
<X extends java.util.Set<E>> X	getValues(X set) Add all supported targets to a set
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumProducer

public EnumProducer(java.lang.Class<E> clazz,
                    java.lang.String field)

Method Detail

find

public E find(java.lang.String o)

Description copied from interface: TypeConverter

Find the required object.

Specified by:

find in interface TypeConverter<E extends java.lang.Enum<E>,java.lang.String>

Parameters:

o - Value of the database field

Returns:

Target value or null if invalid

getField

public java.lang.String getField()

Description copied from interface: TypeProducer

Name of the Database field we index.

Specified by:

getField in interface TypeProducer<E extends java.lang.Enum<E>,java.lang.String>

Returns:

Field name

getFieldType

public FieldType<java.lang.String> getFieldType(E def)

Description copied from interface: TypeProducer

Create a FieldType to create an appropriate field. The type of the field can be more tightly specified than the types that can be converted.

Specified by:

getFieldType in interface TypeProducer<E extends java.lang.Enum<E>,java.lang.String>

Returns:

FieldType

getIndex

public java.lang.String getIndex(E value)

Description copied from interface: TypeConverter

Get the underlying data representation corresponding to the value

Specified by:

getIndex in interface TypeConverter<E extends java.lang.Enum<E>,java.lang.String>

Returns:

Field value or null if invalid

getValues

public java.util.Iterator<E> getValues()

Description copied from interface: EnumeratingTypeConverter

Get an iterator over all supported targets.

Specified by:

getValues in interface EnumeratingTypeConverter<E extends java.lang.Enum<E>,java.lang.String>

Returns:

Iterator

getValues

public <X extends java.util.Set<E>> X getValues(X set)

Description copied from interface: EnumeratingTypeConverter

Add all supported targets to a set

Specified by:

getValues in interface EnumeratingTypeConverter<E extends java.lang.Enum<E>,java.lang.String>

Parameters:

set - Set to be modified

Returns:

reference to set

getTarget

public java.lang.Class<E> getTarget()

Description copied from interface: Targetted

Get the type of the returned object as far as it is known. Normally this should be the erasure type corresponding to T.

Specified by:

getTarget in interface Targetted<E extends java.lang.Enum<E>>

Returns:

Class object for return type

getInput

public Input<java.lang.String> getInput()

Description copied from interface: Selector

get the Input associated with this object.

Specified by:

getInput in interface Selector<Input<? extends java.lang.String>>

Returns:

Input

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object