com.parabon.ec.util
Class CollectionsParameterDatabase

java.lang.Object
  extended by org.apache.commons.configuration.event.EventSource
      extended by org.apache.commons.configuration.AbstractConfiguration
          extended by org.apache.commons.configuration.CompositeConfiguration
              extended by com.parabon.ec.util.CollectionsParameterDatabase
All Implemented Interfaces:
IParameterDatabase, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, org.apache.commons.configuration.Configuration

public class CollectionsParameterDatabase
extends org.apache.commons.configuration.CompositeConfiguration
implements IParameterDatabase, java.io.Externalizable

IParameterDatabase implementation using Apache Commons Collection. This implementation is compatible with existing ECJ parameter files and adds additional functionality from Commons Collection, such as Ant-style property substitution and the ability to plug in additional configurations using data sources other than property files. This implementation does not support ParameterDatabaseListener listeners - use the Commons ConfigurationListener class instead.

See Also:
Serialized Form

Field Summary
static java.lang.String P_PARAMETER_FILE_DIR
          Directory containing ORIGIN parameter files.
 
Fields inherited from class org.apache.commons.configuration.AbstractConfiguration
END_TOKEN, EVENT_ADD_PROPERTY, EVENT_CLEAR, EVENT_CLEAR_PROPERTY, EVENT_READ_PROPERTY, EVENT_SET_PROPERTY, START_TOKEN
 
Fields inherited from interface ec.util.IParameterDatabase
C_HERE, PRINT_PARAMS, PS_NONE, PS_PRINT_PARAMS, PS_UNKNOWN, UNKNOWN_VALUE
 
Constructor Summary
CollectionsParameterDatabase()
          Creates an empty parameter database.
CollectionsParameterDatabase(java.io.File paramFile)
          Creates a new parameter database from a given database file.
CollectionsParameterDatabase(java.io.InputStream stream)
          Creates a new parameter database loaded from the given stream.
CollectionsParameterDatabase(java.lang.String pathNameInJar, java.lang.Class jarResourceLocation)
          Creates a new parameter database loaded from the given string describing a file in a jar, in the context of a resource location (a class).
 
