Configuration (Commons)

java.lang.Object
- com.lf.commons.config.Configuration

Direct Known Subclasses:

I18NConfiguration, JDBCConfiguration, SQLConfiguration
```
public class Configuration
extends java.lang.Object
```
Manages a set of variable value pairs for common configuration purposes.
This class provides functionality close to the java.util.Properties class but without some of its limitations while keeping full compatibility. For instance this class is capable of using different encodings, not only the ISO-8859-1 Unicode Escapes. A special encoding can be specified by adding a special header comment called a directive. You can use any of the standard JDK/JRE encodings like UTF-8, ISO 8859-1 pretty much as for XML files. Due to compatibility of Configuration and Properties also the ISO-8859-1 Unicode Escapes are supported as well. In order to make a difference from the Properties class the managed items are called variables instead of properties. Normally Properties use the file suffix .properties while the Configuration class prefers .conf. This makes clear for a programmer which class to use for configuration/properties files. Whenever there is a need for Properties compatibility you should use .properties as file extension. If you need special features of Configuration then you should prefer .conf. But keep in mind, that .conf files may not be compatible with Properties since the features like the UTF-8 encoding are not supported by Properties. Files ending with .properties should always apply fully to the Properties file format.
The default handlers are instantiated at JVM startup when the handler classes are installed. All default handlers provide a getSharedInstance() method to get these shared instances which are also used by this class. If you need a specialized handler then simply add it to the handler cache, perhaps you like to overwrite one of the default handlers as well. Remember that null objects can be stored without problems by adding the string "null". If your program wants to store the string "null" this must be escaped somehow so that the getter method does not return a null object reference.

Since:

1.5

Version:

$Revision: 1.28 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`clearBeforeRead` Clear existing variables before new data is read (default is `true`)?
`protected java.lang.String`	`comment` The header comment for written files, default is no comment.
`protected java.lang.String`	`compression` The currently used file compression algorithm, default is `COMPRESSION_UNCOMPRESSED`.
`static java.lang.String`	`COMPRESSION_DEFLATED` Configuration files shall be stored DEFLATED.
`static java.lang.String`	`COMPRESSION_GZIPPED` Configuration files shall be stored GZIPped.
`static java.lang.String`	`COMPRESSION_UNCOMPRESSED` Configuration files shall be stored with no compression.
`protected java.lang.String`	`encoding` Represents the current file encoding, default is `ENCODING_ISO_8859_1_UNICODE_ESCAPES`.
`static java.lang.String`	`ENCODING_ISO_8859_1_UNICODE_ESCAPES` By default config files are written using this encoding.
`protected java.util.Hashtable<java.lang.String,TypeHandler>`	`handlers` Container holding the object type handlers for `set`/`get`.
`protected java.util.Hashtable<java.lang.String,java.lang.String>`	`hash` Container holding all locally managed variable value pairs.
`protected boolean`	`sorting` Shall written files be sorted alphabetically by variable names?

Constructor Summary

