uk.ac.ed.epcc.webapp.preferences

Class EnumPreference<E extends java.lang.Enum>

java.lang.Object

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

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

uk.ac.ed.epcc.webapp.preferences.EnumPreference<E>

All Implemented Interfaces:

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

public class EnumPreference<E extends java.lang.Enum>
extends EnumSetting<E>
implements PreferenceSetting<E>

An Enum valued PreferenceSetting

Field Summary

Fields inherited from class uk.ac.ed.epcc.webapp.EnumSetting

clazz

Constructor Summary

Constructors

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

Method Summary

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

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

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

EnumPreference

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

Parameters:

clazz -

name -

def -

description -

Method Detail

getCurrent

public E getCurrent(AppContext conn)

Description copied from interface: Setting

get the current value of the setting

Specified by:

getCurrent in interface Setting<E extends java.lang.Enum>

Overrides:

getCurrent in class EnumSetting<E extends java.lang.Enum>

Parameters:

conn - AppContext

Returns:

canUserSet

public boolean canUserSet(AppContext conn)

setPreference

public void setPreference(AppContext conn,
                          E value)

Specified by:

setPreference in interface PreferenceSetting<E extends java.lang.Enum>

hasPreference

public boolean hasPreference(AppContext conn)

Specified by:

hasPreference in interface PreferenceSetting<E extends java.lang.Enum>

defaultSetting

public E defaultSetting(AppContext conn)

Specified by:

defaultSetting in interface PreferenceSetting<E extends java.lang.Enum>

clearPreference

public void clearPreference(AppContext conn)
                     throws DataFault

Specified by:

clearPreference in interface PreferenceSetting<E extends java.lang.Enum>

Throws:

DataFault