|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectca.bc.gov.webade.preferences.DefaultWebADEPreferences
Contains the set of WebADEPreference objects and the set of WebADEPreferenceSet objects for a particular target(Global, Application, Extension, WebADE, User).
| Constructor Summary | |
DefaultWebADEPreferences(WebADEPreferenceType preferenceTypeCode)
Constructor with the preference type code for this set of preferences. |
|
| Method Summary | |
void |
addPreference(java.lang.String preferenceSubType,
WebADEPreference pref)
Adds the given WebADEPreference object to the list of preferences. |
void |
addPreferenceSet(java.lang.String preferenceSubType,
WebADEPreferenceSet prefSet)
Adds the given WebADEPreference object to the target set of preferences identified by the set name. |
void |
clear()
Removes all preferences and preferences sets from this instance. |
java.lang.Object |
clone()
see java.lang.Object#clone() |
boolean |
equals(java.lang.Object obj)
|
WebADEPreference |
getPreference(java.lang.String preferenceSubType,
java.lang.String preferenceName)
Returns the target preference, identified by sub-type and name. |
java.util.Properties |
getPreferencePropertiesBySubType(java.lang.String preferenceSubType)
Returns the preferences that match the given subtype as name value pairs in a Properties object. |
java.util.Properties |
getPreferencePropertiesBySubType(java.lang.String preferenceSubType,
boolean convertMultiValuesToDelimitedString)
Returns the preferences that match the given subtype as name value pairs in a Properties object. |
java.util.Properties |
getPreferencePropertiesBySubType(java.lang.String preferenceSubType,
boolean convertMultiValuesToDelimitedString,
java.lang.String delimiterString)
Returns the preferences that match the given subtype as name value pairs in a Properties object. |
java.util.List |
getPreferencesBySubType(java.lang.String preferenceSubType)
Returns the preferences that match the given subtype. |
WebADEPreferenceSet |
getPreferenceSet(java.lang.String preferenceSubType,
java.lang.String preferenceSetName)
Returns the target preference set. |
java.util.List |
getPreferenceSetsBySubType(java.lang.String preferenceSubType)
Returns the preference sets that match the given subtype. |
java.util.List |
getPreferenceSubTypes()
Returns all subtypes in the . |
WebADEPreferenceType |
getPreferenceType()
|
WebADEPreferences |
getWebADEPreferencesBySubType(java.lang.String preferenceSubType)
Returns the WebADEPreference and WebADEPreferenceSet objects that match the given subtype. |
int |
hashCode()
|
void |
removePreference(java.lang.String preferenceSubType,
java.lang.String preferenceName)
Removes the given preference from the list of preferences. |
void |
removePreferenceSet(java.lang.String preferenceSubType,
java.lang.String preferenceSetName)
Removes the given preference set from the list of preference sets. |
java.lang.String |
toString()
|
| Methods inherited from class java.lang.Object |
getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
public DefaultWebADEPreferences(WebADEPreferenceType preferenceTypeCode)
throws java.lang.NullPointerException
preferenceTypeCode - The preference type code for all preferences in this set.
java.lang.NullPointerException - Thrown if the preference type code parameter was null.| Method Detail |
public final WebADEPreferenceType getPreferenceType()
getPreferenceType in interface WebADEPreferencesWebADEPreferences.getPreferenceType()public final java.util.List getPreferenceSubTypes()
WebADEPreferences
getPreferenceSubTypes in interface WebADEPreferencesWebADEPreferences.getPreferenceSubTypes()
public final WebADEPreference getPreference(java.lang.String preferenceSubType,
java.lang.String preferenceName)
WebADEPreferences
getPreference in interface WebADEPreferencespreferenceSubType - The sub-type containing the preference.preferenceName - The target preference name.
WebADEPreferences.getPreference(java.lang.String, java.lang.String)public final java.util.List getPreferencesBySubType(java.lang.String preferenceSubType)
WebADEPreferences
getPreferencesBySubType in interface WebADEPreferencespreferenceSubType - The sub-type containing the preference.
WebADEPreferences.getPreferencesBySubType(java.lang.String)
public final java.util.Properties getPreferencePropertiesBySubType(java.lang.String preferenceSubType)
throws WebADEException
WebADEPreferences
getPreferencePropertiesBySubType in interface WebADEPreferencespreferenceSubType - The sub-type containing the preference.
WebADEException - Thrown if any of the WebADEPreference object with the given
subtype have more than one value assigned.WebADEPreferences.getPreferencePropertiesBySubType(java.lang.String)
public final java.util.Properties getPreferencePropertiesBySubType(java.lang.String preferenceSubType,
boolean convertMultiValuesToDelimitedString)
throws WebADEException
WebADEPreferences
getPreferencePropertiesBySubType in interface WebADEPreferencespreferenceSubType - The sub-type containing the preference.convertMultiValuesToDelimitedString - 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 with the given
subtype have more than one value assigned.WebADEPreferences.getPreferencePropertiesBySubType(java.lang.String, boolean)
public final java.util.Properties getPreferencePropertiesBySubType(java.lang.String preferenceSubType,
boolean convertMultiValuesToDelimitedString,
java.lang.String delimiterString)
throws WebADEException
WebADEPreferences
getPreferencePropertiesBySubType in interface WebADEPreferencespreferenceSubType - The sub-type containing the preference.convertMultiValuesToDelimitedString - 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 with the given
subtype have more than one value assigned.WebADEPreferences.getPreferencePropertiesBySubType(java.lang.String, boolean, java.lang.String)
public final WebADEPreferenceSet getPreferenceSet(java.lang.String preferenceSubType,
java.lang.String preferenceSetName)
WebADEPreferences
getPreferenceSet in interface WebADEPreferencespreferenceSubType - The sub-type containing the preference set.preferenceSetName - The target preference set name.
WebADEPreferences.getPreferenceSet(java.lang.String, java.lang.String)public final java.util.List getPreferenceSetsBySubType(java.lang.String preferenceSubType)
WebADEPreferences
getPreferenceSetsBySubType in interface WebADEPreferencespreferenceSubType - The sub-type containing the preference set.
WebADEPreferences.getPreferenceSetsBySubType(java.lang.String)public WebADEPreferences getWebADEPreferencesBySubType(java.lang.String preferenceSubType)
WebADEPreferences
getWebADEPreferencesBySubType in interface WebADEPreferencespreferenceSubType - The sub-type containing the preferences.
WebADEPreferences.getWebADEPreferencesBySubType(java.lang.String)
public final void addPreference(java.lang.String preferenceSubType,
WebADEPreference pref)
throws java.lang.NullPointerException
WebADEPreferences
addPreference in interface WebADEPreferencespreferenceSubType - The sub-type containing the preference.pref - The target preference to add.
java.lang.NullPointerException - Thrown if the preference sub type parameter was null.WebADEPreferences.addPreference(java.lang.String, ca.bc.gov.webade.preferences.WebADEPreference)
public final void removePreference(java.lang.String preferenceSubType,
java.lang.String preferenceName)
WebADEPreferences
removePreference in interface WebADEPreferencespreferenceSubType - The sub-type containing the preference.preferenceName - The name of the target preference.WebADEPreferences.removePreference(java.lang.String, java.lang.String)
public final void addPreferenceSet(java.lang.String preferenceSubType,
WebADEPreferenceSet prefSet)
throws java.lang.NullPointerException
WebADEPreferences
addPreferenceSet in interface WebADEPreferencespreferenceSubType - The sub-type containing the preference.prefSet - The target preference set to add.
java.lang.NullPointerException - Thrown if the preference sub type parameter was null.WebADEPreferences.addPreferenceSet(java.lang.String, ca.bc.gov.webade.preferences.WebADEPreferenceSet)
public final void removePreferenceSet(java.lang.String preferenceSubType,
java.lang.String preferenceSetName)
WebADEPreferences
removePreferenceSet in interface WebADEPreferencespreferenceSubType - The sub-type containing the preference set.preferenceSetName - The name of the target preference set.WebADEPreferences.removePreferenceSet(java.lang.String, java.lang.String)public final void clear()
WebADEPreferences
clear in interface WebADEPreferencesWebADEPreferences.clear()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 WebADEPreferences
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||