|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
| 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() |
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. |
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. |
| Method Detail |
public WebADEPreferenceType getPreferenceType()
public java.util.List getPreferenceSubTypes()
public WebADEPreference getPreference(java.lang.String preferenceSubType,
java.lang.String preferenceName)
preferenceSubType - The sub-type containing the preference.preferenceName - The target preference name.
public java.util.List getPreferencesBySubType(java.lang.String preferenceSubType)
preferenceSubType - The sub-type containing the preference.
public java.util.Properties getPreferencePropertiesBySubType(java.lang.String preferenceSubType)
throws WebADEException
preferenceSubType - The sub-type containing the preference.
WebADEException - Thrown if any of the WebADEPreference object with the given
subtype have more than one value assigned.
public java.util.Properties getPreferencePropertiesBySubType(java.lang.String preferenceSubType,
boolean convertMultiValuesToDelimitedString)
throws WebADEException
preferenceSubType - 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.
public java.util.Properties getPreferencePropertiesBySubType(java.lang.String preferenceSubType,
boolean convertMultiValuesToDelimitedString,
java.lang.String delimiterString)
throws WebADEException
preferenceSubType - 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.
public WebADEPreferenceSet getPreferenceSet(java.lang.String preferenceSubType,
java.lang.String preferenceSetName)
preferenceSubType - The sub-type containing the preference set.preferenceSetName - The target preference set name.
public java.util.List getPreferenceSetsBySubType(java.lang.String preferenceSubType)
preferenceSubType - The sub-type containing the preference set.
public WebADEPreferences getWebADEPreferencesBySubType(java.lang.String preferenceSubType)
preferenceSubType - The sub-type containing the preferences.
public void addPreference(java.lang.String preferenceSubType,
WebADEPreference pref)
throws java.lang.NullPointerException
preferenceSubType - The sub-type containing the preference.pref - The target preference to add.
java.lang.NullPointerException - Thrown if the preference sub type parameter was null.
public void removePreference(java.lang.String preferenceSubType,
java.lang.String preferenceName)
preferenceSubType - The sub-type containing the preference.preferenceName - The name of the target preference.
public void addPreferenceSet(java.lang.String preferenceSubType,
WebADEPreferenceSet prefSet)
throws java.lang.NullPointerException
preferenceSubType - 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.
public void removePreferenceSet(java.lang.String preferenceSubType,
java.lang.String preferenceSetName)
preferenceSubType - The sub-type containing the preference set.preferenceSetName - The name of the target preference set.public void clear()
public java.lang.Object clone()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||