org.rhq.enterprise.server.auth.prefs
Class SubjectPreferencesBase

java.lang.Object
  org.rhq.enterprise.server.auth.prefs.SubjectPreferencesBase

Direct Known Subclasses:

MeasurementPreferences, SubjectPreferences

public abstract class SubjectPreferencesBase
extends java.lang.Object

Field Summary

protected org.apache.commons.logging.Log	log
protected static java.lang.String	PREF_ITEM_DELIM
protected static java.lang.String	PREF_LIST_DELIM delimiter for preferences that are multi-valued and stringified

Constructor Summary

SubjectPreferencesBase(Subject subject)

Method Summary

protected boolean	getBooleanPref(java.lang.String key) Get the value of a preference as a boolean.
protected boolean	getBooleanPref(java.lang.String key, boolean ifNull) Get the value of a preference as a boolean.
protected int	getIntPref(java.lang.String key) Get the value of a preference as an int.
protected int	getIntPref(java.lang.String key, int ifNull) Get the value of a preference as an int.
protected java.lang.Long	getLongPref(java.lang.String key) Get the value of a preference as an long.
protected java.lang.String	getPreference(java.lang.String key)
<T> T	getPreference(java.lang.String key, T defaultValue)
protected java.util.List<java.lang.Integer>	getPreferenceAsIntegerList(java.lang.String key, java.lang.String delimiter)
java.util.List<java.lang.String>	getPreferenceAsList(java.lang.String key) Break the named preference into tokens delimited by PREF_LIST_DELIM.
java.util.List<java.lang.String>	getPreferenceAsList(java.lang.String key, java.lang.String delimiter) Tokenize the named preference into a List of Strings.
protected void	setPreference(java.lang.String key, java.util.List<?> values)
protected void	setPreference(java.lang.String key, java.util.List<?> values, java.lang.String delim)
void	setPreference(java.lang.String key, java.lang.Object value)
protected void	unsetPreference(java.lang.String key)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.apache.commons.logging.Log log

PREF_LIST_DELIM

protected static final java.lang.String PREF_LIST_DELIM

delimiter for preferences that are multi-valued and stringified

See Also:

Constant Field Values

PREF_ITEM_DELIM

protected static final java.lang.String PREF_ITEM_DELIM

See Also:

Constant Field Values

Constructor Detail

SubjectPreferencesBase

public SubjectPreferencesBase(Subject subject)

Method Detail

getBooleanPref

protected boolean getBooleanPref(java.lang.String key)

Get the value of a preference as a boolean.

Parameters:

key - the preference to get

ifNull - if the pref is undefined, return this value instead

Returns:

the boolean value of 'key', or if key is null, returns the 'ifNull' value.

getBooleanPref

protected boolean getBooleanPref(java.lang.String key,
                                 boolean ifNull)

Get the value of a preference as a boolean.

Parameters:

key - the preference to get

ifNull - if the pref is undefined, return this value instead

Returns:

the boolean value of 'key', or if key is null, returns the 'ifNull' value.

getIntPref

protected int getIntPref(java.lang.String key)

Get the value of a preference as an int.

Parameters:

key - the preference to get

Returns:

the int value of 'key'

getIntPref

protected int getIntPref(java.lang.String key,
                         int ifNull)

Get the value of a preference as an int.

Parameters:

key - the preference to get

ifNull - if the pref is null, return this value instead

Returns:

the int value of 'key', or if key is null, returns the 'ifNull' value.

getLongPref

protected java.lang.Long getLongPref(java.lang.String key)

Get the value of a preference as an long.

Parameters:

key - the preference to get

Returns:

the long value of 'key'

getPreference

protected java.lang.String getPreference(java.lang.String key)
                                  throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

getPreference

public <T> T getPreference(java.lang.String key,
                           T defaultValue)

getPreferenceAsList

public java.util.List<java.lang.String> getPreferenceAsList(java.lang.String key)

Break the named preference into tokens delimited by PREF_LIST_DELIM.

Parameters:

key - the name of the preference

Returns:

List of String tokens

getPreferenceAsList

public java.util.List<java.lang.String> getPreferenceAsList(java.lang.String key,
                                                            java.lang.String delimiter)

Tokenize the named preference into a List of Strings. If no such preference exists, or the preference is null, an empty List will be returned.

Parameters:

delimiter - the delimiter to break it up by

key - the name of the preference

Returns:

List of String tokens

getPreferenceAsIntegerList

protected java.util.List<java.lang.Integer> getPreferenceAsIntegerList(java.lang.String key,
                                                                       java.lang.String delimiter)

setPreference

protected void setPreference(java.lang.String key,
                             java.util.List<?> values)
                      throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

setPreference

protected void setPreference(java.lang.String key,
                             java.util.List<?> values,
                             java.lang.String delim)
                      throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

setPreference

public void setPreference(java.lang.String key,
                          java.lang.Object value)
                   throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

unsetPreference

protected void unsetPreference(java.lang.String key)