|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectca.bc.gov.webade.preferences.DefaultWebADEPreferenceSet
| Constructor Summary | |
DefaultWebADEPreferenceSet(java.lang.String preferenceSetName)
Creates a new preference set with the given set name. |
|
| Method Summary | |
void |
addPreference(WebADEPreference pref)
Adds the given preference to the current set, removing the previous one, if found. |
void |
clearPreferences()
Removes all preferences from the current set. |
java.lang.Object |
clone()
see java.lang.Object#clone() |
boolean |
equals(java.lang.Object obj)
|
WebADEPreference |
getPreference(java.lang.String preferenceName)
Returns the corresponding value for the given preference name, or null if not found. |
java.util.List |
getPreferenceNames()
Returns the preference names of the preference set. |
java.util.Properties |
getPreferenceProperties(boolean convertMultiValuesToDelimitedString)
Returns all preferences in the set as name value pairs in a Properties object. |
java.util.Properties |
getPreferenceProperties(boolean convertMultiValuesToDelimitedString,
java.lang.String delimiterString)
Returns all preferences in the set as name value pairs in a Properties object. |
java.util.List |
getPreferences()
Returns the set of preferences. |
java.lang.String |
getPreferenceSetName()
|
java.util.Properties |
getPreferencesProperties()
Returns all preferences in the set as name value pairs in a Properties object. |
int |
hashCode()
|
void |
removePreference(java.lang.String preferenceName)
Removes the given preference from the current set. |
java.lang.String |
toString()
|
| Methods inherited from class java.lang.Object |
getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
public DefaultWebADEPreferenceSet(java.lang.String preferenceSetName)
throws java.lang.NullPointerException
preferenceSetName - The name of the preference set.
java.lang.NullPointerException - Thrown if the preference set name parameter was null.| Method Detail |
public final java.lang.String getPreferenceSetName()
getPreferenceSetName in interface WebADEPreferenceSetWebADEPreferenceSet.getPreferenceSetName()public final java.util.List getPreferences()
WebADEPreferenceSet
getPreferences in interface WebADEPreferenceSetWebADEPreferenceSet.getPreferences()public final java.util.List getPreferenceNames()
WebADEPreferenceSet
getPreferenceNames in interface WebADEPreferenceSetWebADEPreferenceSet.getPreferenceNames()public final WebADEPreference getPreference(java.lang.String preferenceName)
WebADEPreferenceSet
getPreference in interface WebADEPreferenceSetpreferenceName - The unique name of the target preference in the set.
WebADEPreferenceSet.getPreference(java.lang.String)
public final java.util.Properties getPreferencesProperties()
throws WebADEException
WebADEPreferenceSet
getPreferencesProperties in interface WebADEPreferenceSetWebADEException - Thrown if any of the WebADEPreference object within the set have
more than one value assigned.WebADEPreferenceSet.getPreferencesProperties()
public java.util.Properties getPreferenceProperties(boolean convertMultiValuesToDelimitedString)
throws WebADEException
WebADEPreferenceSet
getPreferenceProperties in interface WebADEPreferenceSetconvertMultiValuesToDelimitedString - Flag to convert multi-value preferences to a single
comma-delimited value in the properties file (if set to true),
or whether to throw an exception (if set to false).
WebADEException - Thrown if any of the WebADEPreference object within the set
have more than one value assigned, unless the
convertMultiValuesToDelimitedString is set to
true.WebADEPreferenceSet.getPreferenceProperties(boolean)
public java.util.Properties getPreferenceProperties(boolean convertMultiValuesToDelimitedString,
java.lang.String delimiterString)
throws WebADEException
WebADEPreferenceSet
getPreferenceProperties in interface WebADEPreferenceSetconvertMultiValuesToDelimitedString - Flag to convert multi-value preferences to a single delimited
value in the properties file (if set to true), or whether to
throw an exception (if set to false).delimiterString - The string used to delimit the multi-values string. The
default value is a comma.
WebADEException - Thrown if any of the WebADEPreference object within the set
have more than one value assigned, unless the
convertMultiValuesToDelimitedString is set to
true.WebADEPreferenceSet.getPreferenceProperties(boolean, java.lang.String)public final void addPreference(WebADEPreference pref)
WebADEPreferenceSet
addPreference in interface WebADEPreferenceSetpref - The target preference.WebADEPreferenceSet.addPreference(ca.bc.gov.webade.preferences.WebADEPreference)public final void removePreference(java.lang.String preferenceName)
WebADEPreferenceSet
removePreference in interface WebADEPreferenceSetpreferenceName - The name of the target preference.WebADEPreferenceSet.removePreference(java.lang.String)public final void clearPreferences()
WebADEPreferenceSet
clearPreferences in interface WebADEPreferenceSetWebADEPreferenceSet.clearPreferences()public boolean equals(java.lang.Object obj)
Object.equals(java.lang.Object)public java.lang.String toString()
Object.toString()public int hashCode()
Object.hashCode()public java.lang.Object clone()
clone in interface WebADEPreferenceSet
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||