AbstractUserConfiguration (T-Plan Robot Enterprise 7.0 Code Documentation)

java.lang.Object
- com.tplan.robot.preferences.AbstractUserConfiguration

Direct Known Subclasses:

UserConfiguration
```
public abstract class AbstractUserConfiguration
extends Object
```
User configuration base class. It defines basic methods of manipulation with the configuration parameters. The class is abstract and all successors must implement the get() and put() methods.

Each parameter value is stored as a string. The class provides methods such as getDouble(), setDouble(), getInteger() and setInteger() that perform conversion between number and string.

The configuration is also capable of saving a set of numbers as one parameter. The numbers are converted to a string which contains the numbers formatted by US number format separated by semicolon. The associated methods are getListOfNumbers(java.lang.String) and setListOfNumbers(java.lang.String, java.util.List<? extends java.lang.Number>). The numbers are always saved and restored in the same order (the same as in the vector).

If a component depends on any option value in this class, it should register itself using the method addConfigurationListener() and it will be notified about any changes in the configuration immediately when a set method is called.

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

Constructor Summary

Constructors
Constructor and Description

AbstractUserConfiguration()
Constructor.

Constructors
Constructor and Description
`AbstractUserConfiguration()` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addConfigurationListener(ConfigurationChangeListener l)` Add a configuration change listener
`void`	`addConfigurationListener(WeakReference<ConfigurationChangeListener> l)`
`List<? extends Number>`	`convertToListOfNumbers(Object obj)` Perform conversion from an object to a list of numbers.
`void`	`fireConfigurationChanged(ConfigurationChangeEvent e)` Fire a ChangeEvent to all registered listeners when the configuration gets changed.
`byte[]`	`getArrayOfBytes(String parameterName)` Get the value of a parameter as an array of integers.
`int[]`	`getArrayOfInts(String parameterName)` Get the value of a parameter as an array of integers.
`Boolean`	`getBoolean(String parameterName)` Get a parameter as a Boolean.
`Boolean`	`getBooleanStrict(String parameterName)` Get a parameter as a Boolean.
`Color`	`getColor(String parameterName)` Get a parameter value and try to convert it to a Color instance.
`Color[]`	`getColors(String parameterName)` Get a parameter value and try to convert it to an array of colors.
`Double`	`getDouble(String parameterName)` Get a parameter as a Double.
`Double`	`getDoubleStrict(String parameterName)` Get a parameter as a Double.
`Integer`	`getInteger(String parameterName)` Get a parameter as an Integer.
`Integer`	`getIntegerStrict(String parameterName)` Get a parameter as an Integer.
`List<? extends Number>`	`getListOfNumbers(String parameterName)` Get the value of a parameter as a vector of double values.
`List<String>`	`getListOfStrings(String parameterName)` Get the value of a parameter as a vector of String values.
`String`	`getString(String parameterName)` Get a parameter as a String.
`boolean`	`isModified()` Get value of the modification flag.
`void`	`removeConfigurationListener(ConfigurationChangeListener l)` Remove a configuration change listener
`void`	`setBoolean(String parameterName, Boolean b)` Set the parameter as an Boolean
`void`	`setDouble(String parameterName, Number number)`
`void`	`setHTMLColor(String parameterName, Color color)`
`void`	`setHTMLColorArray(String parameterName, Color[] colors)`
`void`	`setInteger(String parameterName, Number number)` Set the parameter as an Integer
`void`	`setListOfNumbers(String parameterName, List<? extends Number> values)` Set a parameter as a vector of double values.
`void`	`setListOfObjects(String parameterName, List values)` Set a parameter as a vector of objects.
`void`	`setString(String parameterName, String value)` Set a String parameter.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractUserConfiguration
```
public AbstractUserConfiguration()
```
    Constructor.
- Method Detail
  - removeConfigurationListener
```
public void removeConfigurationListener(ConfigurationChangeListener l)
```
    Remove a configuration change listener
    
    Parameters:
    
    l - a configuration change listener
  - addConfigurationListener
```
public void addConfigurationListener(ConfigurationChangeListener l)
```
    Add a configuration change listener
    
    Parameters:
    
    l - a configuration change listener
  - addConfigurationListener
```
public void addConfigurationListener(WeakReference<ConfigurationChangeListener> l)
```
  - fireConfigurationChanged
```
public void fireConfigurationChanged(ConfigurationChangeEvent e)
```
    Fire a ChangeEvent to all registered listeners when the configuration gets changed. This method is to be called every time a parameter value is changed.
    
    Parameters:
    
    e - a change event.
  - getDouble
```
public Double getDouble(String parameterName)
```
    Get a parameter as a Double.
    
    Parameters:
    
    parameterName - parameter name
    
    Returns:
    
    parameter value as a Double, null if the parameter is not in the configuration
    
    Throws:
    
    NumberFormatException - if the parameter cannot be converted to Double
  - getDoubleStrict
```
public Double getDoubleStrict(String parameterName)
```
    Get a parameter as a Double.
    
    Parameters:
    
    parameterName - parameter name
    
    Returns:
    
    parameter value as a Double, null if the parameter is not in the configuration
    
    Throws:
    
    IllegalArgumentException - if the parameter is not a valid number.
  - getInteger
```
public Integer getInteger(String parameterName)
```
    Get a parameter as an Integer.
    
    Parameters:
    
    parameterName - parameter name
    
    Returns:
    
    parameter value as an Integer, null if the parameter is not in the configuration
    
    Throws:
    
    NumberFormatException - if the parameter cannot be converted to Integer
  - getIntegerStrict
```
public Integer getIntegerStrict(String parameterName)
```
    Get a parameter as an Integer.
    
    Parameters:
    
    parameterName - parameter name
    
    Returns:
    
    parameter value as an Integer, null if the parameter is not in the configuration
    
    Throws:
    
    IllegalArgumentException - if the parameter is not a valid number.
  - setDouble
```
public void setDouble(String parameterName,
                      Number number)
