ParameterDatabase (ECJ 22 API)

java.lang.Object
- java.util.Dictionary<K,V>
- - java.util.Hashtable<Object,Object>
  - - java.util.Properties
    - - ec.util.ParameterDatabase

All Implemented Interfaces:: Serializable, Cloneable, Map<Object,Object>

public class ParameterDatabase
extends Properties
implements Serializable

This extension of the Properties class allows you to set, get, and delete Parameters in a hierarchical tree-like database. The database consists of a list of Parameters, plus an array of "parent databases" which it falls back on when it can't find the Parameter you're looking for. Parents may also have arrays of parents, and so on..

The parameters are loaded from a Java property-list file, which is basically a collection of parameter=value pairs, one per line. Empty lines and lines beginning with # are ignored. These parameters and their values are case-sensitive , and whitespace is trimmed I believe.

An optional set of parameters, "parent. n ", where n are consecutive integers starting at 0, define the filenames of the database's parents.

An optional set of parameters, "print-params", specifies whether or not parameters should be printed as they are used (through one of the get(...) methods). If print-params is unset, or set to false or FALSE, nothing is printed. If set to non-false, then the parameters are printed prepended with a "P:" when their values are requested, "E:" when their existence is tested. Prior to the "P:" or "E:" you may see a "!" (meaning that the parameter isn't in the database), or a "<" (meaning that the parameter was a default parameter which was never looked up because the primary parameter contained the value).

When you create a ParameterDatabase using new ParameterDatabase(), it is created thus:

`DATABASE:`	`database`
`FROM:`	`(empty)`

When you create a ParameterDatabase using new ParameterDatabase( file ), it is created by loading the database file, and its parent file tree, thus:

`DATABASE:`	`database`	`->`	`parent0`	`+->`	`parent0`	`+->`	`parent0`	`+->`	`....`
`FROM:`	`(empty)`		`(file)`	`\|`	`(parent.0)`	`\|`	`(parent.0)`		`....`
				`\|`		`+->`	`parent1`	`+->`	`....`
				`\|`		`\|`	`(parent.1)`
				`\|`		`....`
				`\|`
				`+->`	`parent1`	`+->`	`....`
				`\|`	`(parent.1)`
				`....`

When you create a ParameterDatabase using new ParameterDatabase( file,argv ), the preferred way, it is created thus:

`DATABASE:`	`database`	`->`	`parent0`	`+->`	`parent0`	`+->`	`parent0`	`+->`	`parent0`	`+->`	`....`
`FROM:`	`(empty)`		`(argv)`		`(file)`	`\|`	`(parent.0)`	`\|`	`(parent.0)`		`....`
						`\|`		`+->`	`parent1`	`+->`	`....`
						`\|`		`\|`	`(parent.1)`
						`\|`		`....`
						`\|`
						`+->`	`parent1`	`+->`	`....`
						`\|`	`(parent.1)`
						`....`

...that is, the actual top database is empty, and stores parameters added programmatically; its parent is a database formed from arguments passed in on the command line; its parent is the parameter database which actually loads from foo. This allows you to programmatically add parameters which override those in foo, then delete them, thus bringing foo's parameters back in view.

Once a parameter database is loaded, you query it with the get methods. The database, then its parents, are searched until a match is found for your parameter. The search rules are thus: (1) the root database is searched first. (2) If a database being searched doesn't contain the data, it searches its parents recursively, starting with parent 0, then moving up, until all searches are exhausted or something was found. (3) No database is searched twice.

The various get methods all take two parameters. The first parameter is fetched and retrieved first. If that fails, the second one (known as the default parameter) is fetched and retrieved. You can pass in null for the default parameter if you don't have one.

You can test a parameter for existence with the exists methods.

You can set a parameter (in the topmost database only with the set command. The remove command removes a parameter from the topmost database only. The removeDeeply command removes that parameter from every database.

The values stored in a parameter database must not contain "#", "=", non-ascii values, or whitespace.

Note for JDK 1.1 . Finally recovering from stupendous idiocy, JDK 1.2 included parseDouble() and parseFloat() commands; now you can READ A FLOAT FROM A STRING without having to create a Float object first! Anyway, you will need to modify the getFloat() method below if you're running on JDK 1.1, but understand that large numbers of calls to the method may be inefficient. Sample JDK 1.1 code is given with those methods, but is commented out.

Version:: 1.0
Author:: Sean Luke
See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) Hashtable`	`accessed`
`static String`	`C_CLASS`
`static String`	`C_HERE`
`(package private) boolean`	`checked`
`(package private) File`	`directory`
`(package private) Hashtable`	`gotten`
`(package private) String`	`label`
`(package private) Vector`	`parents`
`static String`	`PRINT_PARAMS`
`int`	`printState`
`static int`	`PS_NONE`
`static int`	`PS_PRINT_PARAMS`
`static int`	`PS_UNKNOWN`
`(package private) Class`	`relativeClass`
`(package private) String`	`relativePath`
`static String`	`UNKNOWN_VALUE`

Fields inherited from class java.util.Properties
defaults

Constructor Summary

Constructors
Constructor and Description
`ParameterDatabase()` Creates an empty parameter database.
`ParameterDatabase(Dictionary map)` Creates a new parameter database from the given Dictionary.
`ParameterDatabase(File file)` Creates a new parameter database tree from a given database file and its parent files.
`ParameterDatabase(File file, String[] args)` Creates a new parameter database from a given database file and argv list.
`ParameterDatabase(InputStream stream)` Creates a new parameter database loaded from the given stream.
`ParameterDatabase(String pathNameRelativeToClassFile, Class cls)` Creates a new parameter database loaded from a parameter file located relative to a class file, wherever the class file may be (such as in a jar).
`ParameterDatabase(String pathNameRelativeToClassFile, Class cls, String[] args)` Creates a new parameter database from a given database file and argv list.

Method Summary

Methods
Modifier and Type	Method and Description
`(package private) void`	`_addNodeForParameter(DefaultTreeModel model, DefaultMutableTreeNode root, String key)`
`(package private) void`	`_buildTreeModel(DefaultTreeModel model, DefaultMutableTreeNode root)`
`(package private) File`	`_directoryFor(Parameter parameter)` Private helper function
`(package private) boolean`	`_exists(Parameter parameter)`
`(package private) String`	`_get(String parameter)` Private helper function
`(package private) ParameterDatabase`	`_getLocation(String parameter)` Private helper function
`(package private) Set`	`_getShadowedValues(Parameter parameter, Set vals)`
`(package private) void`	`_list(PrintWriter p, boolean listShadowed, String prefix, Hashtable gather)` Private helper function.
`(package private) void`	`_removeDeeply(Parameter parameter)` Private helper function
`void`	`addParent(ParameterDatabase database)`
`TreeModel`	`buildTreeModel()` Builds a TreeModel from the available property keys.
`(package private) static String`	`concatenatedJarPath(URL original, String path)`
`(package private) static URL`	`concatenatedJarResource(URL original, String path)`
`(package private) static URL`	`defaultResourceURL(Class cls)`
`(package private) File`	`directoryFor(Parameter parameter)` Searches down through databases to find the directory for the database which holds a given parameter.
`boolean`	`exists(Parameter parameter)` Deprecated. use exists(Parameter, null)
`boolean`	`exists(Parameter parameter, Parameter defaultParameter)` Returns true if either parameter or defaultParameter exists in the database
`(package private) String`	`get(Parameter parameter)`
`(package private) 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 down through databases to find a given parameter; If the parameter does not exist, defaultValue is returned.
`Class`	`getClassForParameter(Parameter parameter, Parameter defaultParameter, Class mustCastTosuperclass)` Searches down through databases to find a given parameter.
`(package private) double`	`getDouble(Parameter parameter)`
`(package private) double`	`getDouble(Parameter parameter, double minValue)` Searches down through databases to find a given parameter, whose value must be a double >= minValue.
`(package private) double`	`getDouble(Parameter parameter, double minValue, double maxValue)` Searches down through databases to find a given parameter, whose value must be a double >= minValue and <= maxValue.
`double`	`getDouble(Parameter parameter, Parameter defaultParameter)`
`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)` Deprecated. use getDoubleWithMax instead
`(package private) double`	`getDoubleWithDefault(Parameter parameter, double defaultValue)` Searches down through databases to find a given parameter, which must be a float.
`double`	`getDoubleWithDefault(Parameter parameter, Parameter defaultParameter, double defaultValue)` Searches down through databases to find a given parameter, which must be a float.
`double`	`getDoubleWithMax(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.
`(package private) File`	`getFile(Parameter parameter)` Searches down through the databases to find a given parameter, whose value must be an absolute or relative path name.
`File`	`getFile(Parameter parameter, Parameter defaultParameter)` Searches down through the databases to find a given parameter, whose value must be an absolute or relative path name.
`(package private) float`	`getFloat(Parameter parameter)`
`(package private) float`	`getFloat(Parameter parameter, double minValue)` Searches down through databases to find a given parameter, whose value must be a float >= minValue.
`(package private) float`	`getFloat(Parameter parameter, double minValue, double maxValue)` Searches down through databases to find a given parameter, whose value must be a float >= minValue and <= maxValue.
`float`	`getFloat(Parameter parameter, Parameter defaultParameter)`
`float`	`getFloat(Parameter parameter, Parameter defaultParameter, double minValue)` Searches down through databases to find a given parameter, whose value must be a float >= minValue.
`float`	`getFloat(Parameter parameter, Parameter defaultParameter, double minValue, double maxValue)` Deprecated. Use getFloatWithMax instead
`(package private) float`	`getFloatWithDefault(Parameter parameter, double defaultValue)` Searches down through databases to find a given parameter, which must be a float.
`float`	`getFloatWithDefault(Parameter parameter, Parameter defaultParameter, double defaultValue)` Searches down through databases to find a given parameter, which must be a float.
`float`	`getFloatWithMax(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.
`Object`	`getInstanceForParameter(Parameter parameter, Parameter defaultParameter, 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 .
`Object`	`getInstanceForParameterEq(Parameter parameter, Parameter defaultParameter, 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 .
`(package private) int`	`getInt(Parameter parameter)` Searches down through databases to find a given parameter, whose value must be an integer.
`(package private) int`	`getInt(Parameter parameter, int minValue)` Searches down through databases to find a given parameter, whose value must be an integer >= minValue.
`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.
`(package private) int`	`getIntWithDefault(Parameter parameter, int defaultValue)` Searches down through databases to find a given parameter, which must be an integer.
`int`	`getIntWithDefault(Parameter parameter, Parameter defaultParameter, int defaultValue)` Searches down through databases to find a given parameter, which must be an integer.
`(package private) int`	`getIntWithMax(Parameter parameter, int minValue, int maxValue)` Searches down through databases to find a given parameter, whose value must be an integer >= minValue and <= maxValue.
`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.
`String`	`getLabel()` Returns a String describing the location of the ParameterDatabase holding this parameter, or "" if there is none.
`ParameterDatabase`	`getLocation(Parameter parameter)`
`ParameterDatabase`	`getLocation(String parameter)`
`(package private) long`	`getLong(Parameter parameter)` Searches down through databases to find a given parameter, whose value must be a long.
`(package private) long`	`getLong(Parameter parameter, long minValue)` Searches down through databases to find a given parameter, whose value must be a long >= minValue.
`(package private) long`	`getLong(Parameter parameter, long minValue, long maxValue)` Deprecated.
`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.
`(package private) long`	`getLongWithDefault(Parameter parameter, long defaultValue)` Searches down through databases to find a given parameter, which must be a long.
`long`	`getLongWithDefault(Parameter parameter, Parameter defaultParameter, long defaultValue)` Searches down through databases to find a given parameter, which must be a long.
`(package private) long`	`getLongWithMax(Parameter parameter, long minValue, long maxValue)` Use getLongWithMax(...) instead.
`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.
`(package private) InputStream`	`getResource(Parameter parameter)`
`InputStream`	`getResource(Parameter parameter, Parameter defaultParameter)` Searches down through the databases to find a given parameter, whose value must be an absolute or relative path name.
`Set`	`getShadowedValues(Parameter parameter)`
`(package private) String`	`getString(Parameter parameter)` Searches down through databases to find a given parameter.
`String`	`getString(Parameter parameter, Parameter defaultParameter)` Searches down through databases to find a given parameter.
`String`	`getStringWithDefault(Parameter parameter, Parameter defaultParameter, String defaultValue)` Searches down through databases to find a given parameter.
`(package private) String`	`getStringWithDefault(Parameter parameter, String defaultValue)` Searches down through databases to find a given parameter.
`(package private) int`	`indexOfFirstWhitespace(String s)`
`(package private) static boolean`	`isJarFile(URL url)`
`void`	`list(PrintWriter p)` Prints out all the parameters in the database, but not shadowed parameters.
`void`	`list(PrintWriter p, boolean listShadowed)` Prints out all the parameters in the database.
`void`	`listAccessed(PrintWriter p)` Prints out all the parameters marked as accessed ("gotten" by some getFoo(...) method), plus their values.
`void`	`listGotten(PrintWriter p)` Prints out all the parameters marked as used, plus their values.
`void`	`listNotAccessed(PrintWriter p)` Prints out all the parameters NOT marked as used, plus their values.
`void`	`listNotGotten(PrintWriter p)` Prints out all the parameters NOT marked as used, plus their values.
`static void`	`main(String[] args)` Test the ParameterDatabase
`(package private) int`	`parseInt(String string)` Parses an integer from a string, either in decimal or (if starting with an x) in hex
`(package private) long`	`parseLong(String string)` Parses a long from a string, either in decimal or (if starting with an x) in hex
`(package private) void`	`printGotten(Parameter parameter, Parameter defaultParameter, boolean exists)`
`void`	`remove(Parameter parameter)` Removes a parameter from the topmost database.
`void`	`removeDeeply(Parameter parameter)` Deprecated. You shouldn't modify parent databases
`void`	`set(Parameter parameter, String value)` Sets a parameter in the topmost database to a given value, trimmed of whitespace.
`(package private) static String`	`simplifyPath(String pathname)`
`String`	`toString()`
`(package private) void`	`uncheck()` Clears the checked flag

Methods inherited from class java.util.Properties
getProperty, getProperty, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable
clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - C_HERE
```
public static final String C_HERE
```
    See Also:
    Constant Field Values
  - C_CLASS
```
public static final String C_CLASS
```
    See Also:
    Constant Field Values
  - UNKNOWN_VALUE
```
public static final String UNKNOWN_VALUE
```
    See Also:
    Constant Field Values
  - PRINT_PARAMS
```
public static final String PRINT_PARAMS
```
    See Also:
    Constant Field Values
  - PS_UNKNOWN
```
public static final int PS_UNKNOWN
```
    See Also:
    Constant Field Values
  - PS_NONE
```
public static final int PS_NONE
```
    See Also:
    Constant Field Values
  - PS_PRINT_PARAMS
```
public static final int PS_PRINT_PARAMS
```
    See Also:
    Constant Field Values
  - printState
```
public int printState
```
  - label
```
String label
```
  - parents
```
Vector parents
```
  - directory
```
File directory
```
  - checked
```
boolean checked
```
  - gotten
```
Hashtable gotten
```
  - accessed
```
Hashtable accessed
```
  - relativeClass
```
Class relativeClass
```
  - relativePath
```
String relativePath
```
- Constructor Detail
  - ParameterDatabase
```
public ParameterDatabase()
```
    Creates an empty parameter database.
  - ParameterDatabase
```
public ParameterDatabase(Dictionary map)
                  throws FileNotFoundException,
                         IOException
```
    Creates a new parameter database from the given Dictionary. Both the keys and values will be run through toString() before adding to the dataase. Keys are parameters. Values are the values of the parameters. Beware that a ParameterDatabase is itself a Dictionary; but if you pass one in here you will only get the lowest-level elements. If parent.n are defined, parents will be attempted to be loaded -- that's the reason for the FileNotFoundException and IOException.
    
    Throws:
    
    FileNotFoundException
    
    IOException
  - ParameterDatabase
```
public ParameterDatabase(String pathNameRelativeToClassFile,
                 Class cls,
                 String[] args)
                  throws FileNotFoundException,
                         IOException
```
    Creates a new parameter database from a given database file and argv list. The top-level database is completely empty, pointing to a second database which contains the parameter entries stored in args, which points to a tree of databases constructed using ParameterDatabase(filename).
    
    Throws:
    
    FileNotFoundException
    
    IOException
  - ParameterDatabase
```
public ParameterDatabase(String pathNameRelativeToClassFile,
                 Class cls)
                  throws FileNotFoundException,
                         IOException
```
    Creates a new parameter database loaded from a parameter file located relative to a class file, wherever the class file may be (such as in a jar). 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:
    
    FileNotFoundException
    
    IOException
  - ParameterDatabase
```
public ParameterDatabase(InputStream stream)
                  throws FileNotFoundException,
                         IOException
```
    Creates a new parameter database loaded from the given stream. Non-relative parents are not permitted. If parent.n are defined, parents will be attempted to be loaded -- that's the reason for the FileNotFoundException and IOException.
    
    Throws:
    
    FileNotFoundException
    
    IOException
  - ParameterDatabase
```
public ParameterDatabase(File file)
                  throws FileNotFoundException,
                         IOException
```
    Creates a new parameter database tree from a given database file and its parent files.
    
    Throws:
    
    FileNotFoundException
    
    IOException
  - ParameterDatabase
```
public ParameterDatabase(File file,
                 String[] args)
                  throws FileNotFoundException,
                         IOException
```
    Creates a new parameter database from a given database file and argv list. The top-level database is completely empty, pointing to a second database which contains the parameter entries stored in args, which points to a tree of databases constructed using ParameterDatabase(file).
    
    Throws:
    
    FileNotFoundException
    
    IOException
- Method Detail
  - getInstanceForParameter
```
public Object getInstanceForParameter(Parameter parameter,
                             Parameter defaultParameter,
                             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".
    
    Throws:
    
    ParamClassLoadException
  - getInstanceForParameterEq
```
public Object getInstanceForParameterEq(Parameter parameter,
                               Parameter defaultParameter,
                               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".
    
    Throws:
    
    ParamClassLoadException
  - getClassForParameter
```
public Class getClassForParameter(Parameter parameter,
                         Parameter defaultParameter,
                         Class mustCastTosuperclass)
                           throws ParamClassLoadException
```
    Searches down through databases to find a given parameter. The value associated with this parameter must be a full Class name, and the class must be a descendent of but not equal to mustCastTosuperclass . Loads and returns the associated Class, 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".
    
    Throws:
    
    ParamClassLoadException
  - getBoolean
```
public boolean getBoolean(Parameter parameter,
                 Parameter defaultParameter,
                 boolean defaultValue)
```
    Searches down through databases to find a given parameter; If the parameter does not exist, defaultValue is returned. If the parameter exists, and it is set to "false" (case insensitive), false is returned. Else true is returned. The parameter chosen is marked "used" if it exists.
  - getBoolean
```
boolean getBoolean(Parameter parameter,
                 boolean defaultValue)
```
    Searches down through databases to find a given parameter; If the parameter does not exist, defaultValue is returned. If the parameter exists, and it is set to "false" (case insensitive), false is returned. Else true is returned. The parameter chosen is marked "used" if it exists.
  - parseInt
```
int parseInt(String string)
       throws NumberFormatException
```
    Parses an integer from a string, either in decimal or (if starting with an x) in hex
    
    Throws:
    
    NumberFormatException
  - parseLong
```
long parseLong(String string)
         throws NumberFormatException
```
    Parses a long from a string, either in decimal or (if starting with an x) in hex
    
    Throws:
    
    NumberFormatException
  - getInt
```
int getInt(Parameter parameter)
     throws 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.
    
    Throws:
    
    NumberFormatException
  - getInt
```
public int getInt(Parameter parameter,
         Parameter defaultParameter)
           throws 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.
    
    Throws:
    
    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.
  - getInt
```
int getInt(Parameter parameter,
         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.
  - 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.
  - getIntWithDefault
```
int getIntWithDefault(Parameter parameter,
                    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.
  - 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.
  - getIntWithMax
```
int getIntWithMax(Parameter parameter,
                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.
  - getFloat
```
float getFloat(Parameter parameter)
         throws NumberFormatException
```
    Throws:
    
    NumberFormatException
  - getFloat
```
public float getFloat(Parameter parameter,
             Parameter defaultParameter)
               throws NumberFormatException
```
    Throws:
    
    NumberFormatException
  - getFloat
```
public float getFloat(Parameter parameter,
             Parameter defaultParameter,
             double minValue)
```
    Searches down through databases to find a given parameter, whose value must be a float >= minValue. If not, this method returns minvalue-1, else it returns the parameter value. The parameter chosen is marked "used" if it exists.
  - getFloat
```
float getFloat(Parameter parameter,
             double minValue)
```
    Searches down through databases to find a given parameter, whose value must be a float >= minValue. If not, this method returns minvalue-1, else it returns the parameter value. The parameter chosen is marked "used" if it exists.
  - 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.
  - getFloatWithDefault
```
float getFloatWithDefault(Parameter parameter,
                        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.
  - getFloatWithMax
```
public float getFloatWithMax(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.
  - getFloat
```
public float getFloat(Parameter parameter,
             Parameter defaultParameter,
             double minValue,
             double maxValue)
```
    Deprecated. Use getFloatWithMax instead
    
    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.
  - getFloat
```
float getFloat(Parameter parameter,
             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.
  - getDouble
```
double getDouble(Parameter parameter)
           throws NumberFormatException
```
    Throws:
    
    NumberFormatException
  - getDouble
```
public double getDouble(Parameter parameter,
               Parameter defaultParameter)
                 throws NumberFormatException
```
    Throws:
    
    NumberFormatException
  - 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.
  - getDouble
```
double getDouble(Parameter parameter,
               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.
  - getDoubleWithMax
```
public double getDoubleWithMax(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.
  - getDouble
```
public double getDouble(Parameter parameter,
               Parameter defaultParameter,
               double minValue,
               double maxValue)
```
    Deprecated. use getDoubleWithMax instead
    
    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.
  - getDouble
```
double getDouble(Parameter parameter,
               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.
  - 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.
  - getDoubleWithDefault
```
double getDoubleWithDefault(Parameter parameter,
                          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.
  - getLong
```
long getLong(Parameter parameter)
       throws 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.
    
    Throws:
    
    NumberFormatException
  - getLong
```
public long getLong(Parameter parameter,
           Parameter defaultParameter)
             throws 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.
    
    Throws:
    
    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 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.
  - getLong
```
long getLong(Parameter parameter,
           long minValue)
```
    Searches down through databases to find a given parameter, whose value must be a long >= minValue. 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.
  - 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.
  - getLongWithDefault
```
long getLongWithDefault(Parameter parameter,
                      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.
  - 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.
  - getLongWithMax
```
long getLongWithMax(Parameter parameter,
                  long minValue,
                  long maxValue)
```
    Use getLongWithMax(...) instead. 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.
  - getLong
```
public long getLong(Parameter parameter,
           Parameter defaultParameter,
           long minValue,
           long maxValue)
```
    Deprecated.
    
    Use getLongWithMax(...) instead. 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.
  - getLong
```
long getLong(Parameter parameter,
           long minValue,
           long maxValue)
```
    Deprecated.
    
    Use getLongWithMax(...) instead. 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.
  - getFile
```
public File getFile(Parameter parameter,
           Parameter defaultParameter)
```
    Searches down through the databases to find a given parameter, whose value must be an absolute or relative path name. If it is absolute, a File is made based on the path name. If it is relative, a file is made by resolving the path name with respect to the directory in which the file was which defined this ParameterDatabase in the ParameterDatabase hierarchy. If the parameter is not found, this returns null. The File is not checked for validity. The parameter chosen is marked "used" if it exists.
  - getFile
```
File getFile(Parameter parameter)
```
    Searches down through the databases to find a given parameter, whose value must be an absolute or relative path name. If the parameter begins with a "$", a file is made based on the relative path name and returned directly. Otherwise, if it is absolute, a File is made based on the path name, or if it is relative, a file is made by resolving the path name with respect to the directory in which the file was which defined this ParameterDatabase in the ParameterDatabase hierarchy. If the parameter is not found, this returns null. The File is not checked for validity. The parameter chosen is marked "used" if it exists.
  - getResource
```
public InputStream getResource(Parameter parameter,
                      Parameter defaultParameter)
```
    Searches down through the databases to find a given parameter, whose value must be an absolute or relative path name. If it is absolute, a file is made based on the path name, and an InputStream is opened on the file and returned. If the path name begins with "$", then an InputStream is opened on a file relative to the directory where the system was started. Otherwise if the path name is relative, an InputStream is made by resolving the path name with respect to the directory in which the file was which defined this ParameterDatabase in the ParameterDatabase hierarchy, be it in the file system or in a jar file. If the parameter is not found, this returns null. If no such file exists, null is also returned. The parameter chosen is marked "used" if it exists.
  - indexOfFirstWhitespace
```
int indexOfFirstWhitespace(String s)
```
  - getResource
```
InputStream getResource(Parameter parameter)
```
  - getString
```
public 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.
  - getString
```
String getString(Parameter parameter)
```
    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.
  - getStringWithDefault
```
public String getStringWithDefault(Parameter parameter,
                          Parameter defaultParameter,
                          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.
  - getStringWithDefault
```
String getStringWithDefault(Parameter parameter,
                          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.
  - uncheck
```
void uncheck()
```
    Clears the checked flag
  - set
```
public void set(Parameter parameter,
       String value)
```
    Sets a parameter in the topmost database to a given value, trimmed of whitespace.
  - listGotten
```
public void listGotten(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 "?????")
  - listNotGotten
```
public void listNotGotten(PrintWriter p)
```
    Prints out all the parameters NOT marked as used, plus their values.
  - listNotAccessed
```
public void listNotAccessed(PrintWriter p)
```
    Prints out all the parameters NOT marked as used, plus their values.
  - listAccessed
```
public void listAccessed(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.
  - exists
```
public boolean exists(Parameter parameter)
```
    Deprecated. use exists(Parameter, null)
    
    Returns true if parameter exist in the database
  - _exists
```
boolean _exists(Parameter parameter)
```
  - exists
```
public boolean exists(Parameter parameter,
             Parameter defaultParameter)
```
    Returns true if either parameter or defaultParameter exists in the database
  - printGotten
```
void printGotten(Parameter parameter,
               Parameter defaultParameter,
               boolean exists)
```
  - get
```
String get(Parameter parameter)
```
  - _get
```
String _get(String parameter)
```
    Private helper function
  - getLocation
```
public ParameterDatabase getLocation(Parameter parameter)
```
  - getLocation
```
public ParameterDatabase getLocation(String parameter)
```
  - _getLocation
```
ParameterDatabase _getLocation(String parameter)
```
    Private helper function
  - _getShadowedValues
```
Set _getShadowedValues(Parameter parameter,
                     Set vals)
```
  - getShadowedValues
```
public Set getShadowedValues(Parameter parameter)
```
  - directoryFor
```
File directoryFor(Parameter parameter)
```
    Searches down through databases to find the directory for the database which holds a given parameter. Returns the directory name or null if not found.
  - _directoryFor
```
File _directoryFor(Parameter parameter)
```
    Private helper function
  - getLabel
```
public String getLabel()
```
    Returns a String describing the location of the ParameterDatabase holding this parameter, or "" if there is none.
  - remove
```
public void remove(Parameter parameter)
```
    Removes a parameter from the topmost database.
  - removeDeeply
```
public void removeDeeply(Parameter parameter)
```
    Deprecated. You shouldn't modify parent databases
    
    Removes a parameter from the database and all its parent databases.
  - _removeDeeply
```
void _removeDeeply(Parameter parameter)
```
    Private helper function
  - addParent
```
public void addParent(ParameterDatabase database)
```
  - defaultResourceURL
```
static URL defaultResourceURL(Class cls)
```
  - isJarFile
```
static boolean isJarFile(URL url)
```
  - concatenatedJarPath
```
static String concatenatedJarPath(URL original,
                         String path)
```
  - concatenatedJarResource
```
static URL concatenatedJarResource(URL original,
                          String path)
```
  - simplifyPath
```
static String simplifyPath(String pathname)
```
  - list
```
public void list(PrintWriter p)
```
    Prints out all the parameters in the database, but not shadowed parameters.
    
    Overrides:
    
    list in class Properties
  - list
```
public void list(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.
  - _list
```
void _list(PrintWriter p,
         boolean listShadowed,
         String prefix,
         Hashtable gather)
```
    Private helper function.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Hashtable<Object,Object>
  - buildTreeModel
```
public TreeModel buildTreeModel()
```
    Builds a TreeModel from the available property keys.
  - _buildTreeModel
```
void _buildTreeModel(DefaultTreeModel model,
                   DefaultMutableTreeNode root)
```
  - _addNodeForParameter
```
void _addNodeForParameter(DefaultTreeModel model,
                        DefaultMutableTreeNode root,
                        String key)
```
    Parameters:
    model -
    root -
    e -
  - main
```
public static void main(String[] args)
                 throws FileNotFoundException,
                        IOException
```
    Test the ParameterDatabase
    
    Throws:
    
    FileNotFoundException
    
    IOException

Class ParameterDatabase

Field Summary

Fields inherited from class java.util.Properties

Constructor Summary

Method Summary

Methods inherited from class java.util.Properties

Methods inherited from class java.util.Hashtable

Methods inherited from class java.lang.Object

Field Detail

C_HERE

C_CLASS

UNKNOWN_VALUE

PRINT_PARAMS

PS_UNKNOWN

PS_NONE

PS_PRINT_PARAMS

printState

label

parents

directory

checked

gotten

accessed

relativeClass

relativePath

Constructor Detail

ParameterDatabase

ParameterDatabase

ParameterDatabase

ParameterDatabase

ParameterDatabase

ParameterDatabase

ParameterDatabase

Method Detail

getInstanceForParameter

getInstanceForParameterEq

getClassForParameter

getBoolean

getBoolean

parseInt

parseLong

getInt

getInt

getInt

getInt

getIntWithDefault

getIntWithDefault

getIntWithMax

getIntWithMax

getFloat

getFloat

getFloat

getFloat

getFloatWithDefault

getFloatWithDefault

getFloatWithMax

getFloat

getFloat

getDouble

getDouble

getDouble

getDouble

getDoubleWithMax

getDouble

getDouble

getDoubleWithDefault

getDoubleWithDefault

getLong

getLong

getLong

getLong

getLongWithDefault

getLongWithDefault

getLongWithMax

getLongWithMax

getLong

getLong

getFile

getFile

getResource