org.knime.core.node.config.base

Class ConfigBase

java.lang.Object

org.knime.core.node.config.base.AbstractConfigEntry

org.knime.core.node.config.base.ConfigBase

All Implemented Interfaces:

Serializable, Iterable<String>, TreeNode, ConfigBaseRO, ConfigBaseWO

Direct Known Subclasses:

Config

public abstract class ConfigBase
extends AbstractConfigEntry
implements ConfigBaseRO, ConfigBaseWO

Supports a mechanism to save settings by their type and a key. Furthermore, it provides a method to recursively add new sub ConfigBase objects to this ConfigBase object, which then results in a tree-like structure.

This class provides several types of settings which are int, double, char, short, byte, boolean, java.lang.String, and ConfigBase. For these supported elements, methods to add either a single or an array or retrieve them back by throwing an InvalidSettingsException or passing a default valid in advance have been implemented.

Author:

Thomas Gabriel, University of Konstanz

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConfigBase(String key) Creates a new, empty config object with the given key.

Method Summary

Modifier and Type	Method and Description
void	addBoolean(String key, boolean value) Adds this boolean value to the ConfigBase by the given key.
void	addBooleanArray(String key, boolean... values) Adds this boolean values to the ConfigBase by the given key.
void	addByte(String key, byte value) Adds this byte value to the ConfigBase by the given key.
void	addByteArray(String key, byte... values) Adds this byte array to the ConfigBase by the given key.
void	addChar(String key, char value) Adds this char value to the ConfigBase by the given key.
void	addCharArray(String key, char... values) Adds this char array to the ConfigBase by the given key.
protected void	addConfigBase(ConfigBase config) Appends the given ConfigBase to this ConfigBase which has to directly derived from this class.
ConfigBase	addConfigBase(String key) Creates a new ConfigBase with the given key and returns it.
void	addDouble(String key, double value) Adds a double by the given key.
void	addDoubleArray(String key, double... values) Adds this double array value to the ConfigBase by the given key.
void	addEntry(AbstractConfigEntry entry) Adds the given ConfigBase entry to this Config.
void	addFloat(String key, float value) Adds a float by the given key.
void	addFloatArray(String key, float... values) Adds this float array value to the ConfigBase by the given key.
void	addInt(String key, int value) Adds an int.
void	addIntArray(String key, int... values) Adds this int array to the ConfigBase by the given key.
void	addLong(String key, long value) Adds this long value to the ConfigBase by the given key.
void	addLongArray(String key, long... values) Adds this long array to the ConfigBase by the given key.
void	addPassword(String key, String encryptionKey, String value) Adds a password to the config object.
void	addShort(String key, short value) Adds this short value to the ConfigBase by the given key.
void	addShortArray(String key, short... values) Adds this short array to the ConfigBase by the given key.
void	addString(String key, String value) Adds this String object to the ConfigBase by the given key.
void	addStringArray(String key, String... values) Adds this array of String object to the ConfigBase by the given key.
void	addTransientString(String key, String value) Adds a 'transient' string to this settings tree.
Enumeration<TreeNode>	children() An enumeration of a values.
boolean	containsKey(String key) Checks if this key for a particular type is in this Config.
void	copyTo(ConfigBaseWO dest) Makes a deep copy of this ConfigBase and all sub ConfigBase objects.
protected AbstractConfigEntry	get(String key)
boolean	getBoolean(String key) Return boolean for key.
boolean	getBoolean(String key, boolean def) Return boolean for key or the default value if not available.
boolean[]	getBooleanArray(String key) Return a boolean array for key which can be null.
boolean[]	getBooleanArray(String key, boolean... def) Return a boolean array which can be null for key, or the default value if not available.
byte	getByte(String key) Return byte for key.
byte	getByte(String key, byte def) Return byte for key.
byte[]	getByteArray(String key) Return byte array which can be null for key.
byte[]	getByteArray(String key, byte... def) Return byte array which can be null for key, or the default value if not available.
char	getChar(String key) Return char for key.
char	getChar(String key, char def) Return char for key or the default value if not available.
char[]	getCharArray(String key) Return char array which can be null for key.
char[]	getCharArray(String key, char... def) Return char array which can be null for key, or the default array if the key is not available.
TreeNode	getChildAt(int childIndex) The TreeNode for the given index.
int	getChildCount()
ConfigBase	getConfigBase(String key) Retrieves ConfigBase by key.
double	getDouble(String key) Return double for key.
double	getDouble(String key, double def) Return double for key or the default value if not available.
double[]	getDoubleArray(String key) Return double array for key or the default value if not available.
double[]	getDoubleArray(String key, double... def) Return double array which can be null for key, or the default array if the key is not available.
AbstractConfigEntry	getEntry(String key) Returns ConfigBase entry for a key.
float	getFloat(String key) Return float for key.
float	getFloat(String key, float def) Return float for key or the default value if not available.
float[]	getFloatArray(String key) Return float array for key or the default value if not available.
float[]	getFloatArray(String key, float... def) Return float array which can be null for key, or the default array if the key is not available.
int	getIndex(TreeNode node) Returns the index for a given TreeNode.
abstract ConfigBase	getInstance(String key) Creates a new ConfigBase of this type.
int	getInt(String key) Return int for key.
int	getInt(String key, int def) Return int for key or the default value if not available.
int[]	getIntArray(String key) Return int array which can be null for key, or the default array if the key is not available.
int[]	getIntArray(String key, int... def) Return int array which can be null for key, or the default array if the key is not available.
long	getLong(String key) Return long for key.
long	getLong(String key, long def) Return long value for key or the default if the key is not available.
long[]	getLongArray(String key) Return a long array which can be null for key, or the default value if not available.
long[]	getLongArray(String key, long... def) Return long array which can be null for key, or the default array if the key is not available.
String	getPassword(String key, String encryptionKey) Returns a decrypted password.
String	getPassword(String key, String encryptionKey, String def) Returns a decrypted password.
short	getShort(String key) Return short for key.
short	getShort(String key, short def) Return short value for key or the default if the key is not available.
short[]	getShortArray(String key) Return a short array which can be null for key, or the default value if not available.
short[]	getShortArray(String key, short... def) Return short array which can be null for key, or the default array if the key is not available.
String	getString(String key) Return String for key.
String	getString(String key, String def) Return String object which can be null, or the default array if the key is not available.
String[]	getStringArray(String key) Return String array which can be null for key.
String[]	getStringArray(String key, String... def) Return String array which can be null for key, or the default array if the key is not available.
String	getTransientString(String key) Returns a transient string if present or null if no longer available (setting restored from disc).
boolean	hasIdenticalValue(AbstractConfigEntry otherConfig) Derived classes must compare their value with the value in the passed argument (on equality).
boolean	isLeaf()
Iterator<String>	iterator()
Set<String>	keySet() Returns an unmodifiable Set of keys in this Config.
void	load(InputStream is) Read config entries from an XML file into this object.
protected static ConfigBase	loadFromXML(ConfigBase config, InputStream in) Reads ConfigBase from XML into a new ConfigBase object.
protected void	put(AbstractConfigEntry e)
protected static ConfigBase	readFromFile(ObjectInputStream ois) Creates new ConfigBase from the given file using the serialized object stream.
void	saveToXML(OutputStream os) Writes this ConfigBase to the given stream as XML.
String	toString() String summary of this object including key, type, and value.
void	toString(StringBuffer buf) Adds this and all children String representations to the given buffer.
String	toStringValue() Returns a String representation for this Config entry which is the used to re-load this Config entry.
void	writeToFile(ObjectOutputStream oos) Writes this ConfigBase into the given stream.

