Utils

Class PossibleSettings

java.lang.Object

Utils.PossibleSettings

public class PossibleSettings
extends java.lang.Object

Maintains a list of possible settings. See Settings for further details of how settings are structured.

Version:

2.0

Constructor Summary

Constructors

Constructor and Description
PossibleSettings() Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
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

PossibleSettings

public PossibleSettings()

Default constructor

Method Detail

addGroup

public void addGroup(java.lang.String name,
            boolean needed)
              throws SettingException

Adds a new setting group

Parameters:

name - The name of the group

needed - Whether the group is required

Throws:

SettingException - Thrown if a group with that name already exists

addNeededSetting

public void addNeededSetting(java.lang.String name)
                      throws SettingException

Add a required setting at the root level (i.e. not within a group)

Parameters:

name - The name of the setting

Throws:

SettingException - Thrown if a setting with that name already exists

addNeededSetting

public void addNeededSetting(java.lang.String group,
                    java.lang.String name)
                      throws SettingException

Add a required setting within a group

Parameters:

group - The group to add the setting to

name - The name of the setting

Throws:

SettingException - Thrown if that group / name combination already exists

addOptionalSetting

public void addOptionalSetting(java.lang.String name,
                      java.lang.String def)
                        throws SettingException

Add an optional setting at the root level.

Parameters:

name - The name fo the setting

def - The default value for the setting

Throws:

SettingException - Thrown if a setting with that name already exists

addOptionalSetting

public void addOptionalSetting(java.lang.String group,
                      java.lang.String name,
                      java.lang.String def)
                        throws SettingException

Add an optional setting to a group.

Parameters:

group - The group the setting is to be added to

name - The name fo the setting

def - The default value for the setting

Throws:

SettingException - Thrown if that group / name combination already exists

validSetting

public boolean validSetting(java.lang.String setting)

Tests whether a setting name is valid at the root level

Parameters:

setting - The setting name

Returns:

Whether the setting is a valid setting

validSetting

public boolean validSetting(java.lang.String group,
                   java.lang.String setting)

Tests whether a setting name is valid

Parameters:

group - The group the setting is contained in

setting - The setting name

Returns:

Whether the setting is a valid setting