buri.ddmsence.util

Class PropertyReader

Object

buri.ddmsence.util.PropertyReader

public class PropertyReader
extends Object

Utility class for dealing with the property file.

Properties in DDMSence are found in the ddmsence.properties file. All properties are prefixed with "buri.ddmsence.", so getProperty calls should be performed with just the property suffix.

The Property Reader supports several custom properties, which can be specified at runtime. Property Readers are thread-local, so the properties set in one Thread will not conflict with properties in another Thread. The complete list of configurable properties can be found on the DDMSence website at: https://ddmsence.urizone.net/documentation.jsp#tips-configuration.

Changing a namespace prefix will affect both components created from scratch and components loaded from XML files.

Since:

0.9.b

Author:

Brian Uri!

Method Summary

Modifier and Type	Method and Description
static List<String>	getListProperty(String name) Locates a list property and returns it as a List
static String	getPrefix(String key) Convenience method to look up an XML prefix
static String	getProperty(String name) Locates a property and returns it.
static void	setProperty(String name, String value) Attempts to set one of the properties defined as a configurable property.

Methods inherited from class Object

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

Method Detail

getPrefix

public static String getPrefix(String key)

Convenience method to look up an XML prefix

Parameters:

key - the schema key, such as ddms, ism, or ntk.

getProperty

public static String getProperty(String name)

Locates a property and returns it. Assumes that the property must exist.

Parameters:

name - the simple name of the property, without "buri.ddmsence."

Returns:

the property specified

Throws:

IllegalArgumentException - if the property does not exist.

setProperty

public static void setProperty(String name,
                               String value)

Attempts to set one of the properties defined as a configurable property.

Parameters:

name - the key of the property, without the "buri.ddmsence." prefix

value - the new value of the property

Throws:

IllegalArgumentException - if the property is not a valid configurable property.

getListProperty

public static List<String> getListProperty(String name)

Locates a list property and returns it as a List

Parameters:

name - the simple name of the property, without "buri.ddmsence."

Returns:

the property specified

Throws:

IllegalArgumentException - if the property does not exist