org.epics.ca.impl

Class ConfigurationReader

java.lang.Object

org.epics.ca.impl.ConfigurationReader

public class ConfigurationReader
extends java.lang.Object

Provides helper methods to return configuration information of different types from either the supplied default values, environmental variables set in the host operating system, or from the supplied properties object.

Constructor Summary

Constructors

Constructor and Description
ConfigurationReader()

Method Summary

Modifier and Type	Method and Description
static boolean	readBooleanProperty(java.lang.String item, java.util.Properties properties, boolean defaultValue) Returns the value of the named boolean configuration item by obtaining it from either the operating system environment, the supplied properties object or the supplied default.
static java.util.logging.Level	readDebugLevelProperty(java.lang.String item, java.util.Properties properties, java.util.logging.Level defaultValue) Returns the value of the named logging level configuration item by obtaining it from either the operating system environment, the supplied properties object or the supplied default.
static float	readFloatProperty(java.lang.String item, java.util.Properties properties, float defaultValue) Returns the value of the named floating-point configuration item by obtaining it from either the operating system environment, the supplied properties object or the supplied default.
static int	readIntegerProperty(java.lang.String item, java.util.Properties properties, int defaultValue) Returns the value of the named integer configuration item by obtaining it from either the operating system environment, the supplied properties object or the supplied default.
static java.lang.String	readStringProperty(java.lang.String item, java.util.Properties properties, java.lang.String defaultValue) Returns the value of the named string configuration item by obtaining it from either the operating system environment, the supplied properties object or the supplied default.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationReader

public ConfigurationReader()

Method Detail

readStringProperty

public static java.lang.String readStringProperty(java.lang.String item,
                                                  java.util.Properties properties,
                                                  java.lang.String defaultValue)

Returns the value of the named string configuration item by obtaining it from either the operating system environment, the supplied properties object or the supplied default.

Parameters:

item - the name of the configuration item to read.

properties - an object whose configuration entries may override the values specified by OS environmental variables.

defaultValue - the value to return when neither the OS environment nor the properties object provide value resolution.

Returns:

the result.

Throws:

java.lang.NullPointerException - if any of the arguments were null.

readBooleanProperty

public static boolean readBooleanProperty(java.lang.String item,
                                          java.util.Properties properties,
                                          boolean defaultValue)

Returns the value of the named boolean configuration item by obtaining it from either the operating system environment, the supplied properties object or the supplied default. When a boolean value is specified any of the following string values may be used: "yes" / "true" / "no" / "false".

Parameters:

item - the name of the configuration item to read.

properties - an object whose configuration entries may override the values specified by OS environmental variables.

defaultValue - the value to return when neither the OS environment nor the properties object provide value resolution.

Returns:

the result.

Throws:

java.lang.NullPointerException - if any of the arguments were null.

readFloatProperty

public static float readFloatProperty(java.lang.String item,
                                      java.util.Properties properties,
                                      float defaultValue)

Returns the value of the named floating-point configuration item by obtaining it from either the operating system environment, the supplied properties object or the supplied default.

Parameters:

item - the name of the configuration item to read.

properties - an object whose configuration entries may override the values specified by OS environmental variables.

defaultValue - the value to return when neither the OS environment nor the properties object provide value resolution.

Returns:

the result.

Throws:

java.lang.NullPointerException - if any of the arguments were null.

readIntegerProperty

public static int readIntegerProperty(java.lang.String item,
                                      java.util.Properties properties,
                                      int defaultValue)

Returns the value of the named integer configuration item by obtaining it from either the operating system environment, the supplied properties object or the supplied default.

Parameters:

item - the name of the configuration item to read.

properties - an object whose configuration entries may override the values specified by OS environmental variables.

defaultValue - the value to return when neither the OS environment nor the properties object provide value resolution.

Returns:

the result.

Throws:

java.lang.NullPointerException - if any of the arguments were null.

readDebugLevelProperty

public static java.util.logging.Level readDebugLevelProperty(java.lang.String item,
                                                             java.util.Properties properties,
                                                             java.util.logging.Level defaultValue)

Returns the value of the named logging level configuration item by obtaining it from either the operating system environment, the supplied properties object or the supplied default.

Parameters:

item - the name of the configuration item to read.

properties - an object whose configuration entries may override the values specified by OS environmental variables.

defaultValue - the value to return when neither the OS environment nor the properties object provide value resolution.

Returns:

the result.

Throws:

java.lang.NullPointerException - if any of the arguments were null.