Constructors
Constructor and Description
`Configuration()` Constructor which simple initialization functionality.
`Configuration(boolean handlers)` Constructor that may not install the default type handlers.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()` Deletes all variable value pairs from the internal container.
`boolean`	`contains(java.lang.String variable)` Tests the existence of a specific variable in the `Hashtable`.
`boolean`	`equals(java.lang.Object obj)` Indicates whether some other object is "equal to" this one.
`protected void`	`finalize()` Cares for proper cleanup after releasing the object.
`boolean`	`getBoolean(java.lang.String variable)` Gets the `boolean` value of a variable.
`boolean`	`getBoolean(java.lang.String variable, boolean fallback)` Gets the `boolean` value of a variable.
`byte`	`getByte(java.lang.String variable)` Gets the `byte` value of a variable.
`byte`	`getByte(java.lang.String variable, byte fallback)` Gets the `byte` value of a variable.
`java.util.Hashtable<java.lang.String,java.lang.String>`	`getCache()` Provides the currently managed variables (handle with care).
`char`	`getChar(java.lang.String variable)` Gets the `char` value of a variable.
`char`	`getChar(java.lang.String variable, char fallback)` Gets the `char` value of a variable.
`boolean`	`getClearBeforeRead()` Provides the info if the cache is cleared before new data is read.
`java.lang.String`	`getComment()` Returns the compression algorithm for written files.
`java.lang.String`	`getCompression()` Returns the compression algorithm for written files.
`double`	`getDouble(java.lang.String variable)` Gets the `double` value of a variable.
`double`	`getDouble(java.lang.String variable, double fallback)` Gets the `double` value of a variable.
`java.lang.String`	`getEncoding()` Returns the current encoding used for written files.
`float`	`getFloat(java.lang.String variable)` Gets the `float` value of a variable.
`float`	`getFloat(java.lang.String variable, float fallback)` Gets the `float` value of a variable.
`TypeHandler`	`getHandler(java.lang.Class clazz)` Returns the installed handler for objects if such is installed.
`TypeHandler`	`getHandler(java.lang.String type)` Returns the installed handler for specific objects if such is installed.
`java.util.Hashtable<java.lang.String,TypeHandler>`	`getHandlers()` Provides the currently managed type handlers (handle with care).
`int`	`getInt(java.lang.String variable)` Gets the `int` value of a variable.
`int`	`getInt(java.lang.String variable, int fallback)` Gets the `int` value of a variable.
`long`	`getLong(java.lang.String variable)` Gets the `long` value of a variable.
`long`	`getLong(java.lang.String variable, long fallback)` Gets the `long` value of a variable.
`java.lang.Object`	`getObject(java.lang.String variable, java.lang.Class clazz)` Convenience method calling `get(variable, clazz.getName())`.
`java.lang.Object`	`getObject(java.lang.String variable, java.lang.Class clazz, java.lang.Object fallback)` Convenience method calling `get(variable, clazz.getName(), fallback)`.
`java.lang.Object`	`getObject(java.lang.String variable, java.lang.String type)` Gets the value of a variable in the desired object type (no primitives).
`java.lang.Object`	`getObject(java.lang.String variable, java.lang.String type, java.lang.Object fallback)` Gets the value of a variable in the desired object type (no primitives).
`short`	`getShort(java.lang.String variable)` Gets the `short` value of a variable.
`short`	`getShort(java.lang.String variable, short fallback)` Gets the `short` value of a variable.
`java.lang.Class[]`	`getSupportedClassTypes()` Provides the classes (types) of the supported handlers.
`java.lang.String[]`	`getSupportedTypes()` Provides the class names (types) of the supported handlers.
`protected java.lang.String`	`getVariable(java.lang.String variable)` Gets the desired variable as `String` representation from the internal cache.
`java.util.Enumeration<java.lang.String>`	`getVariables()` Provides the currently managed variable names.
`boolean`	`isEmpty()` Provides the info if the variables container is currently empty.
`boolean`	`isOrdered()` Provides the info if this configuration keeps the values in the order they were added.
`boolean`	`isSecure()` Provides the info if this configuration stored its values PGP encrypted.
`boolean`	`isSorting()` Returns the compression algorithm for written files.
`boolean`	`isTypeSupported(java.lang.Class clazz)` Checks whether the given variable type is supported by the configuration.
`boolean`	`isTypeSupported(java.lang.String type)` Checks whether the given variable type is supported by the configuration.
`void`	`read(java.io.File file)` Reads the variable value pairs from the specified file.
`void`	`read(org.apache.commons.vfs2.FileObject file)` Reads the variable value pairs from the specified VFS file.
`void`	`read(java.io.InputStream istream)` Reads the variable value pairs from the specified stream.
`void`	`read(java.lang.String filename)` Reads the variable value pairs from the specified file.
`static java.lang.String`	`readConvertProperties(java.lang.String theString)`
`void`	`readXML(java.io.File file)` Reads the variable value pairs from the specified XML file.
`void`	`readXML(org.apache.commons.vfs2.FileObject file)` Reads the variable value pairs from the specified VFS XML file.
`void`	`readXML(java.io.InputStream istream)` Reads the variable value pairs from the specified XML stream.
`void`	`readXML(java.lang.String filename)` Reads the variable value pairs from the specified XML file.
`boolean`	`remove(java.lang.String variable)` Removes a variable from the cache.
`boolean`	`removeAllHandlers()` Removes all installed handlers from the internal container.
`boolean`	`removeHandler(java.lang.Class clazz)` Removes the specified handler from the internal container if it exists.
`boolean`	`removeHandler(java.lang.String type)` Removes the specified handler from the internal container if it exists.
`int`	`removeStartsWith(java.lang.String prefix)` Removes all variables with a certain prefix from the cache.
`boolean`	`setBoolean(java.lang.String variable, boolean value)` Sets the `boolean` value of a variable.
`boolean`	`setByte(java.lang.String variable, byte value)` Sets the `byte` value of a variable.
`boolean`	`setChar(java.lang.String variable, char value)` Sets the `char` value of a variable.
`void`	`setClearBeforeRead(boolean clear)` Clear existing variables before new data is read (default is `true`)?
`void`	`setComment(java.lang.String comment)` Sets the header comment for written files.
`void`	`setCompression(java.lang.String compression)` Sets the compression algorithm for written files.
`boolean`	`setDouble(java.lang.String variable, double value)` Sets the `double` value of a variable.
`void`	`setEncoding(java.lang.String encoding)` Sets the encoding for written files.
`boolean`	`setFloat(java.lang.String variable, float value)` Sets the `float` value of a variable.
`boolean`	`setHandler(TypeHandler newhandler)` Sets a new handler for specific objects.
`boolean`	`setInt(java.lang.String variable, int value)` Sets the `int` value of a variable.
`boolean`	`setLong(java.lang.String variable, long value)` Sets the `long` value of a variable.
`boolean`	`setObject(java.lang.String variable, java.lang.Object value)` Sets the variable value with a special handler if the variable type is supported.
`void`	`setOrdered(boolean enable)` Makes this configuration to store its values in the order they were added.
`void`	`setSecure(CryptoManager manager, java.lang.String keyuserid)` Makes this configuration to store its values securely (PGP encrypted).
`void`	`setSecure(PassphraseProvider provider, java.lang.String keyuserid)` Makes this configuration to store its values securely (AES encrypted).
`boolean`	`setShort(java.lang.String variable, short value)` Sets the `short` value of a variable.
`void`	`setSorting(boolean sorting)` Shall written files be sorted alphabetically by variable name?
`protected boolean`	`setVariable(java.lang.String variable, java.lang.String value)` Does the `String`-based adding of variable value pairs to the internal container.
`int`	`size()` Returns the number of currently managed variables.
`void`	`write(java.io.File file)` Saves the variable value pairs into the specified file.
`void`	`write(org.apache.commons.vfs2.FileObject file)` Saves the variable value pairs into the specified VFS file.
`void`	`write(java.io.OutputStream ostream)` Saves the variable value pairs with the specified byte based output stream.
`void`	`write(java.lang.String filename)` Saves the variable value pairs into the specified file.
`void`	`writeXML(java.io.File file)` Saves the variable value pairs into the specified XML file.
`void`	`writeXML(org.apache.commons.vfs2.FileObject file)` Saves the variable value pairs into the specified VFS XML file.
`void`	`writeXML(java.io.OutputStream ostream)` Saves the variable value pairs with the specified byte based XML output stream.
`void`	`writeXML(java.lang.String filename)` Saves the variable value pairs into the specified XML file.

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

- Field Detail
  - COMPRESSION_UNCOMPRESSED
```
public static final java.lang.String COMPRESSION_UNCOMPRESSED
```
    Configuration files shall be stored with no compression.
    
    See Also:
    Constant Field Values
  - COMPRESSION_GZIPPED
```
public static final java.lang.String COMPRESSION_GZIPPED
```
    Configuration files shall be stored GZIPped.
    
    See Also:
    Constant Field Values
  - COMPRESSION_DEFLATED
```
public static final java.lang.String COMPRESSION_DEFLATED
```
    Configuration files shall be stored DEFLATED.
    
    See Also:
    Constant Field Values
  - ENCODING_ISO_8859_1_UNICODE_ESCAPES
```
public static final java.lang.String ENCODING_ISO_8859_1_UNICODE_ESCAPES
```
    By default config files are written using this encoding.
    
    See Also:
    Constant Field Values
  - hash
```
protected java.util.Hashtable<java.lang.String,java.lang.String> hash
```
    Container holding all locally managed variable value pairs.
  - handlers
```
protected java.util.Hashtable<java.lang.String,TypeHandler> handlers
```
    Container holding the object type handlers for set/get.
  - compression
```
protected java.lang.String compression
```
    The currently used file compression algorithm, default is COMPRESSION_UNCOMPRESSED.
  - encoding
```
protected java.lang.String encoding
```
    Represents the current file encoding, default is ENCODING_ISO_8859_1_UNICODE_ESCAPES.
  - comment
```
protected java.lang.String comment
```
    The header comment for written files, default is no comment.
  - sorting
```
protected boolean sorting
```
    Shall written files be sorted alphabetically by variable names?
  - clearBeforeRead
```
protected boolean clearBeforeRead
```
    Clear existing variables before new data is read (default is true)?
- Constructor Detail
  - Configuration
```
public Configuration()
```
    Constructor which simple initialization functionality.
    Default settings are COMPRESSION_UNCOMPRESSED as compression, ENCODING_ISO_8859_1_UNICODE_ESCAPES as encoding, empty comment for written files, and sorting disabled. All default handlers are installed via shared instances.
    
    Since:
    
    1.5
  - Configuration
```
public Configuration(boolean handlers)
```
    Constructor that may not install the default type handlers.
    
    Parameters:
    handlers - Add default type handlers?
    Since:
    
    1.5
- Method Detail
  - finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
    Cares for proper cleanup after releasing the object.
    Especially the containers are emptied properly in order to help the garbage collecting.
    
    Overrides:
    
    finalize in class java.lang.Object
    
    Throws:
    
    java.lang.Throwable
    Since:
    
    1.5
  - clear
```
public void clear()
```
    Deletes all variable value pairs from the internal container.
    Remember that only the variables but not the handlers are touched by this method. Use the removeAllHandlers() method to clear the handlers cache.
    
    Since:
    
    1.5
  - setVariable
```
protected boolean setVariable(java.lang.String variable,
                  java.lang.String value)
