marytts.server

Class MaryProperties

java.lang.Object

marytts.server.MaryProperties

public class MaryProperties
extends Object

A static class reading once, at program start, properties from a number of external property files, and providing them via static getter methods to anyone wishing to read them. At program start, this will read all the config files in the MARY_BASE/conf directory that end in *.config. See the config files for more information.

Author:

Marc Schröder

Constructor Summary

Constructors

Constructor and Description
MaryProperties()

Method Summary

Methods

Modifier and Type	Method and Description
static Vector<String>	effectClasses() Names of the classes to use as audio effects.
static boolean	getAutoBoolean(String property) Get or infer a boolean property from the underlying properties.
static boolean	getAutoBoolean(String property, boolean defaultValue) Get or infer a boolean property from the underlying properties.
static boolean	getBoolean(String property) Get a boolean property from the underlying properties.
static boolean	getBoolean(String property, boolean defaultValue) Get a boolean property from the underlying properties.
static String	getFilename(String property) Get a filename property from the underlying properties.
static String	getFilename(String property, String defaultValue) Get a filename property from the underlying properties.
static int	getInteger(String property) Get an integer property from the underlying properties.
static int	getInteger(String property, int defaultValue) Get a property from the underlying properties.
static List<String>	getList(String propName)
static String	getProperty(String property) Get a property from the underlying properties.
static String	getProperty(String property, String defaultValue) Get a property from the underlying config files.
static InputStream	getStream(String propertyName) For the named property, attempt to get an open input stream.
static String	localePrefix(Locale locale) Provide the config file prefix used for different locales in the config files.
static String	maryBase() The mary base directory, e.g.
static List<String>	moduleInitInfo() Names of the classes to use as modules, plus optional parameter info.
static boolean	needAutoBoolean(String property) Get or infer a boolean property from the underlying properties, throwing an exception if it is not defined.
static boolean	needBoolean(String property) Get a boolean property from the underlying properties, throwing an exception if it is not defined.
static Class	needClass(String property) Get a Class property from the underlying properties, throwing an exception if it is not defined.
static String	needFilename(String property) Get a filename property from the underlying properties, throwing an exception if it is not defined.
static int	needInteger(String property) Get an integer property from the underlying properties, throwing an exception if it is not defined.
static String	needProperty(String property) Get a property from the underlying properties, throwing an exception if it is not defined.
static InputStream	needStream(String propertyName) For the named property, attempt to get an open input stream.
static List<String>	synthesizerClasses() Names of the classes to use as waveform synthesizers.

Methods inherited from class java.lang.Object

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

Constructor Detail

MaryProperties

public MaryProperties()

Method Detail

maryBase

public static String maryBase()

The mary base directory, e.g. /usr/local/mary

Returns:

getFilename("mary.base", ".")

getList

public static List<String> getList(String propName)

getProperty

public static String getProperty(String property,
                 String defaultValue)

Get a property from the underlying config files.

Parameters:

property - the property requested

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

Returns:

the property value if found, defaultValue otherwise.

moduleInitInfo

public static List<String> moduleInitInfo()

Names of the classes to use as modules, plus optional parameter info.

Returns:

getList("modules.classes.list")

See Also:

for details on expected format.

synthesizerClasses

public static List<String> synthesizerClasses()

Names of the classes to use as waveform synthesizers.

Returns:

getList("synthesizers.classes.list")

effectClasses

public static Vector<String> effectClasses()

Names of the classes to use as audio effects.

Returns:

Vector<String>(getList("audioeffects.classes.list"))

getProperty

public static String getProperty(String property)

Get a property from the underlying properties.

Parameters:

property - the property requested

Returns:

the property value if found, null otherwise.

getBoolean

public static 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.

getAutoBoolean

public static boolean getAutoBoolean(String property)

Get or infer a boolean property from the underlying properties. Apart from the values "true"and "false", a value "auto" is permitted; it will resolve to "true" in server mode and to "false" in non-server mode.

Parameters:

property - the property requested

Returns:

the boolean property value if found, false otherwise.

getInteger

public static 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.

getFilename

public static String getFilename(String property)

Get a filename property from the underlying properties. The string MARY_BASE is replaced with the value of the property mary.base, and path separators are adapted to the current platform.

Parameters:

property - the property requested

Returns:

the filename corresponding to the property value if found, null otherwise.

getBoolean

public static 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.

getAutoBoolean

public static boolean getAutoBoolean(String property,
                     boolean defaultValue)

Get or infer a boolean property from the underlying properties. Apart from the values "true"and "false", a value "auto" is permitted; it will resolve to "true" in server mode and to "false" in non-server mode.

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, false otherwise.

getInteger

public static 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.

getFilename

public static String getFilename(String property,
                 String defaultValue)

Get a filename property from the underlying properties. The string MARY_BASE is replaced with the value of the property mary.base, and path separators are adapted to the current platform.

Parameters:

property - the property requested

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

Returns:

the filename corresponding to the property value if found, defaultValue otherwise.

needProperty

public static String needProperty(String property)
                           throws NoSuchPropertyException

Get a property from the underlying properties, throwing an exception if it is not defined.

Parameters:

property - the property required

Returns:

the property value

Throws:

NoSuchPropertyException - if the property is not defined.

needBoolean

public static boolean needBoolean(String property)
                           throws NoSuchPropertyException

Get a boolean property from the underlying properties, throwing an exception if it is not defined.

Parameters:

property - the property requested

Returns:

the boolean property value

Throws:

NoSuchPropertyException - if the property is not defined.

needAutoBoolean

public static boolean needAutoBoolean(String property)
                               throws NoSuchPropertyException

Get or infer a boolean property from the underlying properties, throwing an exception if it is not defined. Apart from the values "true"and "false", a value "auto" is permitted; it will resolve to "true" in server mode and to "false" in non-server mode.

Parameters:

property - the property requested

Returns:

the boolean property value

Throws:

NoSuchPropertyException - if the property is not defined.

needInteger

public static int needInteger(String property)
                       throws NoSuchPropertyException

Get an integer property from the underlying properties, throwing an exception if it is not defined.

Parameters:

property - the property requested

Returns:

the integer property value

Throws:

NoSuchPropertyException - if the property is not defined.

needFilename

public static String needFilename(String property)
                           throws NoSuchPropertyException

Get a filename property from the underlying properties, throwing an exception if it is not defined. The string MARY_BASE is replaced with the value of the property mary.base, and path separators are adapted to the current platform.

Parameters:

property - the property requested

Returns:

the filename corresponding to the property value

Throws:

NoSuchPropertyException - if the property is not defined or the value is not a valid filename

needStream

public static InputStream needStream(String propertyName)
                              throws NoSuchPropertyException,
                                     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

Throws:

NoSuchPropertyException - if the property is not defined

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

getStream

public static 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

needClass

public static Class needClass(String property)
                       throws NoSuchPropertyException

Get a Class property from the underlying properties, throwing an exception if it is not defined.

Parameters:

property - the property requested

Returns:

the Class corresponding to the property value

Throws:

NoSuchPropertyException - if the property is not defined or the value is not a valid class

localePrefix

public static String localePrefix(Locale locale)

Provide the config file prefix used for different locales in the config files. Will return the string representation of the locale as produced by locale.toString(), e.g. "en_GB"; if locale is null, return null.

Parameters:

locale - locale

Returns:

locale converted to string