Properties

public class Properties implements Iterable<Entry<String, Property>>

A class which reads configuration options from different sources and presents them using key value pairs. Property keys are hierarchically organized with a . as a separator for the path. Multiple threads can read properties in parallel. However, writing needs to be synchronized as well as the provided loading methods.

Author

swrede, jwienke

Constructors

Properties

public Properties()

Creates a new instance without loading anything. The instance will initially be empty.

Methods

dumpProperties

public void dumpProperties(PrintStream stream)

Dumps the properties to the presented stream.

Parameters

stream – the stream to print on

equals

public boolean equals(Object obj)

filter

public Properties filter(String desiredPrefix)

Returns a new properties instance with all properties with keys starting with the specified prefix. Property key separation with dots is expected. This means that in case the desired prefix is “a.test” only exactly this key and keys starting with string form “a.test.” are returned.

Parameters

desiredPrefix – key prefix to include in the new set.

Returns

Properties instance with all properties matching the desired prefix. This also includes the property with a key directly reflecting the specified prefix

getAvailableKeys

public Set<String> getAvailableKeys()

Returns a set of know property names.

Returns

set of known property keys

getProperty

public Property getProperty(String key)

Returns the value of the specified property in case it exists.

Parameters

key – the property name

Throws

InvalidPropertyException – property with the given name is unknown

Returns

value of that property

getProperty

public <TargetType> Property getProperty(String key, TargetType defaultValue)

Returns the value of a specified property or the specified default in case the property does not exist.

Parameters

• key – the property name

• defaultValue – default value to return in case the property does not exist. In case this is not a string, Object.toString() will be called to convert to a string representation.

• <TargetType> – the type of the default value.

Returns

value of that property or default

hasProperty

public boolean hasProperty(String key)

Indicates whether the property with the given key is available or not.

Parameters

key – key of the property to test

Returns

true if the property exists, else false

hashCode

public int hashCode()

iterator

public Iterator<Entry<String, Property>> iterator()

merge

public void merge(Properties properties)

Merges the passed properties into this instance by adding and/or overwriting all properties found in that instance.

Parameters

properties – properties to merge into this instance

remove

public void remove(Set<String> keys)

Removes all properties with the given keys.

Parameters

keys – set of keys to remove

remove

public void remove(String key)

Removes the property with the given key.

Parameters

key – key to remove

reset

public void reset()

Resets this instances to empty and afterwards re-initiates value parsing.

setProperty

public void setProperty(String key, String value)

Sets a property. key and value are always trimmed before insertion.

Parameters

• key – key of the property

• value – value of the property

toString

public String toString()