org.daisy.common.properties

Class Properties

java.lang.Object

org.daisy.common.properties.Properties

public final class Properties
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Properties.Property
static class	Properties.SettableProperty

Method Summary

Modifier and Type	Method and Description
static String	getProperty(String key) Gets the system property or environment variable indicated by the specified key.
static Properties.Property	getProperty(String key, boolean settable, String description, boolean sensitive)
static Properties.Property	getProperty(String key, boolean settable, String description, boolean sensitive, String defaultValue)
static String	getProperty(String key, String defaultValue)
static Set<Properties.SettableProperty>	getSettableProperties() Get the current set of properties that can be modified.
static Map<String,String>	getSnapshot() Returns the momentary set of properties as a Map object.
static Set<String>	propertyNames() Returns a set of all the keys in this property list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

propertyNames

public static Set<String> propertyNames()

Returns a set of all the keys in this property list.

getSnapshot

public static Map<String,String> getSnapshot()

Returns the momentary set of properties as a Map object.

getProperty

public static String getProperty(String key)

Gets the system property or environment variable indicated by the specified key. If the key starts with "org.daisy.pipeline", the function first looks for an environment variable, then for a system property, and then reads the pipeline.properties file. Otherwise only system properties are considered. The name of the environment variable is derived from the name of the system property. For example, if the key is "org.daisy.pipeline.ws.host", an environment variable "PIPELINE2_WS_HOST" will have precedence over the system property. Variable interpolation is supported, meaning that the value of a property may dereference other properties, using the "${...}" syntax.

Parameters:

key - The name of the system property.

Returns:

The string value of the system property or environment variable, or null if there is no property or variable with that key.

getProperty

public static String getProperty(String key,
                                 String defaultValue)

Parameters:

key - The name of the property.

defaultValue - A default value.

Returns:

The string value of the system property or environment variable, or the default value if there is no property or variable with that key. Modifications to settable properties are taken into account.

getProperty

public static Properties.Property getProperty(String key,
                                              boolean settable,
                                              String description,
                                              boolean sensitive)

Parameters:

settable - Allow a property to be modified and get a Properties.SettableProperty object for reading future values.

getProperty

public static Properties.Property getProperty(String key,
                                              boolean settable,
                                              String description,
                                              boolean sensitive,
                                              String defaultValue)

getSettableProperties

public static Set<Properties.SettableProperty> getSettableProperties()

Get the current set of properties that can be modified.