Method Summary
 void addConfiguration(java.io.File paramFile)
          Adds a configuration file to the parameter database.
 java.io.File directoryFor(Parameter parameter)
          Finds the directory containing the parameter file that defines this parameter.
 boolean exists(Parameter parameter)
          Returns true if parameter exist in the database
 boolean exists(Parameter parameter, Parameter defaultParameter)
          Returns true if either parameter or defaultParameter exists in the database
 java.io.File fileFor(Parameter parameter)
          Searches down through databases to find the parameter file which holds a given parameter.
 boolean getBoolean(Parameter parameter, boolean defaultValue)
          Searches down through databases to find a given parameter; If the parameter does not exist, defaultValue is returned.
 boolean getBoolean(Parameter parameter, Parameter defaultParameter, boolean defaultValue)
          Searches for a given parameter; if the parameter does not exist, the value of defaultParameter is returned if it exists.
 java.lang.Class getClassForParameter(Parameter parameter, Parameter defaultParameter, java.lang.Class mustCastTosuperclass)
          Gets a class parameter value.
 double getDouble(Parameter parameter, Parameter defaultParameter, double minValue)
          Searches down through databases to find a given parameter, whose value must be a double >= minValue.
 double getDouble(Parameter parameter, Parameter defaultParameter, double minValue, double maxValue)
          Searches down through databases to find a given parameter, whose value must be a double >= minValue and <= maxValue.
 double getDoubleWithDefault(Parameter parameter, Parameter defaultParameter, double defaultValue)
          Searches down through databases to find a given parameter, which must be a float.
 java.io.File getFile(Parameter parameter, Parameter defaultParameter)
          Constructs a File from the pathname value of a parameter.
 float getFloat(Parameter parameter, Parameter defaultParameter, double minValue)
          Gets a parameter whose value must be a float >= minValue.
 float getFloat(Parameter parameter, Parameter defaultParameter, double minValue, double maxValue)
          Searches down through databases to find a given parameter, whose value must be a float >= minValue and <= maxValue.
 float getFloatWithDefault(Parameter parameter, Parameter defaultParameter, double defaultValue)
          Searches down through databases to find a given parameter, which must be a float.
 java.io.InputStream getInputStream(Parameter parameter, Parameter defaultParameter)
          Returns an open input stream for the file specified by the parameter.
 java.lang.Object getInstanceForParameter(Parameter parameter, Parameter defaultParameter, java.lang.Class mustCastTosuperclass)
          Searches down through databases to find a given parameter, whose value must be a full Class name, and the class must be a descendent of but not equal to mustCastTosuperclass .
 java.lang.Object getInstanceForParameterEq(Parameter parameter, Parameter defaultParameter, java.lang.Class mustCastTosuperclass)
          Searches down through databases to find a given parameter, whose value must be a full Class name, and the class must be a descendent, or equal to, mustCastTosuperclass .
 int getInt(Parameter parameter, Parameter defaultParameter)
          Searches down through databases to find a given parameter, whose value must be an integer.
 int getInt(Parameter parameter, Parameter defaultParameter, int minValue)
          Searches down through databases to find a given parameter, whose value must be an integer >= minValue.
 int getIntWithDefault(Parameter parameter, Parameter defaultParameter, int defaultValue)
          Searches down through databases to find a given parameter, which must be an integer.
 int getIntWithMax(Parameter parameter, Parameter defaultParameter, int minValue, int maxValue)
          Searches down through databases to find a given parameter, whose value must be an integer >= minValue and <= maxValue.
 long getLong(Parameter parameter, Parameter defaultParameter)
          Searches down through databases to find a given parameter, whose value must be a long.
 long getLong(Parameter parameter, Parameter defaultParameter, long minValue)
          Searches down through databases to find a given parameter, whose value must be a long >= minValue.
 long getLong(Parameter parameter, Parameter defaultParameter, long minValue, long maxValue)
          Deprecated.  
 long getLongWithDefault(Parameter parameter, Parameter defaultParameter, long defaultValue)
          Searches down through databases to find a given parameter, which must be a long.
 long getLongWithMax(Parameter parameter, Parameter defaultParameter, long minValue, long maxValue)
          Searches down through databases to find a given parameter, whose value must be a long >= minValue and = < maxValue.
 Parameter getPrefix()
           
 java.lang.Object getProperty(java.lang.String key)
          Gets a parameter value.
 java.lang.String getString(Parameter parameter, Parameter defaultParameter)
          Searches down through databases to find a given parameter.
 java.lang.String getString(java.lang.String key, java.lang.String defaultValue)
          Overloads the standard getString method to unwrap values that have a location, and to automatically convert non-string values to strings.
 java.lang.String getStringWithDefault(Parameter parameter, Parameter defaultParameter, java.lang.String defaultValue)
          Searches down through databases to find a given parameter.
protected  java.lang.Object interpolate(java.lang.Object value)
          Interpolates parameter values, unwrapping locators.
 void list(java.io.PrintStream p)
          Prints out all the parameters in the database, but not shadowed parameters.
 void list(java.io.PrintStream p, boolean listShadowed)
          Prints out all the parameters in the database.
 void list(java.io.PrintWriter p)
          Prints out all the parameters in the database, but not shadowed parameters.
 void list(java.io.PrintWriter p, boolean listShadowed)
          Prints out all the parameters in the database.
 void listAccessed(java.io.PrintWriter p)
          Prints out all the parameters marked as accessed ("gotten" by some getFoo(...) method), plus their values.
 void listGotten(java.io.PrintWriter p)
          Prints out all the parameters marked as used, plus their values.
 void listNotAccessed(java.io.PrintWriter p)
          Prints out all the parameters NOT marked as accessed, plus their values.
 void listNotGotten(java.io.PrintWriter p)
          Prints out all the parameters NOT marked as used, plus their values.
 java.util.Set<java.lang.String> parameterNameSet()
          Gets a set of all parameter names in the parameter database.
 void readExternal(java.io.ObjectInput in)
          Reads serialized parameter database.
 void remove(Parameter parameter)
          Removes a parameter from the topmost database.
 void removeDeeply(Parameter parameter)
          Removes a parameter from the database and all its parent databases.
 void set(Parameter parameter, java.lang.String value)
          Sets a parameter in the topmost database to a given value, trimmed of whitespace.
 void setObject(Parameter parameter, java.lang.Object value)
           
 void setPrefix(Parameter prefix)
           
 void writeExternal(java.io.ObjectOutput out)
          Serializes the parameter database to an output stream.
 