```
    Does the String-based adding of variable value pairs to the internal container.
    If the passed variable does already exist, that value will be overwritten with the new one. This method should only be called by sub-classes and handler instances. Any input data must be converted into regular Unicode String values. While the variable names normally are String objects, the values might need to be converted first. For primitive types this is done by the Configuration class itself or by the installed handlers.
    
    Parameters:
    variable - The variable name
    value - The value of the variable also as String
    
    Returns:
    Did the setting work?
    Since:
    
    1.5
  - getVariable
```
protected java.lang.String getVariable(java.lang.String variable)
```
    Gets the desired variable as String representation from the internal cache.
    
    Parameters:
    variable - The variable name
    
    Returns:
    The value of the variable also as String, maybe null
    Since:
    
    1.5
  - setHandler
```
public boolean setHandler(TypeHandler newhandler)
```
    Sets a new handler for specific objects.
    If the given handler does already exist for this type it will be overwritten. This allows users of this class to provide their own type handlers instead of using the default ones.
    
    Parameters:
    newhandler - The new handler to be added (or be overwritten)
    
    Returns:
    Did the setting work?
    Since:
    
    1.5
  - getHandler
```
public TypeHandler getHandler(java.lang.String type)
```
    Returns the installed handler for specific objects if such is installed.
    
    Parameters:
    type - The desired type of objects
    
    Returns:
    Installed handler or null if no such handler is installed
    Since:
    
    1.5
    
    See Also:
    getHandler(Class)
  - getHandler
```
public TypeHandler getHandler(java.lang.Class clazz)
```
    Returns the installed handler for objects if such is installed.
    
    Parameters:
    clazz - The desired class type of objects
    
    Returns:
    Installed handler or null if no such handler is installed
    Since:
    
    1.5
    
    See Also:
    getHandler(String)
  - removeHandler
```
public boolean removeHandler(java.lang.String type)
```
    Removes the specified handler from the internal container if it exists.
    
    Parameters:
    type - The type of the handler to be removed
    
    Returns:
    Did the removal work?
    Since:
    
    1.5
  - removeHandler
```
public boolean removeHandler(java.lang.Class clazz)
```
    Removes the specified handler from the internal container if it exists.
    
    Parameters:
    clazz - The class type of the handler to be removed
    
    Returns:
    Did the removal work?
    Since:
    
    1.5
  - removeAllHandlers
```
public boolean removeAllHandlers()
```
    Removes all installed handlers from the internal container.
    
    Returns:
    Did the removal work?
    Since:
    
    1.5
  - read
```
public void read(java.lang.String filename)
          throws java.io.IOException
```
    Reads the variable value pairs from the specified file.
    Here the content of the internally managed Hashtable may be read from a file. Error is reported via IOException. This is convenience method in addition to read(InputStream) in order to make programmer's life easier.
    
    Parameters:
    filename - Name of the file to store data in
    
    Throws:
    
    java.io.IOException - An I/O error occurred
    
    java.lang.NullPointerException - Given file name was null
    
    java.io.FileNotFoundException - Given file does not exist
    Since:
    
    1.5
  - read
```
public void read(java.io.File file)
          throws java.io.IOException
```
    Reads the variable value pairs from the specified file.
    Here the content of the internally managed Hashtable may be read from a file. Error is reported via IOException. This is convenience method in addition to read(InputStream) in order to make programmer's life easier.
    
    Parameters:
    file - File to store data in
    
    Throws:
    
    java.io.IOException - An I/O error occurred
    
    java.lang.NullPointerException - Given file name was null
    
    java.io.FileNotFoundException - Given file does not exist
    Since:
    
    1.5
  - read
```
public void read(org.apache.commons.vfs2.FileObject file)
          throws java.io.IOException
```
    Reads the variable value pairs from the specified VFS file.
    Here the content of the internally managed Hashtable may be read from a file. Error is reported via IOException. This is convenience method in addition to read(InputStream) in order to make programmer's life easier.
    
    Parameters:
    file - VFS file to store data in
    
    Throws:
    
    java.io.IOException - An I/O error occurred
    
    java.lang.NullPointerException - Given file name was null
    
    org.apache.commons.vfs2.FileSystemException - Given file does not exist
    Since:
    
    1.5
  - read
```
public void read(java.io.InputStream istream)
          throws java.io.IOException
