java.lang.Object
- org.openjump.io.PropertiesHandler

All Implemented Interfaces:

HandlerToMakeYourLifeEasier
```
public class PropertiesHandler
extends Object
implements HandlerToMakeYourLifeEasier
```
Class that enables easy access for reading and writing properties files.

Version:

$Rev: 1559 $

Author:

Ole Rahn

FH Osnabrück - University of Applied Sciences Osnabrück,
Project: PIROL (2005),
Subproject: Daten- und Wissensmanagement

Field Summary

Fields
Modifier and Type Field Description

protected Properties properties

protected String propertiesFile

static String propertiesFileEnding

Constructor Summary

Constructors
Constructor Description

PropertiesHandler(String propertiesFileName)
Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`contains(Object value)`
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`Enumeration`	`elements()`
`Map<String,Object>`	`getAll()`	get all properties as Map object (e.g.
`String`	`getPropertiesFile()`
`String`	`getProperty(String key)`
`String`	`getProperty(String key, String defaultValue)`
`boolean`	`getPropertyAsBoolean(String key)`	Gets the property value with the key `key` and parses it to an `boolean` if possible.
`boolean`	`getPropertyAsBoolean(String key, boolean defaultValue)`	Gets the property value with the key `key` and parses it to an `boolean` if possible.
`Color`	`getPropertyAsColor(String key)`	Gets the property value with the key `key` and parses it to a `Color` if possible.
`Color`	`getPropertyAsColor(String key, Color defaultValue)`	Gets the property value with the key `key` and parses it to a `Color` if possible.
`double`	`getPropertyAsDouble(String key)`	Gets the property value with the key `key` and parses it to a `double` if possible.
`double`	`getPropertyAsDouble(String key, double defaultValue)`	Gets the property value with the key `key` and parses it to a `double` if possible.
`int`	`getPropertyAsInt(String key)`	Gets the property value with the key `key` and parses it to an `int` if possible.
`int`	`getPropertyAsInt(String key, int defaultValue)`	Gets the property value with the key `key` and parses it to an `int` if possible.
`boolean`	`isEmpty()`
`Enumeration`	`keys()`
`Set`	`keySet()`
`void`	`load()`	load the properties from the file
`void`	`putAll(Map<String,Object> arg0)`
`Object`	`remove(Object arg0)`
`Object`	`setProperty(String key, Color value)`	Sets a property key-value pair, replaces a pair with the same key!
`Object`	`setProperty(String key, String value)`	Sets a property key-value pair, replaces a pair with the same key!
`void`	`store()`	Stores the current properties map to the file.
`void`	`store(String comments)`	Stores the current properties map to the file.

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

- Field Detail
  - propertiesFile
```
protected String propertiesFile
```
  - properties
```
protected Properties properties
```
  - propertiesFileEnding
```
public static final String propertiesFileEnding
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PropertiesHandler
```
public PropertiesHandler(String propertiesFileName)
```
    Constructor
    
    Parameters:
    
    propertiesFileName - the file name (with out path!) of the properties file, that is to be read or written. It will automatically be placed in the config directory.
    
    See Also:
    
    PirolPlugInSettings.configDirectory()
- Method Detail
  - contains
```
public boolean contains(Object value)
```
    See Also:
    
    Properties
  - containsKey
```
public boolean containsKey(Object key)
```
    See Also:
    
    Properties
  - containsValue
```
public boolean containsValue(Object value)
```
    See Also:
    
    Properties
  - elements
```
public Enumeration elements()
```
    See Also:
    
    Properties
  - getProperty
```
public String getProperty(String key,
                          String defaultValue)
```
    See Also:
    
    Properties
  - getProperty
```
public String getProperty(String key)
```
    See Also:
    
    Properties
  - isEmpty
```
public boolean isEmpty()
```
    See Also:
    
    Properties
  - keys
```
public Enumeration keys()
```
    See Also:
    
    Properties
  - keySet
```
public Set keySet()
```
    See Also:
    
    Properties
  - load
```
public void load()
          throws IOException
```
    load the properties from the file
    
    Throws:
    
    IOException - if an IOException occurs
  - putAll
```
public void putAll(Map<String,Object> arg0)
```
    See Also:
    
    Properties
  - getAll
```
public Map<String,Object> getAll()
```
    get all properties as Map object (e.g. to feed into an other map...)
    
    Returns:
    
    a map containing all the properties
  - remove
```
public Object remove(Object arg0)
```
    See Also:
    
    Properties
  - setProperty
```
public Object setProperty(String key,
                          String value)
```
    Sets a property key-value pair, replaces a pair with the same key!
    
    Parameters:
    
    key - the key for the pair
    
    value - the value
    
    Returns:
    
    return value like Properties would return
    
    See Also:
    
    Properties
  - setProperty
```
public Object setProperty(String key,
                          Color value)
```
    Sets a property key-value pair, replaces a pair with the same key!
    
    Parameters:
    
    key - the key for the pair
    
    value - the value
    
    Returns:
    
    return value like Properties would return
    
    See Also:
    
    Properties
  - store
```
public void store(String comments)
           throws IOException
```
    Stores the current properties map to the file.
    
    Parameters:
    
    comments - comments that will appear in the first lines of the file
    
    Throws:
    
    IOException - if an IOException occurs
  - store
```
public void store()
           throws IOException
```
    Stores the current properties map to the file.
    
    Throws:
    
    IOException - if an IOException occurs
  - getPropertyAsInt
```
public int getPropertyAsInt(String key)
```
    Gets the property value with the key key and parses it to an int if possible. An exception will be thrown, if this key is not found within the properties and if the value could not be parsed as desired.
    
    Parameters:
    
    key - the key to get the value of
    
    Returns:
    
    the value of the property
  - getPropertyAsInt
```
public int getPropertyAsInt(String key,
                            int defaultValue)
```
    Gets the property value with the key key and parses it to an int if possible. If this key is not found within the properties the given default-Value will be returned. An exception will be thrown, if the value is existent, but could not be parsed as desired.
    
    Parameters:
    
    key - the key to get the value of
    
    defaultValue - value to be filled in, if the given key wasn't found
    
    Returns:
    
    the value of the property
  - getPropertyAsBoolean
```
public boolean getPropertyAsBoolean(String key)
```
    Gets the property value with the key key and parses it to an boolean if possible. An exception will be thrown, if this key is not found within the properties and if the value could not be parsed as desired.
    
    Parameters:
    
    key - the key to get the value of
    
    Returns:
    
    the value of the property
  - getPropertyAsBoolean
```
public boolean getPropertyAsBoolean(String key,
                                    boolean defaultValue)
```
    Gets the property value with the key key and parses it to an boolean if possible. If this key is not found within the properties the given default-Value will be returned. An exception will be thrown, if the value is existent, but could not be parsed as desired.
    
    Parameters:
    
    key - the key to get the value of
    
    defaultValue - value to be filled in, if the given key wasn't found
    
    Returns:
    
    the value of the property
  - getPropertyAsDouble
```
public double getPropertyAsDouble(String key)
```
    Gets the property value with the key key and parses it to a double if possible. An exception will be thrown, if this key is not found within the properties and if the value could not be parsed as desired.
    
    Parameters:
    
    key - the key to get the value of
    
    Returns:
    
    the value of the property
  - getPropertyAsDouble
```
public double getPropertyAsDouble(String key,
                                  double defaultValue)
```
    Gets the property value with the key key and parses it to a double if possible. If this key is not found within the properties the given default-Value will be returned. An exception will be thrown, if the value is existent, but could not be parsed as desired.
    
    Parameters:
    
    key - the key to get the value of
    
    defaultValue - value to be filled in, if the given key wasn't found
    
    Returns:
    
    the value of the property
  - getPropertyAsColor
```
public Color getPropertyAsColor(String key)
```
    Gets the property value with the key key and parses it to a Color if possible. An exception will be thrown, if this key is not found within the properties and if the value could not be parsed as desired.
    
    Parameters:
    
    key - the key to get the value of
    
    Returns:
    
    the value of the property
  - getPropertyAsColor
```
public Color getPropertyAsColor(String key,
                                Color defaultValue)
```
    Gets the property value with the key key and parses it to a Color if possible. If this key is not found within the properties the given default-Value will be returned. An exception will be thrown, if the value is existent, but could not be parsed as desired.
    
    Parameters:
    
    key - the key to get the value of
    
    defaultValue - value to be filled in, if the given key wasn't found
    
    Returns:
    
    the value of the property
  - getPropertiesFile
```
public String getPropertiesFile()
```
    Returns:
    
    the file name of the properties file handled by this instance

Modifier and Type	Field	Description
`protected Properties`	`properties`
`protected String`	`propertiesFile`
`static String`	`propertiesFileEnding`

Class PropertiesHandler

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

propertiesFile

properties

propertiesFileEnding

Constructor Detail

PropertiesHandler

Method Detail

contains

containsKey

containsValue

elements

getProperty

getProperty

isEmpty

keys

keySet

load

putAll

getAll

remove

setProperty

setProperty

store

store

getPropertyAsInt

getPropertyAsInt

getPropertyAsBoolean

getPropertyAsBoolean

getPropertyAsDouble

getPropertyAsDouble

getPropertyAsColor

getPropertyAsColor

getPropertiesFile