equip.config
Class ConfigManager

java.lang.Object
  equip.runtime.Object
      equip.runtime.ValueBase
          equip.config.ConfigManager

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

ConfigManagerImpl

public abstract class ConfigManager

extends ValueBase

Configuration manager for providing an application's configuration information, normally from property files (IDL'd in equip_config_types.idl). Note: always use a single creating with SingletonManager.

Field Summary

NameValuePair[]

entries the configuration manager's internal name,value pairs

Constructor Summary

ConfigManager()
Default no-arg constructor

Method Summary

boolean	_equals_helper(ConfigManager c) Internal IDL-generated equality test helper
boolean	_matches_helper(ConfigManager c) Internal IDL-generated match test helper
boolean	equals(java.lang.Object c) Standard IDL-generated equality test.
abstract boolean	getBooleanValue(java.lang.String name, boolean defaultValue) get a boolean configuration value (true = 'y', 't', '1')
abstract char	getCharValue(java.lang.String name, char defaultValue) get a character configuration value
abstract double	getDoubleValue(java.lang.String name, double defaultValue) get a double configuration value
abstract float	getFloatValue(java.lang.String name, float defaultValue) get a float configuration value
abstract int	getLongValue(java.lang.String name, int defaultValue) get a IDL long (Java int) configuration value
java.lang.String	getModuleName() IDL-generated helper routine to get module name (currently unimplemented).
abstract ValueBase	getObjectValue(java.lang.String name, ValueBase defaultValue) get a configuration value as a ValueBase
abstract java.lang.String	getStringValue(java.lang.String name, java.lang.String defaultValue) get a short configuration value
boolean	matches(java.lang.Object c) Standard IDL-generated template match test.
abstract int	readConfigFile(java.lang.String filename, int rating, java.lang.String extraPath) Finds and reads name':'value pairs, one per line.
void	readObject(ObjectInputStream in) Internal IDL-generated serialisation helper.
void	writeObject(ObjectOutputStream out) Internal IDL-generated serialisation helper.

Methods inherited from class equip.runtime.ValueBase

_equals_helper, _matches_helper, clone

Methods inherited from class java.lang.Object

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

Field Detail

entries

public NameValuePair[] entries

the configuration manager's internal name,value pairs

Constructor Detail

ConfigManager

public ConfigManager()

Default no-arg constructor

Method Detail

readConfigFile

public abstract int readConfigFile(java.lang.String filename,
                                   int rating,
                                   java.lang.String extraPath)

Finds and reads name':'value pairs, one per line. Also allows name '{' ... '}' as prepending 'name.' to enclosed names. default search path is (to effect of) '.:${EQUIP_PATH}'

getBooleanValue

public abstract boolean getBooleanValue(java.lang.String name,
                                        boolean defaultValue)

get a boolean configuration value (true = 'y', 't', '1')

getCharValue

public abstract char getCharValue(java.lang.String name,
                                  char defaultValue)

get a character configuration value

getLongValue

public abstract int getLongValue(java.lang.String name,
                                 int defaultValue)

get a IDL long (Java int) configuration value

getStringValue

public abstract java.lang.String getStringValue(java.lang.String name,
                                                java.lang.String defaultValue)

get a short configuration value

getFloatValue

public abstract float getFloatValue(java.lang.String name,
                                    float defaultValue)

get a float configuration value

getDoubleValue

public abstract double getDoubleValue(java.lang.String name,
                                      double defaultValue)

get a double configuration value

getObjectValue

public abstract ValueBase getObjectValue(java.lang.String name,
                                         ValueBase defaultValue)

get a configuration value as a ValueBase

getModuleName

public java.lang.String getModuleName()

IDL-generated helper routine to get module name (currently unimplemented).

Overrides:

getModuleName in class Object

Returns:

name of this class's module

equals

public boolean equals(java.lang.Object c)

Standard IDL-generated equality test.

Overrides:

equals in class ValueBase

Parameters:

c - The object to be compared against this.

Returns:

true if this is equal to c

_equals_helper

public boolean _equals_helper(ConfigManager c)

Internal IDL-generated equality test helper

matches

public boolean matches(java.lang.Object c)

Standard IDL-generated template match test.

Overrides:

matches in class ValueBase

Parameters:

c - The object to be checked against this template.

Returns:

true if this (as a template) matches the argument

_matches_helper

public boolean _matches_helper(ConfigManager c)

Internal IDL-generated match test helper

writeObject

public void writeObject(ObjectOutputStream out)
                 throws java.io.IOException

Internal IDL-generated serialisation helper. Used by ObjectInputStream and ObjectOutputStream only.

Overrides:

writeObject in class ValueBase

Throws:

java.io.IOException

readObject

public void readObject(ObjectInputStream in)
                throws java.io.IOException,
                       java.lang.ClassNotFoundException,
                       java.lang.InstantiationException

Internal IDL-generated serialisation helper. Used by ObjectInputStream and ObjectOutputStream only.

Overrides:

readObject in class ValueBase

Throws:

java.io.IOException

java.lang.ClassNotFoundException

java.lang.InstantiationException