Methods inherited from class org.apache.commons.configuration.CompositeConfiguration
addConfiguration, addPropertyDirect, clear, clearPropertyDirect, clone, containsKey, getConfiguration, getInMemoryConfiguration, getKeys, getKeys, getList, getNumberOfConfigurations, getStringArray, isEmpty, removeConfiguration, setDelimiterParsingDisabled, setListDelimiter
 
Methods inherited from class org.apache.commons.configuration.AbstractConfiguration
addErrorLogListener, addProperty, clearProperty, createInterpolator, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getDefaultListDelimiter, getDelimiter, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getInterpolator, getList, getListDelimiter, getLogger, getLong, getLong, getLong, getProperties, getProperties, getShort, getShort, getShort, getString, getSubstitutor, interpolate, interpolateHelper, isDelimiterParsingDisabled, isThrowExceptionOnMissing, resolveContainerStore, setDefaultListDelimiter, setDelimiter, setLogger, setProperty, setThrowExceptionOnMissing, subset
 
Methods inherited from class org.apache.commons.configuration.event.EventSource
addConfigurationListener, addErrorListener, clearConfigurationListeners, clearErrorListeners, createErrorEvent, createEvent, fireError, fireEvent, getConfigurationListeners, getErrorListeners, isDetailEvents, removeConfigurationListener, removeErrorListener, setDetailEvents
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

P_PARAMETER_FILE_DIR

public static final java.lang.String P_PARAMETER_FILE_DIR
Directory containing ORIGIN parameter files.

See Also:
Constant Field Values
Constructor Detail

CollectionsParameterDatabase

public CollectionsParameterDatabase()
Creates an empty parameter database.


CollectionsParameterDatabase

public CollectionsParameterDatabase(java.lang.String pathNameInJar,
                                    java.lang.Class jarResourceLocation)
                             throws java.io.IOException
Creates a new parameter database loaded from the given string describing a file in a jar, in the context of a resource location (a class). This approach uses resourceLocation.getResourceAsStream() to load the parameter file. If parent.n are defined, parents will be attempted to be loaded -- that's the reason for the FileNotFoundException and IOException.

Throws:
java.io.IOException

CollectionsParameterDatabase

public CollectionsParameterDatabase(java.io.InputStream stream)
                             throws java.io.IOException
Creates a new parameter database loaded from the given stream. If parent.n are defined, parents will be attempted to be loaded -- that's the reason for the FileNotFoundException and IOException.

Parameters:
stream - Parameter property file input stream
Throws:
java.io.IOException

CollectionsParameterDatabase

public CollectionsParameterDatabase(java.io.File paramFile)
                             throws java.io.IOException
Creates a new parameter database from a given database file. The file name is used to determine the parameter file format, defaulting to the EC parameter file format.

Parameters:
paramFile - Parameter file
Throws:
java.io.IOException
Method Detail

setPrefix

public void setPrefix(Parameter prefix)

getPrefix

public Parameter getPrefix()

addConfiguration

public void addConfiguration(java.io.File paramFile)
                      throws java.io.IOException
Adds a configuration file to the parameter database. If the file's names ends in ".xml" an XML configuration file is created instead of a property configuration file.

Parameters:
paramFile - Parameter file
Throws:
java.io.IOException

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Serializes the parameter database to an output stream. Note: if you add non-transient fields make sure you add them to the writeExternal and readExternal methods.

Specified by:
writeExternal in interface java.io.Externalizable
Parameters:
out - Output stream
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Reads serialized parameter database.

Specified by:
readExternal in interface java.io.Externalizable
Parameters:
in - Object input stream
Throws:
java.io.IOException
java.lang.ClassNotFoundException

getInstanceForParameter

public java.lang.Object getInstanceForParameter(Parameter parameter,
                                                Parameter defaultParameter,
                                                java.lang.Class mustCastTosuperclass)
                                         throws ParamClassLoadException
Searches down through databases to find a given parameter, whose value must be a full Class name, and the class must be a descendent of but not equal to mustCastTosuperclass . Loads the class and returns an instance (constructed with the default constructor), or throws a ParamClassLoadException if there is no such Class. If the parameter is not found, the defaultParameter is used. The parameter chosen is marked "used".

Specified by:
getInstanceForParameter in interface IParameterDatabase
Throws:
ParamClassLoadException

getInstanceForParameterEq

public java.lang.Object getInstanceForParameterEq(Parameter parameter,
                                                  Parameter defaultParameter,
                                                  java.lang.Class mustCastTosuperclass)
                                           throws ParamClassLoadException
