|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectUtils.PossibleSettings
public class PossibleSettings
Maintains a list of possible settings. See Settings
for further
details of how settings are structured.
Constructor Summary | |
---|---|
PossibleSettings()
Default constructor |
Method Summary | |
---|---|
void |
addGroup(java.lang.String name,
boolean needed)
Adds a new setting group |
void |
addNeededSetting(java.lang.String name)
Add a required setting at the root level (i.e. |
void |
addNeededSetting(java.lang.String group,
java.lang.String name)
Add a required setting within a group |
void |
addOptionalSetting(java.lang.String name,
java.lang.String def)
Add an optional setting at the root level. |
void |
addOptionalSetting(java.lang.String group,
java.lang.String name,
java.lang.String def)
Add an optional setting to a group. |
boolean |
validSetting(java.lang.String setting)
Tests whether a setting name is valid at the root level |
boolean |
validSetting(java.lang.String group,
java.lang.String setting)
Tests whether a setting name is valid |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PossibleSettings()
Method Detail |
---|
public void addGroup(java.lang.String name, boolean needed) throws SettingException
name
- The name of the groupneeded
- Whether the group is required
SettingException
- Thrown if a group with that name already existspublic void addNeededSetting(java.lang.String name) throws SettingException
name
- The name of the setting
SettingException
- Thrown if a setting with that name already existspublic void addNeededSetting(java.lang.String group, java.lang.String name) throws SettingException
group
- The group to add the setting toname
- The name of the setting
SettingException
- Thrown if that group / name combination already existspublic void addOptionalSetting(java.lang.String name, java.lang.String def) throws SettingException
name
- The name fo the settingdef
- The default value for the setting
SettingException
- Thrown if a setting with that name already existspublic void addOptionalSetting(java.lang.String group, java.lang.String name, java.lang.String def) throws SettingException
group
- The group the setting is to be added toname
- The name fo the settingdef
- The default value for the setting
SettingException
- Thrown if that group / name combination already existspublic boolean validSetting(java.lang.String setting)
setting
- The setting name
public boolean validSetting(java.lang.String group, java.lang.String setting)
group
- The group the setting is contained insetting
- The setting name
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |