ch.aplu.ev3

Class EV3Properties

java.lang.Object

java.util.Dictionary<K,V>

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

java.util.Properties

ch.aplu.ev3.EV3Properties

All Implemented Interfaces:

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

public class EV3Properties
extends java.util.Properties

Class to read properties from the EV3JLib property file. Many library options are defined in a property file 'ev3jlib.properties' that may be modified as needed.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EV3Properties() Searches the property file.

Method Summary

Methods

Modifier and Type	Method and Description
double	getDoubleValue(java.lang.String key) Gets the property value with the given key as double.
int	getIntValue(java.lang.String key) Gets the property value with the given key as int.
java.lang.String	getResourceInfo() Returns the location of the property file.
java.lang.String	getStringValue(java.lang.String key) Gets the property value with the given key as string.

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

EV3Properties

public EV3Properties()

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

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

Method Detail

getResourceInfo

public java.lang.String getResourceInfo()

Returns the location of the property file.

Returns:

the path of the property file found by running the contructor.

getStringValue

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

Gets the property value with the given key as string. An error dialog is shown, if the property does not exist.

Parameters:

key - the key of the property

Returns:

the value of the property or empty string, if the property is not found

getIntValue

public int getIntValue(java.lang.String key)

Gets the property value with the given key as int. An error dialog is shown, if the property does not exist or has bad format.

Parameters:

key - the key of the property

Returns:

the value of the property or 0, if the property is not found or does not have integer format

getDoubleValue

public double getDoubleValue(java.lang.String key)

Gets the property value with the given key as double. An error dialog is shown, if the property does not exist or has bad format.

Parameters:

key - the key of the property

Returns:

the value of the property or 0, if the property is not found or does not have double format