Searches down through databases to find a given parameter, whose value must be a full Class name, and the class must be a descendent, or equal to, mustCastTosuperclass . Loads the class and returns an instance (constructed with the default constructor), or throws a ParamClassLoadException if there is no such Class. The parameter chosen is marked "used".

Specified by:
getInstanceForParameterEq in interface IParameterDatabase
Throws:
ParamClassLoadException

getClassForParameter

public java.lang.Class getClassForParameter(Parameter parameter,
                                            Parameter defaultParameter,
                                            java.lang.Class mustCastTosuperclass)
                                     throws ParamClassLoadException
Gets a class parameter value.

Specified by:
getClassForParameter in interface IParameterDatabase
Parameters:
parameter - Parameter.
defaultParameter - Default parameter to use if parameter is not found.
mustCastTosuperclass - Class must be a subclass of this class.
Returns:
Class
Throws:
ParamClassLoadException

getBoolean

public boolean getBoolean(Parameter parameter,
                          Parameter defaultParameter,
                          boolean defaultValue)
Searches for a given parameter; if the parameter does not exist, the value of defaultParameter is returned if it exists. If neither parameter exists defaultValue is returned.

Specified by:
getBoolean in interface IParameterDatabase

getBoolean

public boolean getBoolean(Parameter parameter,
                          boolean defaultValue)
Searches down through databases to find a given parameter; If the parameter does not exist, defaultValue is returned.


getInt

public int getInt(Parameter parameter,
                  Parameter defaultParameter)
           throws java.lang.NumberFormatException
Searches down through databases to find a given parameter, whose value must be an integer. It returns the value, else throws a NumberFormatException exception if there is an error in parsing the parameter. The parameter chosen is marked "used" if it exists. Integers may be in decimal or (if preceded with an X or x) in hexadecimal.

Specified by:
getInt in interface IParameterDatabase
Throws:
java.lang.NumberFormatException

getInt

public int getInt(Parameter parameter,
                  Parameter defaultParameter,
                  int minValue)
Searches down through databases to find a given parameter, whose value must be an integer >= minValue. It returns the value, or minValue-1 if the value is out of range or if there is an error in parsing the parameter. The parameter chosen is marked "used" if it exists. Integers may be in decimal or (if preceded with an X or x) in hexadecimal.

Specified by:
getInt in interface IParameterDatabase

getIntWithDefault

public int getIntWithDefault(Parameter parameter,
                             Parameter defaultParameter,
                             int defaultValue)
Searches down through databases to find a given parameter, which must be an integer. If there is an error in parsing the parameter, then default is returned. The parameter chosen is marked "used" if it exists. Integers may be in decimal or (if preceded with an X or x) in hexadecimal.

Specified by:
getIntWithDefault in interface IParameterDatabase

getIntWithMax

public int getIntWithMax(Parameter parameter,
                         Parameter defaultParameter,
                         int minValue,
                         int maxValue)
Searches down through databases to find a given parameter, whose value must be an integer >= minValue and <= maxValue. It returns the value, or minValue-1 if the value is out of range or if there is an error in parsing the parameter. The parameter chosen is marked "used" if it exists. Integers may be in decimal or (if preceded with an X or x) in hexadecimal.

Specified by:
getIntWithMax in interface IParameterDatabase

getFloat

public float getFloat(Parameter parameter,
                      Parameter defaultParameter,
                      double minValue)
Description copied from interface: IParameterDatabase
Gets a parameter whose value must be a float >= minValue.

Specified by:
getFloat in interface IParameterDatabase
Parameters:
parameter - Primary parameter
defaultParameter - Default parameter
Returns:
Parameter value, or minValue-1 if the parameter doesn't exist or is out of range.

getFloat

public float getFloat(Parameter parameter,
                      Parameter defaultParameter,
                      double minValue,
                      double maxValue)
Searches down through databases to find a given parameter, whose value must be a float >= minValue and <= maxValue. If not, this method returns minvalue-1, else it returns the parameter value. The parameter chosen is marked "used" if it exists.

Specified by:
getFloat in interface IParameterDatabase

getFloatWithDefault

public float getFloatWithDefault(Parameter parameter,
                                 Parameter defaultParameter,
                                 double defaultValue)
Searches down through databases to find a given parameter, which must be a float. If there is an error in parsing the parameter, then default is returned. The parameter chosen is marked "used" if it exists.

Specified by:
getFloatWithDefault in interface IParameterDatabase