Methods inherited from class org.knime.core.node.config.base.AbstractConfigEntry

equals, getAllowsChildren, getKey, getParent, getType, hashCode, isIdentical, setKey, setParent

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.knime.core.node.config.base.ConfigBaseRO

getKey

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.knime.core.node.config.base.ConfigBaseWO

getKey

Constructor Detail

ConfigBase

public ConfigBase(String key)

Creates a new, empty config object with the given key.

Parameters:

key - The key for this ConfigBase.

Method Detail

put

protected void put(AbstractConfigEntry e)

get

protected AbstractConfigEntry get(String key)

getInstance

public abstract ConfigBase getInstance(String key)

Creates a new ConfigBase of this type.

Parameters:

key - The new ConfigBase's key.

Returns:

A new instance of this ConfigBase.

addConfigBase

public final ConfigBase addConfigBase(String key)

Creates a new ConfigBase with the given key and returns it.

Specified by:

addConfigBase in interface ConfigBaseWO

Parameters:

key - An identifier.

Returns:

A new ConfigBase object.

addConfigBase

protected final void addConfigBase(ConfigBase config)

Appends the given ConfigBase to this ConfigBase which has to directly derived from this class.

Parameters:

config - The ConfigBase to append.

Throws:

NullPointerException - If config is null.

IllegalArgumentException - If config is not instance of this class.

getConfigBase

public final ConfigBase getConfigBase(String key)
                               throws InvalidSettingsException

Retrieves ConfigBase by key.

Specified by:

getConfigBase in interface ConfigBaseRO

Parameters:

key - The key.

Returns:

A ConfigBase object.

Throws:

InvalidSettingsException - If the key is not available.

addInt

public void addInt(String key,
                   int value)

Adds an int.

Specified by:

addInt in interface ConfigBaseWO

Parameters:

key - The key.

value - The int value.

getInt

public int getInt(String key)
           throws InvalidSettingsException

Return int for key.

Specified by:

getInt in interface ConfigBaseRO

Parameters:

key - The key.

Returns:

A generic int.

Throws:

InvalidSettingsException - If the key is not available.

addDouble

public void addDouble(String key,
                      double value)

Adds a double by the given key.

Specified by:

addDouble in interface ConfigBaseWO

Parameters:

key - The key.

value - The double value to add.

getDouble

public double getDouble(String key)
                 throws InvalidSettingsException

Return double for key.

Specified by:

getDouble in interface ConfigBaseRO

Parameters:

key - The key.

Returns:

A generic double.

Throws:

InvalidSettingsException - If the key is not available.

addFloat

public void addFloat(String key,
                     float value)

Adds a float by the given key.

Specified by:

addFloat in interface ConfigBaseWO

Parameters:

key - The key.

value - The float value to add.

getFloat

public float getFloat(String key)
               throws InvalidSettingsException

Return float for key.

Specified by:

getFloat in interface ConfigBaseRO

Parameters:

key - The key.

Returns:

A generic float.

Throws:

InvalidSettingsException - If the key is not available.

addChar

public void addChar(String key,
                    char value)

Adds this char value to the ConfigBase by the given key.

Specified by:

addChar in interface ConfigBaseWO

Parameters:

key - The key.

value - The char to add.

getChar

public char getChar(String key)
             throws InvalidSettingsException

Return char for key.

Specified by:

getChar in interface ConfigBaseRO

Parameters:

key - The key.

Returns:

A generic char.

Throws:

InvalidSettingsException - If the key is not available.

addShort

public void addShort(String key,
                     short value)

Adds this short value to the ConfigBase by the given key.

Specified by:

addShort in interface ConfigBaseWO

Parameters:

key - The key.

value - The short to add.

getShort

public short getShort(String key)
               throws InvalidSettingsException

Return short for key.

Specified by:

getShort in interface ConfigBaseRO

Parameters:

key - The key.

Returns:

A generic short.

Throws:

InvalidSettingsException - If the key is not available.

addLong

public void addLong(String key,
                    long value)

Adds this long value to the ConfigBase by the given key.

Specified by:

addLong in interface ConfigBaseWO

Parameters:

key - The key.

value - The long to add.

getLong

public long getLong(String key)
             throws InvalidSettingsException

Return long for key.

Specified by:

getLong in interface ConfigBaseRO

Parameters:

key - The key.

Returns:

A generic long.

Throws:

InvalidSettingsException - If the key is not available.

addByte

public void addByte(String key,
                    byte value)

Adds this byte value to the ConfigBase by the given key.

Specified by:

addByte in interface ConfigBaseWO

Parameters:

key - The key.

value - The byte to add.

getByte

public byte getByte(String key)
             throws InvalidSettingsException

Return byte for key.

Specified by:

getByte in interface ConfigBaseRO

Parameters:

key - The key.

Returns:

A generic byte.

Throws:

InvalidSettingsException - If the key is not available.

addString

public void addString(String key,
                      String value)

Adds this String object to the ConfigBase by the given key. The String can be null.

Specified by:

addString in interface ConfigBaseWO

Parameters:

key - The key.

value - The boolean to add.

getString

public String getString(String key)
                 throws InvalidSettingsException

Return String for key.

Specified by:

getString in interface ConfigBaseRO

Parameters:

key - The key.

Returns:

A String object.