```
    Reads the variable value pairs from the specified stream.
    Here the content of the internally managed Hashtable may be read from a stream. Error is reported via IOException. This is the low-level functionality repsonsible for the reading. The optional compression is auto-detected by the routine and then set for the configuration so writing the config later will use the same compression. The same is the case for the encoding which is ISO 8859-1 with Unicode Escapes by default in order to keep compatibility with the Properties class. If a special header entry for the encoding is found this is used for the deserialization of the configuration. Also the encoding is set for the configuration so writing the config later will use the same encoding.
    
    Parameters:
    istream - The byte based stream to be read from, never closed
    
    Throws:
    
    java.io.IOException - An I/O error occurred
    
    java.lang.NullPointerException - Given file name was null
    
    java.io.UnsupportedEncodingException - Character encoding (charset) was not valid
    Since:
    
    1.5
  - readXML
```
public void readXML(java.lang.String filename)
             throws java.io.IOException
```
    Reads the variable value pairs from the specified XML file.
    Here the content of the internally managed Hashtable may be read from a file. Error is reported via IOException. This is convenience method in addition to read(InputStream) in order to make programmer's life easier.
    
    Parameters:
    filename - Name of the XML file to import data
    
    Throws:
    
    java.io.IOException - An I/O error occurred
    
    java.lang.NullPointerException - Given file name was null
    
    java.io.FileNotFoundException - Given file does not exist
    Since:
    
    1.5
  - readXML
```
public void readXML(java.io.File file)
             throws java.io.IOException
```
    Reads the variable value pairs from the specified XML file.
    Here the content of the internally managed Hashtable may be read from a file. Error is reported via IOException. This is convenience method in addition to read(InputStream) in order to make programmer's life easier.
    
    Parameters:
    file - XML file to import data
    
    Throws:
    
    java.io.IOException - An I/O error occurred
    
    java.lang.NullPointerException - Given file name was null
    
    java.io.FileNotFoundException - Given file does not exist
    Since:
    
    1.5
  - readXML
```
public void readXML(org.apache.commons.vfs2.FileObject file)
             throws java.io.IOException
```
    Reads the variable value pairs from the specified VFS XML file.
    Here the content of the internally managed Hashtable may be read from a file. Error is reported via IOException. This is convenience method in addition to read(InputStream) in order to make programmer's life easier.
    
    Parameters:
    file - VFS XML file to import data
    
    Throws:
    
    java.io.IOException - An I/O error occurred
    
    java.lang.NullPointerException - Given file name was null
    
    org.apache.commons.vfs2.FileSystemException - Given file does not exist
    Since:
    
    1.5
  - readXML
```
public void readXML(java.io.InputStream istream)
             throws java.io.IOException
```
    Reads the variable value pairs from the specified XML stream.
    Here the content of the internally managed Hashtable may be read from a stream. Error is reported via IOException. This is the low-level functionality repsonsible for the reading. The optional compression is auto-detected by the routine and then set for the configuration so writing the config later will use the same compression. The same is the case for the encoding which is UTF-8 Unicode encoding by default in order to keep compatibility with the Properties class. If a special header entry for the encoding is found this is used for the deserialization of the configuration. Also the encoding is set for the configuration so writing the config later will use the same encoding.
    
    Parameters:
    istream - The byte based XML stream to be read from, never closed
    
    Throws:
    
    java.io.IOException - An I/O error occurred
    
    java.lang.NullPointerException - Given stream was null
    
    java.lang.IllegalArgumentException - XML data error
    Since:
    
    1.5
  - readConvertProperties
```
public static java.lang.String readConvertProperties(java.lang.String theString)
```
  - write
```
public void write(java.lang.String filename)
           throws java.io.IOException
```
    Saves the variable value pairs into the specified file.
    Here the content of the internally managed Hashtable may be stored to a file. Error is reported via IOException. This is convenience method in addition to write(OutputStream) in order to make programmer's life easier.
    We don't test here if the given file does exist because we then would have to let the user choose if he/she wants to override it or not. For that we would have to integrate GUI functionality and it's always better to separate this from other functionality. You can do this testing before calling this method with help of File.exists().
    
    Parameters:
    filename - Name of the file to store data in
    
    Throws:
    
    java.io.IOException - An I/O error occurred
    Since:
    
    1.5
  - write
```
public void write(java.io.File file)
           throws java.io.IOException
```
    Saves the variable value pairs into the specified file.
    Here the content of the internally managed Hashtable may be stored to a file. Error is reported via IOException. This is convenience method in addition to write(OutputStream) in order to make programmer's life easier.
    We don't test here if the given file does exist because we then would have to let the user choose if he/she wants to override it or not. For that we would have to integrate GUI functionality and it's always better to separate this from other functionality. You can do this testing before calling this method with help of File.exists().
    
    Parameters:
    file - File to store data in
    
    Throws:
    
    java.io.IOException - An I/O error occurred
    Since:
    
    1.5
  - write
```
public void write(org.apache.commons.vfs2.FileObject file)
           throws java.io.IOException
```
    Saves the variable value pairs into the specified VFS file.
    Here the content of the internally managed Hashtable may be stored to a file. Error is reported via IOException. This is convenience method in addition to write(OutputStream) in order to make programmer's life easier.
    We don't test here if the given file does exist because we then would have to let the user choose if he/she wants to override it or not. For that we would have to integrate GUI functionality and it's always better to separate this from other functionality. You can do this testing before calling this method with help of File.exists().
    
    Parameters:
    file - VFS file to store data in
    
    Throws:
    
    java.io.IOException - An I/O error occurred
    
    org.apache.commons.vfs2.FileSystemException - An VFS error occurred
    Since:
    
    1.5
  - write
```
public void write(java.io.OutputStream ostream)
           throws java.io.IOException
```
    Saves the variable value pairs with the specified byte based output stream.
    Here the content of the internally managed Hashtable may be stored to a file. Error is reported via IOException. The stream is not closed after the writing is finished. The given output stream could be of any of the common types, but also keep in mind that according to the current compression setting the stream will be filled already with either GZIPPED or DEFLATED binary data. An additional compression stream is not necessary in these cases. Use the setCompression() method to adjust this setting. The normal mode is to write UNCOMPRESSED to the stream. If the encoding is set to ENCODING_ISO_8859_1_UNICODE_ESCAPES and a variable value contains the new line character then all appearances are replaced by the sequence '\n'. These sequences are later restored automatically so that it is possible to deal with multi-line strings.
    
    Parameters:
    ostream - Byte based output stream with a certain encoding
    
    Throws:
    
    java.io.IOException - An I/O error occurred
    Since:
    
    1.5
  - writeXML
```
public void writeXML(java.lang.String filename)
              throws java.io.IOException