getDouble

public double getDouble(Parameter parameter,
                        Parameter defaultParameter,
                        double minValue)
Searches down through databases to find a given parameter, whose value must be a double >= minValue. If not, this method returns minvalue-1, else it returns the parameter value. The parameter chosen is marked "used" if it exists.

Specified by:
getDouble in interface IParameterDatabase

getDouble

public double getDouble(Parameter parameter,
                        Parameter defaultParameter,
                        double minValue,
                        double maxValue)
Searches down through databases to find a given parameter, whose value must be a double >= minValue and <= maxValue. If not, this method returns minvalue-1, else it returns the parameter value. The parameter chosen is marked "used" if it exists.

Specified by:
getDouble in interface IParameterDatabase

getDoubleWithDefault

public double getDoubleWithDefault(Parameter parameter,
                                   Parameter defaultParameter,
                                   double defaultValue)
Searches down through databases to find a given parameter, which must be a float. If there is an error in parsing the parameter, then default is returned. The parameter chosen is marked "used" if it exists.

Specified by:
getDoubleWithDefault in interface IParameterDatabase

getLong

public long getLong(Parameter parameter,
                    Parameter defaultParameter)
             throws java.lang.NumberFormatException
Searches down through databases to find a given parameter, whose value must be a long. It returns the value, else throws a NumberFormatException exception if there is an error in parsing the parameter. The parameter chosen is marked "used" if it exists. Longs may be in decimal or (if preceded with an X or x) in hexadecimal.

Specified by:
getLong in interface IParameterDatabase
Throws:
java.lang.NumberFormatException

getLong

public long getLong(Parameter parameter,
                    Parameter defaultParameter,
                    long minValue)
Searches down through databases to find a given parameter, whose value must be a long >= minValue. If not, this method returns minValue - 1, else it returns the parameter value. The parameter chosen is marked "used" if it exists. Longs may be in decimal or (if preceded with an X or x) in hexadecimal.

Specified by:
getLong in interface IParameterDatabase

getLongWithDefault

public long getLongWithDefault(Parameter parameter,
                               Parameter defaultParameter,
                               long defaultValue)
Searches down through databases to find a given parameter, which must be a long. If there is an error in parsing the parameter, then default is returned. The parameter chosen is marked "used" if it exists. Longs may be in decimal or (if preceded with an X or x) in hexadecimal.

Specified by:
getLongWithDefault in interface IParameterDatabase

getLongWithMax

public long getLongWithMax(Parameter parameter,
                           Parameter defaultParameter,
                           long minValue,
                           long maxValue)
Searches down through databases to find a given parameter, whose value must be a long >= minValue and = < maxValue. If not, this method returns errValue, else it returns the parameter value. The parameter chosen is marked "used" if it exists. Longs may be in decimal or (if preceded with an X or x) in hexadecimal.

Specified by:
getLongWithMax in interface IParameterDatabase

getLong

public long getLong(Parameter parameter,
                    Parameter defaultParameter,
                    long minValue,
                    long maxValue)
Deprecated. 

*

Specified by:
getLong in interface IParameterDatabase

getFile

public java.io.File getFile(Parameter parameter,
                            Parameter defaultParameter)
Constructs a File from the pathname value of a parameter. If the pathname is a relative path it is interpreted as relative to the directory the parameter file containing the parameter is located in.

Specified by:
getFile in interface IParameterDatabase

getInputStream

public java.io.InputStream getInputStream(Parameter parameter,
                                          Parameter defaultParameter)
Returns an open input stream for the file specified by the parameter.

Specified by:
getInputStream in interface IParameterDatabase

getString

public java.lang.String getString(Parameter parameter,
                                  Parameter defaultParameter)
Searches down through databases to find a given parameter. Returns the parameter's value (trimmed) or null if not found or if the trimmed result is empty. The parameter chosen is marked "used" if it exists.

Specified by:
getString in interface IParameterDatabase

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.String defaultValue)
Overloads the standard getString method to unwrap values that have a location, and to automatically convert non-string values to strings.

Specified by:
getString in interface org.apache.commons.configuration.Configuration
Overrides:
getString in class org.apache.commons.configuration.AbstractConfiguration

getStringWithDefault

public java.lang.String getStringWithDefault(Parameter parameter,
                                             Parameter defaultParameter,
                                             java.lang.String defaultValue)