Throws:

InvalidSettingsException - If the key is not available.

keySet

public Set<String> keySet()

Returns an unmodifiable Set of keys in this Config.

Specified by:

keySet in interface ConfigBaseRO

Returns:

A Set of keys.

hasIdenticalValue

public boolean hasIdenticalValue(AbstractConfigEntry otherConfig)

Description copied from class: AbstractConfigEntry

Derived classes must compare their value with the value in the passed argument (on equality). They can safely assume that the specified object has the same java class, the same type and key.

Specified by:

hasIdenticalValue in class AbstractConfigEntry

Parameters:

otherConfig - The other ConfigBase to check.

Returns:

true if both ConfigBase objects store identical entries.

containsKey

public boolean containsKey(String key)

Checks if this key for a particular type is in this Config.

Specified by:

containsKey in interface ConfigBaseRO

Parameters:

key - The key.

Returns:

true if available, false if key is null or not available.

getBoolean

public boolean getBoolean(String key)
                   throws InvalidSettingsException

Return boolean for key.

Specified by:

getBoolean in interface ConfigBaseRO

Parameters:

key - The key.

Returns:

A generic boolean.

Throws:

InvalidSettingsException - If the key is not available.

addBoolean

public void addBoolean(String key,
                       boolean value)

Adds this boolean value to the ConfigBase by the given key.

Specified by:

addBoolean in interface ConfigBaseWO

Parameters:

key - The key.

value - The boolean to add.

getInt

public int getInt(String key,
                  int def)

Return int for key or the default value if not available.

Specified by:

getInt in interface ConfigBaseRO

Parameters:

key - The key.

def - Returned if no value available for the given key.

Returns:

A generic int.

getIntArray

public int[] getIntArray(String key)
                  throws InvalidSettingsException

Return int array which can be null for key, or the default array if the key is not available.

Specified by:

getIntArray in interface ConfigBaseRO

Parameters:

key - The key.

Returns:

An int array.

Throws:

InvalidSettingsException - If the key is not available.

getIntArray

public int[] getIntArray(String key,
                         int... def)

Return int array which can be null for key, or the default array if the key is not available.

Specified by:

getIntArray in interface ConfigBaseRO

Parameters:

key - The key.

def - The default array returned if the key is not available.

Returns:

An int array.

addIntArray

public void addIntArray(String key,
                        int... values)

Adds this int array to the ConfigBase by the given key.

Specified by:

addIntArray in interface ConfigBaseWO

Parameters:

key - The key.

values - The int array to add.

getDouble

public double getDouble(String key,
                        double def)

Return double for key or the default value if not available.

Specified by:

getDouble in interface ConfigBaseRO

Parameters:

key - The key.

def - Returned if no value available for the given key.

Returns:

A generic double.

getDoubleArray

public double[] getDoubleArray(String key)
                        throws InvalidSettingsException

Return double array for key or the default value if not available.

Specified by:

getDoubleArray in interface ConfigBaseRO

Parameters:

key - The key.

Returns:

An array of double values.

Throws:

InvalidSettingsException - If the key is not available.

getDoubleArray

public double[] getDoubleArray(String key,
                               double... def)

Return double array which can be null for key, or the default array if the key is not available.

Specified by:

getDoubleArray in interface ConfigBaseRO

Parameters:

key - The key.

def - The default array returned if the key is not available.

Returns:

A double array.

getFloat

public float getFloat(String key,
                      float def)

Return float for key or the default value if not available.

Specified by:

getFloat in interface ConfigBaseRO

Parameters:

key - The key.

def - Returned if no value available for the given key.

Returns:

A generic float.

getFloatArray

public float[] getFloatArray(String key)
                      throws InvalidSettingsException

Return float array for key or the default value if not available.

Specified by:

getFloatArray in interface ConfigBaseRO

Parameters:

key - The key.

Returns:

An array of float values.

Throws:

InvalidSettingsException - If the key is not available.

getFloatArray

public float[] getFloatArray(String key,
                             float... def)

Return float array which can be null for key, or the default array if the key is not available.

Specified by:

getFloatArray in interface ConfigBaseRO

Parameters:

key - The key.

def - The default array returned if the key is not available.

Returns:

A float array.

addDoubleArray

public void addDoubleArray(String key,
                           double... values)

Adds this double array value to the ConfigBase by the given key. The array can be null.