```
    Saves the variable value pairs into the specified XML file.
    Here the content of the internally managed Hashtable may be stored to a file. Error is reported via IOException. This is convenience method in addition to writeXML(OutputStream) in order to make programmer's life easier.
    We don't test here if the given file does exist because we then would have to let the user choose if he/she wants to override it or not. For that we would have to integrate GUI functionality and it's always better to separate this from other functionality. You can do this testing before calling this method with help of File.exists().
    
    Parameters:
    filename - Name of the XML file to store data in
    
    Throws:
    
    java.io.IOException - An I/O error occurred
    Since:
    
    1.5
  - writeXML
```
public void writeXML(java.io.File file)
              throws java.io.IOException
```
    Saves the variable value pairs into the specified XML file.
    Here the content of the internally managed Hashtable may be stored to a file. Error is reported via IOException. This is convenience method in addition to writeXML(OutputStream) in order to make programmer's life easier.
    We don't test here if the given file does exist because we then would have to let the user choose if he/she wants to override it or not. For that we would have to integrate GUI functionality and it's always better to separate this from other functionality. You can do this testing before calling this method with help of File.exists().
    
    Parameters:
    file - XML file to store data in
    
    Throws:
    
    java.io.IOException - An I/O error occurred
    Since:
    
    1.5
  - writeXML
```
public void writeXML(org.apache.commons.vfs2.FileObject file)
              throws java.io.IOException
```
    Saves the variable value pairs into the specified VFS XML file.
    Here the content of the internally managed Hashtable may be stored to a file. Error is reported via IOException. This is convenience method in addition to writeXML(OutputStream) in order to make programmer's life easier.
    We don't test here if the given file does exist because we then would have to let the user choose if he/she wants to override it or not. For that we would have to integrate GUI functionality and it's always better to separate this from other functionality. You can do this testing before calling this method with help of File.exists().
    
    Parameters:
    file - VFS XML file to store data in
    
    Throws:
    
    java.io.IOException - An I/O error occurred
    
    org.apache.commons.vfs2.FileSystemException - An VFS error occurred
    Since:
    
    1.5
  - writeXML
```
public void writeXML(java.io.OutputStream ostream)
              throws java.io.IOException
```
    Saves the variable value pairs with the specified byte based XML output stream.
    Here the content of the internally managed Hashtable may be stored to a file. Error is reported via IOException. The stream is not closed after the writing is finished. If the encoding is set to ENCODING_ISO_8859_1_UNICODE_ESCAPES then UTF-8 is used as XML encoding in order to be fully compatible with the Properties class. The Unicode escapes make no sense for XML since we are capable of writing line breaks and other special characters directly as element content. Also we would have no chance to mark a file as being encoded with Unicode escapes since this is no valid XML charset encoding. We would have to use "ISO-8859-1" instead but then there would be no chance to distinguish between normal ISO 8859-1 and Unicode escaped content since both use the same encoding identifier.
    
    Parameters:
    ostream - Byte based XML output stream with a certain encoding
    
    Throws:
    
    java.io.IOException - An I/O error occurred
    Since:
    
    1.5
  - setByte
```
public boolean setByte(java.lang.String variable,
              byte value)
```
    Sets the byte value of a variable.
    If the variable already exists it will be overwritten.
    
    Parameters:
    variable - Name of the variable to be stored
    value - Variable value
    
    Returns:
    Did it work?
    Since:
    
    1.5
  - setShort
```
public boolean setShort(java.lang.String variable,
               short value)
```
    Sets the short value of a variable.
    If the variable already exists it will be overwritten.
    
    Parameters:
    variable - Name of the variable to be stored
    value - Variable value
    
    Returns:
    Did it work?
    Since:
    
    1.5
  - setInt
```
public boolean setInt(java.lang.String variable,
             int value)
```
    Sets the int value of a variable.
    If the variable already exists it will be overwritten.
    
    Parameters:
    variable - Name of the variable to be stored
    value - Variable value
    
    Returns:
    Did it work?
    Since:
    
    1.5
  - setLong
```
public boolean setLong(java.lang.String variable,
              long value)
```
    Sets the long value of a variable.
    If the variable already exists it will be overwritten.
    
    Parameters:
    variable - Name of the variable to be stored
    value - Variable value
    
    Returns:
    Did it work?
    Since:
    
    1.5
  - setChar
```
public boolean setChar(java.lang.String variable,
              char value)
```
    Sets the char value of a variable.
    If the variable already exists it will be overwritten.
    
    Parameters:
    variable - Name of the variable to be stored
    value - Variable value
    
    Returns:
    Did it work?
    Since:
    
    1.5
  - setFloat
```
public boolean setFloat(java.lang.String variable,
               float value)
```
    Sets the float value of a variable.
    If the variable already exists it will be overwritten.
    
    Parameters:
    variable - Name of the variable to be stored
    value - Variable value
    
    Returns:
    Did it work?
    Since:
    
    1.5
  - setDouble
```
public boolean setDouble(java.lang.String variable,
                double value)
```
    Sets the double value of a variable.
    If the variable already exists it will be overwritten.
    
    Parameters:
    variable - Name of the variable to be stored
    value - Variable value
    
    Returns:
    Did it work?
    Since:
    
    1.5
  - setBoolean
```
public boolean setBoolean(java.lang.String variable,
                 boolean value)
```
    Sets the boolean value of a variable.
    If the variable already exists it will be overwritten.
    
    Parameters:
    variable - Name of the variable to be stored
    value - Variable value
    
    Returns:
    Did it work?
    Since:
    
    1.5
  - setObject
```
public boolean setObject(java.lang.String variable,
                java.lang.Object value)
