uk.ac.ed.epcc.webapp

Class StringSetting

java.lang.Object

uk.ac.ed.epcc.webapp.AbstractSetting<java.lang.String>

uk.ac.ed.epcc.webapp.StringSetting

All Implemented Interfaces:

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

Direct Known Subclasses:

StringPreference

public class StringSetting
extends AbstractSetting<java.lang.String>

A StringSetting 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 StringSetting 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 StringSettings with the same name should be identical.

StringSettings 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 StringSetting may be queried a large number of times in the same request.

Constructor Summary

Constructors

Constructor and Description
StringSetting(java.lang.String name, java.lang.String description, java.lang.String... options)

Method Summary

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

Constructor Detail

StringSetting

public StringSetting(java.lang.String name,
                     java.lang.String description,
                     java.lang.String... options)

Method Detail

getCurrent

public java.lang.String getCurrent(AppContext conn)

Description copied from interface: Setting

get the current value of the setting

Parameters:

conn - AppContext

Returns:

getConfigValue

protected java.lang.String getConfigValue(AppContext conn)

getTag

protected java.lang.String getTag()

getInput

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

Description copied from interface: Setting

and Input to select the setting

Returns:

getText

public java.lang.String getText(java.lang.String b)

Overrides:

getText in class AbstractSetting<java.lang.String>

find

public java.lang.String 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(java.lang.String 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<java.lang.String> 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