Specified by:

addDoubleArray in interface ConfigBaseWO

Parameters:

key - The key.

values - The double array to add.

addFloatArray

public void addFloatArray(String key,
                          float... values)

Adds this float array value to the ConfigBase by the given key. The array can be null.

Specified by:

addFloatArray in interface ConfigBaseWO

Parameters:

key - The key.

values - The float array to add.

getChar

public char getChar(String key,
                    char def)

Return char for key or the default value if not available.

Specified by:

getChar in interface ConfigBaseRO

Parameters:

key - The key.

def - Returned if no value available for the given key.

Returns:

A generic char.

getCharArray

public char[] getCharArray(String key)
                    throws InvalidSettingsException

Return char array which can be null for key.

Specified by:

getCharArray in interface ConfigBaseRO

Parameters:

key - The key.

Returns:

A char array.

Throws:

InvalidSettingsException - If the the key is not available.

getByteArray

public byte[] getByteArray(String key,
                           byte... def)

Return byte array which can be null for key, or the default value if not available.

Specified by:

getByteArray in interface ConfigBaseRO

Parameters:

key - The key.

def - Returned if no value available for the given key.

Returns:

A byte array.

getByteArray

public byte[] getByteArray(String key)
                    throws InvalidSettingsException

Return byte array which can be null for key.

Specified by:

getByteArray in interface ConfigBaseRO

Parameters:

key - The key.

Returns:

A byte array.

Throws:

InvalidSettingsException - If the the key is not available.

addByteArray

public void addByteArray(String key,
                         byte... values)

Adds this byte array to the ConfigBase by the given key. The array can be null.

Specified by:

addByteArray in interface ConfigBaseWO

Parameters:

key - The key.

values - The byte array to add.

getByte

public byte getByte(String key,
                    byte def)

Return byte for key.

Specified by:

getByte in interface ConfigBaseRO

Parameters:

key - The key.

def - Returned if no value available for the given key.

Returns:

A generic byte.

getShortArray

public short[] getShortArray(String key)
                      throws InvalidSettingsException

Return a short array which can be null for key, or the default value if not available.

Specified by:

getShortArray in interface ConfigBaseRO

Parameters:

key - The key.

Returns:

A short array.

Throws:

InvalidSettingsException - If the key is not available.

getShortArray

public short[] getShortArray(String key,
                             short... def)

Return short array which can be null for key, or the default array if the key is not available.

Specified by:

getShortArray in interface ConfigBaseRO

Parameters:

key - The key.

def - The default array returned if the key is not available.

Returns:

A short array.

getLongArray

public long[] getLongArray(String key)
                    throws InvalidSettingsException

Return a long array which can be null for key, or the default value if not available.

Specified by:

getLongArray in interface ConfigBaseRO

Parameters:

key - The key.

Returns:

A long array.

Throws:

InvalidSettingsException - If the key is not available.

getLongArray

public long[] getLongArray(String key,
                           long... def)

Return long array which can be null for key, or the default array if the key is not available.

Specified by:

getLongArray in interface ConfigBaseRO

Parameters:

key - The key.

def - The default array returned if the key is not available.

Returns:

A long array.

addShortArray

public void addShortArray(String key,
                          short... values)

Adds this short array to the ConfigBase by the given key.

Specified by:

addShortArray in interface ConfigBaseWO

Parameters:

key - The key.

values - The short to add.

getShort

public short getShort(String key,
                      short def)

Return short value for key or the default if the key is not available.

Specified by:

getShort in interface ConfigBaseRO

Parameters:

key - The key.

def - The default values returned if the key is not available.

Returns:

A short value.

addLongArray

public void addLongArray(String key,
                         long... values)

Adds this long array to the ConfigBase by the given key.

Specified by:

addLongArray in interface ConfigBaseWO

Parameters:

key - The key.

values - The long arry to add.

getLong

public long getLong(String key,
                    long def)

Return long value for key or the default if the key is not available.

Specified by:

getLong in interface ConfigBaseRO

Parameters:

key - The key.

def - The default values returned if the key is not available.

Returns:

A long value.

getCharArray

public char[] getCharArray(String key,
                           char... def)

Return char array which can be null for key, or the default array if the key is not available.

Specified by:

getCharArray in interface ConfigBaseRO

Parameters:

key - The key.

def - The default array returned if the key is not available.