```
    Sets the variable value with a special handler if the variable type is supported.
    Here all object instances may be stored which are supported by any of the installed type handlers. If you want to store own data types within configurations simply set an appropriate handlers implementing the TypeHandler interface and call this method. You may also overwrite any of the default type handlers (e.g. for java.lang.String) if they do not fulfill your special needs. Simply set the new handler, the installed one will be substituted automatically.
    You may pass a null value reference in order to have the variable be part of the configuration anyway. If you do so the string null will be written to the configuration cache and then decoded as null reference again if you call the get() method later. This behaviour seems to be more convenient for using this class since there is no need for special exception handling while adding variables.
    Remember that it's up to the handler to decide whether the variable should be store as a single variable or if it's better to multiplex the variable into multiple variables. In addition to that a variable value can be stored as binary embedded in some encoded format like UUENCODE. Passwords could be stored in encrypted format like PGP as well.
    
    Parameters:
    variable - Name of the variable to be stored
    value - Variable value
    
    Returns:
    Did it work?
    
    Throws:
    
    java.lang.IllegalArgumentException - Error indication
    Since:
    
    1.5value
    
    See Also:
    TypeHandler
  - isTypeSupported
```
public boolean isTypeSupported(java.lang.String type)
```
    Checks whether the given variable type is supported by the configuration.
    
    Parameters:
    type - Variable type to be checked
    
    Returns:
    Does the configuration support the given type?
    
    Throws:
    
    java.lang.NullPointerException - Given type was null
    Since:
    
    1.5
    
    See Also:
    isTypeSupported(Class)
  - isTypeSupported
```
public boolean isTypeSupported(java.lang.Class clazz)
```
    Checks whether the given variable type is supported by the configuration.
    
    Parameters:
    clazz - Variable type to be checked
    
    Returns:
    Does the configuration support the given type?
    
    Throws:
    
    java.lang.NullPointerException - Given class was null
    Since:
    
    1.5
    
    See Also:
    isTypeSupported(String)
  - getSupportedTypes
```
public java.lang.String[] getSupportedTypes()
```
    Provides the class names (types) of the supported handlers.
    
    Returns:
    Array with supported class names (types), possibly empty
    Since:
    
    1.5
    
    See Also:
    getSupportedClassTypes()
  - getSupportedClassTypes
```
public java.lang.Class[] getSupportedClassTypes()
```
    Provides the classes (types) of the supported handlers.
    
    Returns:
    Array with supported class names (types), possibly empty
    Since:
    
    1.5
    
    See Also:
    getSupportedTypes()
  - getByte
```
public byte getByte(java.lang.String variable)
             throws java.lang.IllegalArgumentException
```
    Gets the byte value of a variable.
    
    Parameters:
    variable - Name of the variable
    
    Returns:
    Value of the desired variable
    
    Throws:
    
    java.lang.IllegalArgumentException - Error indication
    Since:
    
    1.5
  - getByte
```
public byte getByte(java.lang.String variable,
           byte fallback)
```
    Gets the byte value of a variable.
    
    Parameters:
    variable - Name of the variable
    fallback - The default value
    
    Returns:
    Value of the desired variable
    Since:
    
    1.6
  - getShort
```
public short getShort(java.lang.String variable)
               throws java.lang.IllegalArgumentException
```
    Gets the short value of a variable.
    
    Parameters:
    variable - Name of the variable
    
    Returns:
    Value of the desired variable
    
    Throws:
    
    java.lang.IllegalArgumentException - Error indication
    Since:
    
    1.5
  - getShort
```
public short getShort(java.lang.String variable,
             short fallback)
```
    Gets the short value of a variable.
    
    Parameters:
    variable - Name of the variable
    fallback - The default value
    
    Returns:
    Value of the desired variable
    Since:
    
    1.6
  - getInt
```
public int getInt(java.lang.String variable)
           throws java.lang.IllegalArgumentException
```
    Gets the int value of a variable.
    
    Parameters:
    variable - Name of the variable
    
    Returns:
    Value of the desired variable
    
    Throws:
    
    java.lang.IllegalArgumentException - Error indication
    Since:
    
    1.5
  - getInt
```
public int getInt(java.lang.String variable,
         int fallback)
```
    Gets the int value of a variable.
    
    Parameters:
    variable - Name of the variable
    fallback - The default value
    
    Returns:
    Value of the desired variable
    Since:
    
    1.6
  - getLong
```
public long getLong(java.lang.String variable)
             throws java.lang.IllegalArgumentException
```
    Gets the long value of a variable.
    
    Parameters:
    variable - Name of the variable
    
    Returns:
    Value of the desired variable
    
    Throws:
    
    java.lang.IllegalArgumentException - Error indication
    Since:
    
    1.5
  - getLong
```
public long getLong(java.lang.String variable,
           long fallback)
```
    Gets the long value of a variable.
    
    Parameters:
    variable - Name of the variable
    fallback - The default value
    
    Returns:
    Value of the desired variable
    Since:
    
    1.6
  - getChar
```
public char getChar(java.lang.String variable)
             throws java.lang.IllegalArgumentException
```
    Gets the char value of a variable.
    
    Parameters:
    variable - Name of the variable
    
    Returns:
    Value of the desired variable
    
    Throws:
    
    java.lang.IllegalArgumentException - Error indication
    Since:
    
    1.5
  - getChar
```
public char getChar(java.lang.String variable,
           char fallback)
```
    Gets the char value of a variable.
    
    Parameters:
    variable - Name of the variable
    fallback - The default value
    
    Returns:
    Value of the desired variable
    Since:
    
    1.6
  - getFloat
```
public float getFloat(java.lang.String variable)
               throws java.lang.IllegalArgumentException
```
    Gets the float value of a variable.
    
    Parameters:
    variable - Name of the variable
    
    Returns:
    Value of the desired variable
    
    Throws:
    
    java.lang.IllegalArgumentException - Error indication
    Since:
    
    1.5
  - getFloat
```
public float getFloat(java.lang.String variable,
             float fallback)
```
    Gets the float value of a variable.
    
    Parameters:
    variable - Name of the variable
    fallback - The default value
    
    Returns:
    Value of the desired variable
    Since:
    
    1.6
  - getDouble
```
public double getDouble(java.lang.String variable)
                 throws java.lang.IllegalArgumentException
```
    Gets the double value of a variable.
    
    Parameters:
    variable - Name of the variable
    
    Returns:
    Value of the desired variable
    
    Throws:
    
    java.lang.IllegalArgumentException - Error indication
    Since:
    
    1.5
  - getDouble
```
public double getDouble(java.lang.String variable,
               double fallback)
```
    Gets the double value of a variable.
    
    Parameters:
    variable - Name of the variable
    fallback - The default value
    
    Returns:
    Value of the desired variable
    Since:
    
    1.6
  - getBoolean
```
public boolean getBoolean(java.lang.String variable)
                   throws java.lang.IllegalArgumentException
```
    Gets the boolean value of a variable.
    
    Parameters:
    variable - Name of the variable
    
    Returns:
    Value of the desired variable
    
    Throws:
    
    java.lang.IllegalArgumentException - Error indication
    Since:
    
    1.5
  - getBoolean
```
public boolean getBoolean(java.lang.String variable,
                 boolean fallback)
