com.realtime.crossfire.jxclient.settings.options

Class OptionManager

java.lang.Object

com.realtime.crossfire.jxclient.settings.options.OptionManager

public class OptionManager
extends java.lang.Object

Maintains a set of named options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	OptionManager.Entry Pair of Option and corresponding documentation string.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,OptionManager.Entry>	options Maps option name to option instance.
private Settings	settings The settings instance for loading/saving option values.

Constructor Summary

Constructors

Constructor and Description
OptionManager(Settings settings) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addOption(java.lang.String optionName, java.lang.String documentation, Option option) Adds a new option.
CheckBoxOption	getCheckBoxOption(java.lang.String optionName) Returns a check box option.
void	loadOptions() Loads all options' states from the backing settings instance.
void	removeOption(java.lang.String optionName) Removes an option by name.
void	saveOptions() Saves all options' states to the backing settings instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

options

@NotNull
private final java.util.Map<java.lang.String,OptionManager.Entry> options

Maps option name to option instance.

settings

@NotNull
private final Settings settings

The settings instance for loading/saving option values.

Constructor Detail

OptionManager

public OptionManager(@NotNull
                     Settings settings)

Creates a new instance.

Parameters:

settings - the settings instance for loading/saving option values

Method Detail

addOption

public void addOption(@NotNull
                      java.lang.String optionName,
                      @NotNull
                      java.lang.String documentation,
                      @NotNull
                      Option option)
               throws OptionException

Adds a new option.

Parameters:

optionName - the option name to add

documentation - the documentation string for the settings

option - the option to add

Throws:

OptionException - if the option name is not unique

getCheckBoxOption

@NotNull
public CheckBoxOption getCheckBoxOption(@NotNull
                                                 java.lang.String optionName)
                                          throws OptionException

Returns a check box option.

Parameters:

optionName - the option name to look up

Returns:

the option

Throws:

OptionException - if the option name does not exist

loadOptions

public void loadOptions()

Loads all options' states from the backing settings instance.

removeOption

public void removeOption(@NotNull
                         java.lang.String optionName)

Removes an option by name. Does nothing if the option does not exist.

Parameters:

optionName - the option name to remove

saveOptions

public void saveOptions()

Saves all options' states to the backing settings instance.