marytts.util.io

Class PropertiesAccessor

java.lang.Object

marytts.util.io.PropertiesAccessor

public class PropertiesAccessor
extends Object

provide comfortable access to a properties, optionally overriding settings with system properties, and optionally providing string replacements.

Author:

marc

Constructor Summary

Constructors

Constructor and Description
PropertiesAccessor(Properties p)
PropertiesAccessor(Properties p, boolean letSystemPropertiesOverride, Map<String,String> stringReplacements) Initialise the properties accessor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getBoolean(String property) Get a boolean property from the underlying properties.
boolean	getBoolean(String property, boolean defaultValue) Get a boolean property from the underlying properties.
double	getDouble(String property) Get a double property from the underlying properties.
double	getDouble(String property, double defaultValue) Get a property from the underlying properties.
int	getInteger(String property) Get an integer property from the underlying properties.
int	getInteger(String property, int defaultValue) Get a property from the underlying properties.
String	getProperty(String key) Get a property from the underlying properties.
String	getProperty(String key, String defaultValue) Get a property from the underlying properties.
InputStream	getStream(String propertyName) For the named property, attempt to get an open input stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertiesAccessor

public PropertiesAccessor(Properties p)

PropertiesAccessor

public PropertiesAccessor(Properties p,
                  boolean letSystemPropertiesOverride,
                  Map<String,String> stringReplacements)

Initialise the properties accessor.

Parameters:

p - the properties to access

letSystemPropertiesOverride - if true, any property will first be looked up in the system properties; only if it is not found there, it will be looked up in p

stringReplacements - before → after pairs of string replacements to perform before returning any property values.

Method Detail

getProperty

public String getProperty(String key)

Get a property from the underlying properties.

Parameters:

key - the property key requested

Returns:

the property value if found, null otherwise.

getProperty

public String getProperty(String key,
                 String defaultValue)

Get a property from the underlying properties.

Parameters:

key - the property key requested

defaultValue - the value to return if the property is not defined

Returns:

the property value if found, defaultValue otherwise.

getBoolean

public boolean getBoolean(String property)

Get a boolean property from the underlying properties.

Parameters:

property - the property requested

Returns:

the boolean property value if found, false otherwise.

getBoolean

public boolean getBoolean(String property,
                 boolean defaultValue)

Get a boolean property from the underlying properties.

Parameters:

property - the property requested

defaultValue - the value to return if the property is not defined

Returns:

the boolean property value if found and valid, defaultValue otherwise.

getInteger

public int getInteger(String property)

Get an integer property from the underlying properties.

Parameters:

property - the property requested

Returns:

the integer property value if found, -1 otherwise.

getInteger

public int getInteger(String property,
             int defaultValue)

Get a property from the underlying properties.

Parameters:

property - the property requested

defaultValue - the value to return if the property is not defined

Returns:

the integer property value if found and valid, defaultValue otherwise.

getDouble

public double getDouble(String property)

Get a double property from the underlying properties.

Parameters:

property - the property requested

Returns:

the double property value if found, Double.NaN otherwise.

getDouble

public double getDouble(String property,
               double defaultValue)

Get a property from the underlying properties.

Parameters:

property - the property requested

defaultValue - the value to return if the property is not defined

Returns:

the double property value if found and valid, defaultValue otherwise.

getStream

public InputStream getStream(String propertyName)
                      throws FileNotFoundException,
                             MaryConfigurationException

For the named property, attempt to get an open input stream. If the property value starts with "jar:", the remainder of the value is interpreted as an absolute path in the classpath. Otherwise it is interpreted as a file name.

Parameters:

propertyName - the name of a property defined in one of the mary config files.

Returns:

an InputStream representing the given resource, or null if the property was not defined.

Throws:

FileNotFoundException - if the property value is a file name and the file cannot be opened

MaryConfigurationException - if the property value is a classpath entry which cannot be opened