```
    Gets the boolean value of a variable.
    
    Parameters:
    variable - Name of the variable
    fallback - The default value
    
    Returns:
    Value of the desired variable
    Since:
    
    1.6
  - getObject
```
public java.lang.Object getObject(java.lang.String variable,
                         java.lang.String type)
                           throws java.lang.IllegalArgumentException
```
    Gets the value of a variable in the desired object type (no primitives).
    Here all object instances may be acquired which are supported by any of the installed type handlers. If you want to get own data types from configurations simply set an appropriate handler implementing the TypeHandler interface and call this method. You may also overwrite any of the default type handlers (e.g. for java.lang.String) if they do not fulfill your special needs. Simply set the new handler, the installed one will be substituted automatically.
    You may receive a null value reference if either the variable does not exist or the null value was explicitely stored before. This behaviour seems to be more convenient for using this class since there is no need for special exception handling while adding variables.
    Remember that it's up to the handler to decide whether the variable should be store as a single variable or if it's better to multiplex the variable into multiple variables. In addition to that a variable value can be stored as binary embedded in some encoded format like UUENCODE. Passwords could be stored in encrypted format like PGP as well.
    Remember that null objects can be stored without problems by adding the string "null". If your program wants to store the string "null" this must be escaped somehow so that the getter method does not return a null object reference.
    
    Parameters:
    variable - Name of the desired variable
    type - Object type of the return value
    
    Returns:
    Value of the desired variable
    
    Throws:
    
    java.lang.IllegalArgumentException - Error indication
    Since:
    
    1.5
    
    See Also:
    getObject(String, Class)
  - getObject
```
public java.lang.Object getObject(java.lang.String variable,
                         java.lang.String type,
                         java.lang.Object fallback)
```
    Gets the value of a variable in the desired object type (no primitives).
    
    Parameters:
    variable - Name of the variable
    type - Object type of the return value
    fallback - The default value
    
    Returns:
    Value of the desired variable
    Since:
    
    1.6
  - getObject
```
public java.lang.Object getObject(java.lang.String variable,
                         java.lang.Class clazz)
                           throws java.lang.IllegalArgumentException
```
    Convenience method calling get(variable, clazz.getName()).
    
    Parameters:
    variable - Name of the desired variable
    clazz - Class type of the return value
    
    Returns:
    Value of the desired variable
    
    Throws:
    
    java.lang.IllegalArgumentException - Error indication
    Since:
    
    1.5
    
    See Also:
    getObject(String, String)
  - getObject
```
public java.lang.Object getObject(java.lang.String variable,
                         java.lang.Class clazz,
                         java.lang.Object fallback)
```
    Convenience method calling get(variable, clazz.getName(), fallback).
    
    Parameters:
    variable - Name of the variable
    clazz - Class type of the return value
    fallback - The default value
    
    Returns:
    Value of the desired variable
    Since:
    
    1.6
  - getVariables
```
public java.util.Enumeration<java.lang.String> getVariables()
```
    Provides the currently managed variable names.
    
    Returns:
    All keys (=variables)
    Since:
    
    1.5
  - getCache
```
public java.util.Hashtable<java.lang.String,java.lang.String> getCache()
```
    Provides the currently managed variables (handle with care).
    
    Returns:
    Original container with variable value pairs
    Since:
    
    1.5
  - getHandlers
```
public java.util.Hashtable<java.lang.String,TypeHandler> getHandlers()
```
    Provides the currently managed type handlers (handle with care).
    
    Returns:
    Original container with type handlers
    Since:
    
    1.6
  - setCompression
```
public void setCompression(java.lang.String compression)
```
    Sets the compression algorithm for written files.
    By default configuration files are written in uncompressed in full size. If you like your files become smaller use one of the supported compression algorithms, at the moment COMPRESSION_GZIPPED or COMPRESSION_DEFLATED.
    
    Parameters:
    compression - Compression algorithm, COMPRESSION_UNCOMPRESSED is default
    
    Throws:
    
    java.lang.IllegalArgumentException - The compression is not supported
    Since:
    
    1.5
  - getCompression
```
public java.lang.String getCompression()
```
    Returns the compression algorithm for written files.
    By default configuration files are written in uncompressed in full size. If you like your files become smaller use one of the supported compression algorithms, at the moment COMPRESSION_GZIPPED or COMPRESSION_DEFLATED.
    
    Returns:
    Compression algorithm, COMPRESSION_UNCOMPRESSED is default
    Since:
    
    1.5
  - setEncoding
```
public void setEncoding(java.lang.String encoding)
                 throws java.io.UnsupportedEncodingException
