public class PropertyDefaultSource extends java.lang.Object implements DefaultSource
A DefaultSource with values defined in a java.util.Properties object. In order to determine which parameter a value is associated with, each property key is first compared to each parameter's unique ID. Failing a match, each parameter's long flag is checked, and finally the short flags are checked. A PropertyDefaultSource may contain a mix of IDs, long flags, and short flags.
A PropertyDefaultSource is also incredibly useful as a configuration file loader. Multiple PropertyDefaultSources can be chained together in a JSAP in order to prioritize their entries (e.g., load "~/myproject.conf" first, then "/etc/myproject.conf").
DefaultSource
,
Properties
Constructor and Description |
---|
PropertyDefaultSource(java.io.InputStream in,
boolean throwIOExceptions)
Creates a new PropertyDefaultSource based upon the specified InputStream.
|
PropertyDefaultSource(java.util.Properties properties)
Creates a new PropertyDefaultSource based upon the specified Properties
object.
|
PropertyDefaultSource(java.lang.String propertyFileName,
boolean throwIOExceptions)
Creates a new PropertyDefaultSource by loading the specified file.
|
Modifier and Type | Method and Description |
---|---|
Defaults |
getDefaults(IDMap idMap,
ExceptionMap exceptionMap)
Returns a Defaults object based upon this PropertyDefaultSource's
properties and the specified IDMap.
|
public PropertyDefaultSource(java.lang.String propertyFileName, boolean throwIOExceptions)
propertyFileName
- the name of the properties file containing the
default values.throwIOExceptions
- if true, any encountered IOExceptions will be
re-thrown. Set this to false
if you want to ignore any exceptions (e.g., specified file does not
exist).public PropertyDefaultSource(java.util.Properties properties)
properties
- the Properties object containing the default values.public PropertyDefaultSource(java.io.InputStream in, boolean throwIOExceptions)
in
- the InputStream containing the Properties.throwIOExceptions
- if true, any encountered IOExceptions will be
re-thrown.public Defaults getDefaults(IDMap idMap, ExceptionMap exceptionMap)
getDefaults
in interface DefaultSource
idMap
- the IDMap containing the current JSAP configuration.exceptionMap
- the ExceptionMap object within which any encountered
exceptions will be thrown.ExceptionMap.addException(String,Exception)
Copyright © 2002-2006, Martian Software, Inc.. All Rights Reserved.
For the latest version and documentation, please visit http://www.martiansoftware.com/jsap