Searches down through databases to find a given parameter. Returns the parameter's value trimmed of whitespace, or defaultValue.trim() if the result is not found or the trimmed result is empty.

Specified by:
getStringWithDefault in interface IParameterDatabase

set

public void set(Parameter parameter,
                java.lang.String value)
Sets a parameter in the topmost database to a given value, trimmed of whitespace.

Specified by:
set in interface IParameterDatabase

setObject

public void setObject(Parameter parameter,
                      java.lang.Object value)
Specified by:
setObject in interface IParameterDatabase

exists

public boolean exists(Parameter parameter)
Returns true if parameter exist in the database

Specified by:
exists in interface IParameterDatabase

exists

public boolean exists(Parameter parameter,
                      Parameter defaultParameter)
Returns true if either parameter or defaultParameter exists in the database

Specified by:
exists in interface IParameterDatabase

getProperty

public java.lang.Object getProperty(java.lang.String key)
Gets a parameter value.

Specified by:
getProperty in interface org.apache.commons.configuration.Configuration
Overrides:
getProperty in class org.apache.commons.configuration.CompositeConfiguration
Parameters:
key - Parameter name

interpolate

protected java.lang.Object interpolate(java.lang.Object value)
Interpolates parameter values, unwrapping locators.

Overrides:
interpolate in class org.apache.commons.configuration.AbstractConfiguration
Parameters:
value - Parameter value

directoryFor

public java.io.File directoryFor(Parameter parameter)
Finds the directory containing the parameter file that defines this parameter.

Specified by:
directoryFor in interface IParameterDatabase
Parameters:
parameter - Parameter being located
Returns:
Directory, or the user's home directory if the parameter's directory cannot be determined.

fileFor

public java.io.File fileFor(Parameter parameter)
Searches down through databases to find the parameter file which holds a given parameter. Returns the filename or null if not found.

Specified by:
fileFor in interface IParameterDatabase
Returns:
The parameter filename, or null if the file cannot be determined or the parameter doesn't exist.

remove

public void remove(Parameter parameter)
Removes a parameter from the topmost database.

Specified by:
remove in interface IParameterDatabase

removeDeeply

public void removeDeeply(Parameter parameter)
Removes a parameter from the database and all its parent databases.


parameterNameSet

public java.util.Set<java.lang.String> parameterNameSet()
Gets a set of all parameter names in the parameter database.

Specified by:
parameterNameSet in interface IParameterDatabase
Returns:
Unordered set of unique parameter names.

listGotten

public void listGotten(java.io.PrintWriter p)
Prints out all the parameters marked as used, plus their values. If a parameter was listed as "used" but not's actually in the database, the value printed is UNKNOWN_VALUE (set to "?????")

Specified by:
listGotten in interface IParameterDatabase

listNotGotten

public void listNotGotten(java.io.PrintWriter p)
Prints out all the parameters NOT marked as used, plus their values.

Specified by:
listNotGotten in interface IParameterDatabase

listNotAccessed

public void listNotAccessed(java.io.PrintWriter p)
Prints out all the parameters NOT marked as accessed, plus their values.

Specified by:
listNotAccessed in interface IParameterDatabase

listAccessed

public void listAccessed(java.io.PrintWriter p)
Prints out all the parameters marked as accessed ("gotten" by some getFoo(...) method), plus their values. If this method ever prints UNKNOWN_VALUE ("?????"), that's a bug.

Specified by:
listAccessed in interface IParameterDatabase
Parameters:
p - Open PrintWriter that parameter information is printed to

list

public void list(java.io.PrintStream p,
                 boolean listShadowed)
Prints out all the parameters in the database. Useful for debugging. If listShadowed is true, each parameter is printed with the parameter database it's located in. If listShadowed is false, only active parameters are listed, and they're all given in one big chunk.

Specified by:
list in interface IParameterDatabase

list

public void list(java.io.PrintStream p)
Prints out all the parameters in the database, but not shadowed parameters.

Specified by:
list in interface IParameterDatabase

list

public void list(java.io.PrintWriter p)
Prints out all the parameters in the database, but not shadowed parameters.

Specified by:
list in interface IParameterDatabase

list

public void list(java.io.PrintWriter p,
                 boolean listShadowed)
Prints out all the parameters in the database. Useful for debugging. If listShadowed is true, each parameter is printed with the parameter database it's located in. If listShadowed is false, only active parameters are listed, and they're all given in one big chunk.

Specified by:
list in interface IParameterDatabase