```
  - setInteger
```
public void setInteger(String parameterName,
                       Number number)
```
    Set the parameter as an Integer
    
    Parameters:
    
    parameterName - parameter name
    
    number - a number to be saved as integer under the parameter name
  - getBoolean
```
public Boolean getBoolean(String parameterName)
```
    Get a parameter as a Boolean. Any of the values of "1", "true" or "yes" is considered to be the value of true.
    
    Parameters:
    
    parameterName - parameter name
    
    Returns:
    
    parameter value as a Boolean, null if the parameter is not in the configuration
  - getBooleanStrict
```
public Boolean getBooleanStrict(String parameterName)
                         throws IllegalArgumentException
```
    Get a parameter as a Boolean. Any of the values of "1", "true" or "yes" is considered to be the value of true while any of "0", "false" or "no" is returned as false. Any other non-null value will make the method throw an IllegalArgumentException.
    
    Parameters:
    
    parameterName - parameter name
    
    Returns:
    
    parameter value as a Boolean, null if the parameter is not in the configuration
    
    Throws:
    
    IllegalArgumentException
  - setBoolean
```
public void setBoolean(String parameterName,
                       Boolean b)
```
    Set the parameter as an Boolean
    
    Parameters:
    
    parameterName - parameter name
    
    b - a boolean value to be saved
  - getListOfStrings
```
public List<String> getListOfStrings(String parameterName)
```
    Get the value of a parameter as a vector of String values. The parameter value is expected to be a string or a string containing number values separated by a semicolon.
    
    Parameters:
    
    parameterName - parameter name.
    
    Returns:
    
    a Vector which contains String instances.
  - getListOfNumbers
```
public List<? extends Number> getListOfNumbers(String parameterName)
```
    Get the value of a parameter as a vector of double values. The parameter value is expected to be a single number or a string containing number values separated by a semicolon.
    
    Parameters:
    
    parameterName - parameter name.
    
    Returns:
    
    a Vector which contains Number instances.
  - getArrayOfInts
```
public int[] getArrayOfInts(String parameterName)
```
    Get the value of a parameter as an array of integers. The parameter value is expected to be a single number or a string containing number values separated by a semicolon.
    
    Parameters:
    
    parameterName - parameter name.
    
    Returns:
    
    an array of integers.
  - getArrayOfBytes
```
public byte[] getArrayOfBytes(String parameterName)
```
    Get the value of a parameter as an array of integers. The parameter value is expected to be a single number or a string containing number values separated by a semicolon.
    
    Parameters:
    
    parameterName - parameter name.
    
    Returns:
    
    an array of integers.
  - convertToListOfNumbers
```
public List<? extends Number> convertToListOfNumbers(Object obj)
```
    Perform conversion from an object to a list of numbers. The argument is expected to be a single number or a string containing number values separated by a semicolon.
    
    Parameters:
    
    obj - an object (a user parameter value)
    
    Returns:
    
    a new vector of numbers
  - setListOfNumbers
```
public void setListOfNumbers(String parameterName,
                             List<? extends Number> values)
```
    Set a parameter as a vector of double values. The vector will be converted into a string containing number values separated by a semicolon.
    
    Parameters:
    
    parameterName - parameter name.
    
    values - a Vector which contains Number instances.
  - setListOfObjects
```
public void setListOfObjects(String parameterName,
                             List values)
```
    Set a parameter as a vector of objects. The vector will be converted into a string containing values separated by a semicolon.
    
    Parameters:
    
    parameterName - parameter name.
    
    values - a Vector.
  - getString
```
public String getString(String parameterName)
```
    Get a parameter as a String.
    
    Parameters:
    
    parameterName - parameter name.
    
    Returns:
    
    the value of the requested parameter.
  - setString
```
public void setString(String parameterName,
                      String value)
```
    Set a String parameter.
    
    Parameters:
    
    parameterName - parameter name.
    
    value - a String value to be saved under the parameter name.
  - isModified
```
public boolean isModified()
```
    Get value of the modification flag.
    
    Returns:
    
    true if anything in the configuration has changed, false if not
  - getColor
```
public Color getColor(String parameterName)
```
    Get a parameter value and try to convert it to a Color instance. See setHTMLColor(java.lang.String, java.awt.Color) method for more information.
    
    Parameters:
    
    parameterName - name of the parameter.
    
    Returns:
    
    the parameter value as a Color instance, null if conversion fails.
  - getColors
```
public Color[] getColors(String parameterName)
```
    Get a parameter value and try to convert it to an array of colors. See setHTMLColor(java.lang.String, java.awt.Color) method for more information.
    
    Parameters:
    
    parameterName - name of the parameter.
    
    Returns:
    
    an array with Color instances.
  - setHTMLColor
```
public void setHTMLColor(String parameterName,
                         Color color)
```
  - setHTMLColorArray
```
public void setHTMLColorArray(String parameterName,
                              Color[] colors)
```

Class AbstractUserConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractUserConfiguration

Method Detail

removeConfigurationListener

addConfigurationListener

addConfigurationListener

fireConfigurationChanged

getDouble

getDoubleStrict

getInteger

getIntegerStrict

setDouble

setInteger

getBoolean

getBooleanStrict

setBoolean

getListOfStrings

getListOfNumbers

getArrayOfInts

getArrayOfBytes

convertToListOfNumbers

setListOfNumbers

setListOfObjects

getString

setString

isModified

getColor

getColors

setHTMLColor

setHTMLColorArray