Returns:

A char array.

addCharArray

public void addCharArray(String key,
                         char... values)

Adds this char array to the ConfigBase by the given key.

Specified by:

addCharArray in interface ConfigBaseWO

Parameters:

key - The key.

values - The char array to add.

getBoolean

public boolean getBoolean(String key,
                          boolean def)

Return boolean for key or the default value if not available.

Specified by:

getBoolean in interface ConfigBaseRO

Parameters:

key - The key.

def - Returned if no value available for the given key.

Returns:

A generic boolean.

getBooleanArray

public boolean[] getBooleanArray(String key)
                          throws InvalidSettingsException

Return a boolean array for key which can be null.

Specified by:

getBooleanArray in interface ConfigBaseRO

Parameters:

key - The key.

Returns:

A boolean or null.

Throws:

InvalidSettingsException - If the key is not available.

getBooleanArray

public boolean[] getBooleanArray(String key,
                                 boolean... def)

Return a boolean array which can be null for key, or the default value if not available.

Specified by:

getBooleanArray in interface ConfigBaseRO

Parameters:

key - The key.

def - Returned if no value available for the given key.

Returns:

A boolean array.

addBooleanArray

public void addBooleanArray(String key,
                            boolean... values)

Adds this boolean values to the ConfigBase by the given key. The array can be null.

Specified by:

addBooleanArray in interface ConfigBaseWO

Parameters:

key - The key.

values - The boolean array to add.

getString

public String getString(String key,
                        String def)

Return String object which can be null, or the default array if the key is not available.

Specified by:

getString in interface ConfigBaseRO

Parameters:

key - The key.

def - The default String returned if the key is not available.

Returns:

A String.

getStringArray

public String[] getStringArray(String key)
                        throws InvalidSettingsException

Return String array which can be null for key.

Specified by:

getStringArray in interface ConfigBaseRO

Parameters:

key - The key.

Returns:

A String array.

Throws:

InvalidSettingsException - If the key is not available.

getStringArray

public String[] getStringArray(String key,
                               String... def)

Return String array which can be null for key, or the default array if the key is not available.

Specified by:

getStringArray in interface ConfigBaseRO

Parameters:

key - The key.

def - The default array returned if the key is not available.

Returns:

A String array.

addStringArray

public void addStringArray(String key,
                           String... values)

Adds this array of String object to the ConfigBase by the given key. The array and the elements can be null.

Specified by:

addStringArray in interface ConfigBaseWO

Parameters:

key - The key.

values - The String array to add.

getEntry

public AbstractConfigEntry getEntry(String key)

Returns ConfigBase entry for a key.

Parameters:

key - The key.

Returns:

The ConfigBase entry for the key.

addEntry

public void addEntry(AbstractConfigEntry entry)

Adds the given ConfigBase entry to this Config.

Parameters:

entry - The ConfigBase entry to add.

iterator

public final Iterator<String> iterator()

Specified by:

iterator in interface Iterable<String>

Specified by:

iterator in interface ConfigBaseRO

toStringValue

public final String toStringValue()

Returns a String representation for this Config entry which is the used to re-load this Config entry.

Specified by:

toStringValue in class AbstractConfigEntry

Returns:

A String representing this Config entry which can be null.

toString

public final void toString(StringBuffer buf)

Adds this and all children String representations to the given buffer.

Parameters:

buf - The string buffer to which this Config's String all all children String representation is added.

toString

public String toString()

String summary of this object including key, type, and value.

Overrides:

toString in class AbstractConfigEntry

Returns:

key + type + value

See Also:

Object.toString()

writeToFile

public final void writeToFile(ObjectOutputStream oos)
                       throws IOException

Writes this ConfigBase into the given stream.

Parameters:

oos - Write ConfigBase to this stream.

Throws:

IOException - If the file cannot be accessed.

readFromFile

protected static ConfigBase readFromFile(ObjectInputStream ois)
                                  throws IOException

Creates new ConfigBase from the given file using the serialized object stream.

Parameters:

ois - Read ConfigBase from this stream.

Returns:

The new Config.

Throws:

IOException - Problem opening the file or content is not a Config.

saveToXML

public final void saveToXML(OutputStream os)
                     throws IOException

Writes this ConfigBase to the given stream as XML. Note that the stream will be closed when finished.

Specified by:

saveToXML in interface ConfigBaseRO

