uk.ac.ed.epcc.webapp

Class EnumSetting<E extends java.lang.Enum>

java.lang.Object

uk.ac.ed.epcc.webapp.AbstractSetting<E>

uk.ac.ed.epcc.webapp.EnumSetting<E>

All Implemented Interfaces:

java.lang.Comparable<Setting>, TypeConverter<E,java.lang.String>, Setting<E>, Targetted<E>

Direct Known Subclasses:

EnumPreference

public class EnumSetting<E extends java.lang.Enum>
extends AbstractSetting<E>

A EnumSetting represents optional feature in the code. Normally this should be encapsulated as a singleton constant field so we can locate them by reflection and generate on-line documentation. Each EnumSetting object defines a name for the feature a default setting and descriptive documentation. Some legacy features may be generated dynamically so the same feature may be constructed multiple times but EnumSettings with the same name should be identical.

EnumSettings can be turned on and off using configuration parameters e.g. service.feature.feature-name=true The results are also cached in the AppContext as the same EnumSetting may be queried a large number of times in the same request.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Class<E>	clazz

Constructor Summary

Constructors

Constructor and Description
EnumSetting(java.lang.Class<E> clazz, java.lang.String name, E def, java.lang.String description)

Method Summary

Modifier and Type	Method and Description
E	find(java.lang.String o) Find the required object.
protected E	getConfigValue(AppContext conn)
E	getCurrent(AppContext conn) get the current value of the setting
java.lang.String	getIndex(E value) Get the underlying data representation corresponding to the value
ItemInput<java.lang.String,E>	getInput(AppContext conn) and Input to select the setting
protected java.lang.String	getTag()
java.lang.Class<E>	getTarget() Get the type of the returned object as far as it is known.
java.lang.String	getText(E b)

Methods inherited from class uk.ac.ed.epcc.webapp.AbstractSetting

equals, findFeatureByName, getDefault, getDescription, getFeatureTable, getKnownFeatures, getName, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ed.epcc.webapp.Setting

compareTo

Field Detail

clazz

protected final java.lang.Class<E extends java.lang.Enum> clazz

Constructor Detail

EnumSetting

public EnumSetting(java.lang.Class<E> clazz,
                   java.lang.String name,
                   E def,
                   java.lang.String description)

Method Detail

getCurrent

public E getCurrent(AppContext conn)

Description copied from interface: Setting

get the current value of the setting

Parameters:

conn - AppContext

Returns:

getConfigValue

protected E getConfigValue(AppContext conn)

getTag

protected java.lang.String getTag()

getInput

public ItemInput<java.lang.String,E> getInput(AppContext conn)

Description copied from interface: Setting

and Input to select the setting

Returns:

getText

public java.lang.String getText(E b)

Overrides:

getText in class AbstractSetting<E extends java.lang.Enum>

find

public E find(java.lang.String o)

Description copied from interface: TypeConverter

Find the required object.

Parameters:

o - Value of the database field

Returns:

Target value or null if invalid

getIndex

public java.lang.String getIndex(E value)

Description copied from interface: TypeConverter

Get the underlying data representation corresponding to the value

Returns:

Field value or null if invalid

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.

Returns:

Class object for return type