uk.ac.ed.epcc.webapp.preferences

Class StringPreference

java.lang.Object

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

uk.ac.ed.epcc.webapp.StringSetting

uk.ac.ed.epcc.webapp.preferences.StringPreference

All Implemented Interfaces:

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

public class StringPreference
extends StringSetting
implements PreferenceSetting<java.lang.String>

An String valued PreferenceSetting

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	canUserSet(AppContext conn)
void	clearPreference(AppContext conn)
java.lang.String	defaultSetting(AppContext conn)
java.lang.String	getCurrent(AppContext conn) get the current value of the setting
boolean	hasPreference(AppContext conn)
void	setPreference(AppContext conn, java.lang.String value)

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

find, getConfigValue, getIndex, getInput, getTag, getTarget, getText

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.preferences.PreferenceSetting

canView

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

compareTo, getDefault, getDescription, getInput, getName

Methods inherited from interface uk.ac.ed.epcc.webapp.model.data.convert.TypeConverter

find, getIndex

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

getTarget

Constructor Detail

StringPreference

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

Parameters:

clazz -

name -

def -

description -

Method Detail

getCurrent

public java.lang.String getCurrent(AppContext conn)

Description copied from interface: Setting

get the current value of the setting

Specified by:

getCurrent in interface Setting<java.lang.String>

Overrides:

getCurrent in class StringSetting

Parameters:

conn - AppContext

Returns:

canUserSet

public boolean canUserSet(AppContext conn)

setPreference

public void setPreference(AppContext conn,
                          java.lang.String value)

Specified by:

setPreference in interface PreferenceSetting<java.lang.String>

hasPreference

public boolean hasPreference(AppContext conn)

Specified by:

hasPreference in interface PreferenceSetting<java.lang.String>

defaultSetting

public java.lang.String defaultSetting(AppContext conn)

Specified by:

defaultSetting in interface PreferenceSetting<java.lang.String>

clearPreference

public void clearPreference(AppContext conn)
                     throws DataFault

Specified by:

clearPreference in interface PreferenceSetting<java.lang.String>

Throws:

DataFault