|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PreferencesGroup
Represents a group of preferences.
Each group has its own set of named preferences. You can create child groups that are named, or 'anonymous' numbered child groups (0, 1, ...) in an array that can be rearranged. When you use anonymous groups, you can request preferences in a hierarchical manner.
Field Summary | |
---|---|
static int |
ANON_LAST
Constant referring to last entry in index |
Method Summary | |
---|---|
PreferencesGroup |
addAnon()
Creates a new anonymous child group. |
int |
addAnon(PreferencesGroup pg,
int position)
Adds a group from somewhere else into this anonymous array. |
void |
clearAnon()
Removes all anon children at once (to save you calling remove() on each one) |
boolean |
exists(java.lang.String name)
Check whether a program preference has been set. |
PreferencesGroup |
findAnonGroup(java.lang.String pref,
java.lang.String value,
boolean recursive)
Looks for a preferences group in all anonymous children (and their anonymous children, optionally) that contains the given preference. |
PreferencesGroup |
findAnonGroup(java.lang.String pref,
java.lang.String value,
boolean recursive,
boolean ignoreCase)
Looks for a preferences group in all anonymous children (and their anonymous children, optionally) that contains the given preference. |
java.lang.String |
get(java.lang.String name)
Return value of a named preference within group. |
java.lang.String |
get(java.lang.String name,
java.lang.String defaultValue)
Return value of a named preference within group. |
PreferencesGroup[] |
getAnon()
|
java.lang.String |
getAnonHierarchical(java.lang.String name)
Return value of a named preference within group or parent anonymous groups, up to the first non-anonymous ancestor. |
java.lang.String |
getAnonHierarchical(java.lang.String name,
java.lang.String defaultValue)
Return value of a named preference within group or parent anonymous groups. |
java.lang.String |
getAnonHierarchical(java.lang.String name,
java.lang.String defaultValue,
boolean includeThis)
Return value of a named preference within parent anonymous groups or, optionally, this group. |
PreferencesGroup |
getAnonParent()
|
PreferencesGroup |
getChild(java.lang.String name)
Returns a nested preference group. |
Preferences |
getPreferences()
|
void |
remove()
Removes this group from its parent. |
java.lang.String |
set(java.lang.String name,
java.lang.String value)
Sets value of a named program preference. |
void |
set(java.lang.String name,
java.lang.String value,
java.lang.String defaultValue)
Sets value of a named program preference. |
boolean |
unset(java.lang.String name)
Unsets an existing preference (exists() will return false after this). |
Field Detail |
---|
static final int ANON_LAST
Method Detail |
---|
Preferences getPreferences()
boolean exists(java.lang.String name)
name
- Name of preference
java.lang.String get(java.lang.String name)
name
- Name of preference
BugException
- If the preference doesn't existjava.lang.String get(java.lang.String name, java.lang.String defaultValue)
name
- Name of preferencedefaultValue
- Value to use for preference if it isn't found
java.lang.String getAnonHierarchical(java.lang.String name)
name
- Name of preference
BugException
- If the preference doesn't existjava.lang.String getAnonHierarchical(java.lang.String name, java.lang.String defaultValue)
getAnonHierarchical(String)
for description of procedure.
name
- Name of preferencedefaultValue
- Value to use for preference if it isn't found
java.lang.String getAnonHierarchical(java.lang.String name, java.lang.String defaultValue, boolean includeThis)
getAnonHierarchical(String)
for description of procedure.
name
- Name of preferencedefaultValue
- Value to use for preference if it isn't foundincludeThis
- If true, includes this group; otherwise ignores any
setting within this group
PreferencesGroup findAnonGroup(java.lang.String pref, java.lang.String value, boolean recursive)
pref
- Name of prefvalue
- Value of prefrecursive
- If true, follows into anonymous children of subgroups
PreferencesGroup findAnonGroup(java.lang.String pref, java.lang.String value, boolean recursive, boolean ignoreCase)
pref
- Name of prefvalue
- Value of prefrecursive
- If true, follows into anonymous children of subgroupsignoreCase
- If true, ignores case of 'value' parameter
java.lang.String set(java.lang.String name, java.lang.String value)
name
- Name of preference (be sure to follow restrictions)value
- String value of preference
BugException
- If name or owner didn't follow restrictionsvoid set(java.lang.String name, java.lang.String value, java.lang.String defaultValue)
name
- Name of preference (be sure to follow restrictions)value
- String value of preferencedefaultValue
- Default value of preference
BugException
- If name or owner didn't follow restrictionsboolean unset(java.lang.String name)
name
- Name of preference
PreferencesGroup getAnonParent()
PreferencesGroup getChild(java.lang.String name)
name
- Name of preference group
BugException
- If name isn't validvoid remove()
PreferencesGroup[] getAnon()
PreferencesGroup addAnon()
int addAnon(PreferencesGroup pg, int position)
pg
- Group to addposition
- Index for new group (others will be shuffled
along) or ANON_LAST for end of group
void clearAnon()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |