com.tplan.robot.preferences

Class PreferenceContainer

java.lang.Object

com.tplan.robot.preferences.AbstractUserConfiguration

com.tplan.robot.preferences.UserConfiguration

com.tplan.robot.preferences.PreferenceContainer

All Implemented Interfaces:

PropertyChangeListener, EventListener

public class PreferenceContainer
extends UserConfiguration

A simple preference container compatible with the UserConfiguration class for usage in auxiliary GUI components or classes using the Preferences framework to create simple dialogs with options.

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Field Summary

Fields inherited from class com.tplan.robot.preferences.UserConfiguration

WATCH_DOG_LIST_KEY

Constructor Summary

Constructors

Constructor and Description
PreferenceContainer() Default constructor.

Method Summary

Modifier and Type	Method and Description
Map	getMap() Get the internal preference map.
Map	getOverrideMap() Get the second level preference map for temporary override values.
void	put(String name, String value) Raw "put" method similar to the one of Map.
void	remove(String configKey) Remove a preference from the container.
String	toString()

Methods inherited from class com.tplan.robot.preferences.UserConfiguration

checkSecurity, getCopy, getDefaultConfiguration, getDefaultValue, getDefaultValueAsArrayOfColors, getDefaultValueAsColor, getDefaultValueAsDouble, getDefaultValueAsListOfNumbers, getInstance, getKeyStroke, getOverrideTable, getPreferenceNames, getRawValue, load, loadDefaults, propertyChange, putRawValues, resetToDefaults, save, saveConfiguration, setColors, setOverrideTable, startWatchDog, updateListOfRecents, updateListOfRecents

Methods inherited from class com.tplan.robot.preferences.AbstractUserConfiguration

addConfigurationListener, addConfigurationListener, convertToListOfNumbers, fireConfigurationChanged, getArrayOfBytes, getArrayOfInts, getBoolean, getBooleanStrict, getColor, getColors, getDouble, getDoubleStrict, getInteger, getIntegerStrict, getListOfNumbers, getListOfStrings, getString, isModified, removeConfigurationListener, setBoolean, setDouble, setHTMLColor, setHTMLColorArray, setInteger, setListOfNumbers, setListOfObjects, setString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PreferenceContainer

public PreferenceContainer()

Default constructor.

Method Detail

put

public void put(String name,
                String value)

Raw "put" method similar to the one of Map.

Parameters:

name - preference name (key).

value - preference value.

remove

public void remove(String configKey)

Remove a preference from the container.

Overrides:

remove in class UserConfiguration

Parameters:

configKey - preference name (key).

getMap

public Map getMap()

Get the internal preference map. Be careful with this method because it returns the real map and not its copy.

Returns:

preference map.

getOverrideMap

public Map getOverrideMap()

Get the second level preference map for temporary override values. See the UserConfiguration.setOverrideTable(java.util.Map) method for more.

Returns:

the override map (may be null if it hasn't been explicitly created).

toString

public String toString()

Overrides:

toString in class Object