ch.aplu.tcp

Class TcpProperties

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<java.lang.Object,java.lang.Object>

java.util.Properties

ch.aplu.tcp.TcpProperties

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>

public class TcpProperties
extends java.util.Properties

Class to read library options from a property file that may be modified as needed.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TcpProperties()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Double	getDoubleValue(java.lang.String key) Gets the property value with the given key as double.
java.lang.String	getFileInfo() Returns the tcpjlib.properties file information.
java.lang.Integer	getIntValue(java.lang.String key) Gets the property value with the given key as int.
java.lang.String	getStringValue(java.lang.String key) Gets the property value with the given key as string.
boolean	search() Searches the property file.

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, remove, size, toString, values

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TcpProperties

public TcpProperties()

Method Detail

search

public boolean search()

Searches the property file. The property file is searched in the following order:
- Application directory (user.dir)
- Home directory (user.home)
- TcpJLib.jar (distribution)

As soon as the property file is found, the search is cancelled and the contend is loaded. This allows to use a personalized property file without deleting or modifing the distributed file in TcpJLib.jar. Consult the distributed file for more information. Be careful to keep the original formatting.

Returns:

true, if property file is successfully loaded; otherwise false

getStringValue

public java.lang.String getStringValue(java.lang.String key)

Gets the property value with the given key as string.

Parameters:

key - the key of the property

Returns:

the value of the property or null, if the property file is not loaded or the property is not found

getIntValue

public java.lang.Integer getIntValue(java.lang.String key)

Gets the property value with the given key as int.

Parameters:

key - the key of the property

Returns:

the value of the property or null, if the property file is not loaded or if the property is not found or does not have integer format

getDoubleValue

public java.lang.Double getDoubleValue(java.lang.String key)

Gets the property value with the given key as double.

Parameters:

key - the key of the property

Returns:

the value of the property or null, if the property file is not loaded or the property is not found or does not have double format

getFileInfo

public java.lang.String getFileInfo()

Returns the tcpjlib.properties file information.

Returns:

information about the properties file, empty if the properties file was not searched