```
    Sets the encoding for written files.
    By default configuration files are written in just the same mode than the files written by the Properties class (Unicode escapes like ?). If you wish to reset to this default mode simply set the null reference then. If you like the export files be in another encoding like UTF-8 or ISO-8859-1, then pass the IANA charset name. The i18n package provides support for getting all the currently defined encodings (aka charsets).
    Remember that only the default encoding Unicode escapes properly handles the full character range 0-64K since some encodings like UTF-8 are not capable of encoding all available characters. The surrogate block D800 - DFFF is not converted by UTF-8 and others but only replaced by the '?' character (decimal 63). You will find a loss of information when you use such encodings with invalid character data. To avoid this situation always use the Unicode Escapes default encoding for both Properties and XML format.
    
    Parameters:
    encoding - The file encoding, ENCODING_ISO_8859_1_UNICODE_ESCAPES is default
    
    Throws:
    
    java.io.UnsupportedEncodingException - The given encoding is not supported by the JVM
    Since:
    
    1.5
  - getEncoding
```
public java.lang.String getEncoding()
```
    Returns the current encoding used for written files.
    By default configuration files are written in just the same mode than the files written by the Properties class (Unicode escapes like ?). The i18n package provides support for getting all the currently defined encodings (aka charsets).
    Remember that only the default encoding Unicode escapes properly handles the full character range 0-64K since some encodings like UTF-8 are not capable of encoding all available characters. The surrogate block D800 - DFFF is not converted by UTF-8 and others but only replaced by the '?' character (decimal 63). You will find a loss of information when you use such encodings with invalid character data. To avoid this situation always use the Unicode Escapes default encoding for both Properties and XML format.
    
    Returns:
    The file encoding, ENCODING_ISO_8859_1_UNICODE_ESCAPES is default
    Since:
    
    1.5
  - setComment
```
public void setComment(java.lang.String comment)
```
    Sets the header comment for written files.
    By default configuration files are written with no comment in the header. If you like your files to have a header comment included simply set the comment here and then start export. Header comments can be multi-lined, the lines are automagically separated for the file.
    
    Parameters:
    comment - Header comment for written files, null is allowed (no comment)
    Since:
    
    1.5
  - getComment
```
public java.lang.String getComment()
```
    Returns the compression algorithm for written files.
    By default configuration files are written with no comment in the header. If you like your files to have a header comment included simply set the comment here and then start export. Header comments can be multi-lined, the lines are automagically separated for the file.
    
    Returns:
    Header comment for written files, null is allowed (no comment)
    Since:
    
    1.5
  - setSorting
```
public void setSorting(boolean sorting)
```
    Shall written files be sorted alphabetically by variable name?
    By default configuration files are written unsorted to increase performance. If you like your files to be sorted simply use this property before calling one of the write() methods.
    
    Parameters:
    sorting - Enable/disable sorting for written files
    Since:
    
    1.5
  - isSorting
```
public boolean isSorting()
```
    Returns the compression algorithm for written files.
    By default configuration files are written unsorted to increase performance. If you like your files to be sorted simply use this property before calling one of the write() methods.
    
    Returns:
    Sorting is enabled/disabled for written files
    Since:
    
    1.5
  - contains
```
public boolean contains(java.lang.String variable)
```
    Tests the existence of a specific variable in the Hashtable.
    
    Parameters:
    variable - Name of the variable to be tested
    
    Returns:
    Does it exist?
    Since:
    
    1.5
  - remove
```
public boolean remove(java.lang.String variable)
```
    Removes a variable from the cache.
    
    Parameters:
    variable - Name of the variable to be removed
    
    Returns:
    Did the removal work?
    Since:
    
    1.5
  - removeStartsWith
```
public int removeStartsWith(java.lang.String prefix)
```
    Removes all variables with a certain prefix from the cache.
    
    Parameters:
    prefix - The prefix of the variables to be removed
    
    Returns:
    Number of removed variables
    Since:
    
    1.6
  - size
```
public int size()
```
    Returns the number of currently managed variables.
    Since it's up to the handlers to multiplex variable values to multiple variables in the cache the result of this method may not correspond with the variable count you added before! This method returns the number of all (maybe multiplexed) variables in the cache.
    
    Returns:
    Number of (maybe multiplexed) managed variables
    Since:
    
    1.5
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Indicates whether some other object is "equal to" this one.
    Only the variable value pairs are checked here, the other properties like compression are ignored and may therefore be different.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    obj - The reference object with which to compare
    
    Returns:
    true if this object is the same as the obj argument; false otherwise
    Since:
    
    1.5
  - isEmpty
```
public boolean isEmpty()
```
    Provides the info if the variables container is currently empty.
    
    Returns:
    Empty?
    Since:
    
    1.6
  - setSecure
```
public void setSecure(CryptoManager manager,
             java.lang.String keyuserid)
```
    Makes this configuration to store its values securely (PGP encrypted).
    If there are any variable values in the internal cache then all values are encrypted. New values are encrypted when added to the internal cache. The configuration can be either secure or ordered but not both.
    
    Parameters:
    manager - The manager responsible for encryption/decryption, null disables
    keyuserid - The user ID of the encryption/decryption key, required if manager is set
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.lang.IllegalStateException - If the secure feature is already enabled
    Since:
    
    1.6
  - setSecure
```
public void setSecure(PassphraseProvider provider,
             java.lang.String keyuserid)
```
    Makes this configuration to store its values securely (AES encrypted).
    If there are any variable values in the internal cache then all values are encrypted. New values are encrypted when added to the internal cache. The configuration can be either secure or ordered but not both.
    
    Parameters:
    provider - The provider for the AES key, null disables
    keyuserid - The ID of the encryption/decryption key, required if manager is set
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.lang.IllegalStateException - If the secure feature is already enabled
    Since:
    
    1.6
  - isSecure
```
public boolean isSecure()
```
    Provides the info if this configuration stored its values PGP encrypted.
    
    Returns:
    Security feature enabled?
    Since:
    
    1.6
  - setOrdered
```
public void setOrdered(boolean enable)
```
    Makes this configuration to store its values in the order they were added.
    If there are any variable values in the internal cache then this has no effect. New values are added at the end of the internal cache. The configuration can be either secure or ordered but not both.
    
    Parameters:
    enable - Use the ordered cache?
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.lang.IllegalStateException - If the secure feature is already enabled
    Since:
    
    1.6
  - isOrdered
```
public boolean isOrdered()
```
    Provides the info if this configuration keeps the values in the order they were added.
    
    Returns:
    Ordered?
    Since:
    
    1.6
  - setClearBeforeRead
```
public void setClearBeforeRead(boolean clear)
```
    Clear existing variables before new data is read (default is true)?
    
    Parameters:
    clear - Clear cache before new data is read?
    Since:
    
    1.6
  - getClearBeforeRead
```
public boolean getClearBeforeRead()
```
    Provides the info if the cache is cleared before new data is read.
    
    Returns:
    Clear cache before new data is read?
    Since:
    
    1.6

Class Configuration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COMPRESSION_UNCOMPRESSED

COMPRESSION_GZIPPED

COMPRESSION_DEFLATED

ENCODING_ISO_8859_1_UNICODE_ESCAPES

hash

handlers

compression

encoding

comment

sorting

clearBeforeRead

Constructor Detail

Configuration

Configuration

Method Detail

finalize

clear

setVariable

getVariable

setHandler

getHandler

getHandler

removeHandler

removeHandler

removeAllHandlers

read

read

read

read

readXML

readXML

readXML

readXML

readConvertProperties

write

write

write

write

writeXML

writeXML

writeXML

writeXML

setByte

setShort

setInt

setLong

setChar

setFloat

setDouble

setBoolean

setObject

isTypeSupported

isTypeSupported

getSupportedTypes

getSupportedClassTypes

getByte

getByte

getShort

getShort

getInt

getInt

getLong

getLong

getChar

getChar

getFloat

getFloat

getDouble

getDouble

getBoolean

getBoolean

getObject

getObject

getObject