Parameters:

os - The stream to write into.

Throws:

IOException - If this ConfigBase could be stored to the stream.

loadFromXML

protected static ConfigBase loadFromXML(ConfigBase config,
                                        InputStream in)
                                 throws IOException

Reads ConfigBase from XML into a new ConfigBase object.

Parameters:

config - Depending on the readRoot, we write into this ConfigBase and return it.

in - The stream to read XML ConfigBase from.

Returns:

A new ConfigBase filled with the content read from XML.

Throws:

IOException - If the ConfigBase could not be load from stream.

load

public void load(InputStream is)
          throws IOException

Read config entries from an XML file into this object.

Parameters:

is - The XML inputstream storing the configuration to read

Throws:

IOException - If the stream could not be read.

copyTo

public void copyTo(ConfigBaseWO dest)

Makes a deep copy of this ConfigBase and all sub ConfigBase objects.

Specified by:

copyTo in interface ConfigBaseRO

Parameters:

dest - the destination this ConfigBase object is copied to.

getChildAt

public TreeNode getChildAt(int childIndex)

The TreeNode for the given index.

Specified by:

getChildAt in interface TreeNode

Overrides:

getChildAt in class AbstractConfigEntry

Parameters:

childIndex - The index to retrieve the TreeNode for.

Returns:

The associated TreeNode.

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface TreeNode

Overrides:

getChildCount in class AbstractConfigEntry

Returns:

The number of entries in this Config.

See Also:

TreeNode.getChildCount()

getIndex

public int getIndex(TreeNode node)

Returns the index for a given TreeNode.

Specified by:

getIndex in interface TreeNode

Overrides:

getIndex in class AbstractConfigEntry

Parameters:

node - The TreeNode to get the index for.

Returns:

The index of the given node.

See Also:

TreeNode.getIndex(javax.swing.tree.TreeNode)

isLeaf

public final boolean isLeaf()

Specified by:

isLeaf in interface TreeNode

Overrides:

isLeaf in class AbstractConfigEntry

Returns:

true, only if the map is empty.

See Also:

TreeNode.isLeaf()

children

public final Enumeration<TreeNode> children()

An enumeration of a values.

Specified by:

children in interface TreeNode

Overrides:

children in class AbstractConfigEntry

Returns:

All elements of this Config.

See Also:

TreeNode.children()

addPassword

public void addPassword(String key,
                        String encryptionKey,
                        String value)

Adds a password to the config object. The encryption routine is initialized with the given encryption key. Use the corresponding methods from ConfigBaseRO with the same encryption key in order to the get the decrypted password.

Specified by:

addPassword in interface ConfigBaseWO

Parameters:

key - the key for storing the password, must not be null

encryptionKey - key used for encrypting the password

value - the password, may be null

getPassword

public String getPassword(String key,
                          String encryptionKey)
                   throws InvalidSettingsException

Returns a decrypted password. If no password is stored under the key an exception is thrown.

Specified by:

getPassword in interface ConfigBaseRO

Parameters:

key - the key, must not be null

encryptionKey - key used for encrypting the password

Returns:

a decrypted password, may be null

Throws:

InvalidSettingsException - if no password for the given key exists

getPassword

public String getPassword(String key,
                          String encryptionKey,
                          String def)

Returns a decrypted password. If no password is stored under the key the given default is returned instead. The default value is not decrypted, it's returned as provided.

Specified by:

getPassword in interface ConfigBaseRO

Parameters:

key - the key, must not be null

encryptionKey - key used for encrypting the password

def - the (decrypted) default value

Returns:

a decrypted password, may be null

addTransientString

public void addTransientString(String key,
                               String value)

Adds a 'transient' string to this settings tree. A transient string is usually a password that should be kept only in main memory and never saved to disc. Consequently, when a settings object is read from disc the string will be missing (null).

Specified by:

addTransientString in interface ConfigBaseWO

Parameters:

key - the key for lookup

value - that value (password)

Since:

5.3

See Also:

ConfigBaseRO.getTransientString(String)

getTransientString

public String getTransientString(String key)

Returns a transient string if present or null if no longer available (setting restored from disc).

Specified by:

getTransientString in interface ConfigBaseRO

Parameters:

key - the key, must not be null

Returns:

that string or null.

Since:

5.3

See Also:

ConfigBaseWO.addTransientString(String, String)