NonsharedParameters (de.mpg.mpi-inf:javatools 1.1 API)

java.lang.Object
- javatools.administrative.NonsharedParameters

All Implemented Interfaces:

Cloneable
```
public class NonsharedParameters
extends Object
implements Cloneable
```
Copyright 2016 Daniel Baer Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. This is a nonshared, i.e. instantiable variation of the Parameters class. It allows to have different parameter settings handled simultaneously, i.e. each component (or each component instance) using NonsharedParameters can maintain its own parameters. This allows, for instance, that two components running at the same time work on different databases, both obtained through their own NonsharedParameters instance. While the old 'Parameters' class is more convenient to use (less objects passed around), this version makes it easier to integrate your components with other components that also use the Parameters/NonsharedParameters to load (and maintain) their settings. Therefore please consider using the NonsharedParameters instead of the Parameters, if your code may ever be used in parallel with another project that might use one of the Parameters classes. Provides an interface for an ini-File. The ini-File may contain parameters of the form
```
  parameterName = value
  ...
  
```
It may also contain comments or section headers (i.e. anything that does not match the above pattern). Parameter names are not case sensitive. Initial and terminal spaces are trimmed for both parameter names and values. Boolean parameters accept multiple ways of expressing "true" (namely "on", "true", "yes" and "active"). You may also use ${param} constructs to refer to parameters set earlier, these references are replaced at the time the file is read by the current value of 'param' (null if it does not have a value!) Alternatively you can use $[param] references, they will be replaced by the current value of 'param' at runtime. Thus, param could be set/overriden after the actual reference appears, i.e. always reflects current settings. This class does function as an object. Example:
```
    // Read data from my.ini
    NonsharedParameters params = new NonsharedParameters("my.ini");
    // Abort with error message if the following parameters are not specified
    params.ensureParameters(
       "firstPar - some help text for the first parameter",
       "secondPar - some help text for the secondparameter"
    );
    // Retrieve the value of a parameter
    String p=params.get("firstPar");
  
```
You can load parameters from multiple files. These will overlay. You can reference a .ini file in another .ini file using the 'include' parameter, included files will be loaded at the point of the 'include' statements, parameter settings following the include statement can overwrite parameter settings of this included ini file. Example: Content of main.ini:
```
     //load database configuration
     include = db_myserver.ini
     // overwrite or add parameters
     databasePort = 5555
     myOtherParameter = 4
   
```
Content of db_myserver.ini:
```
     databaseSystem = postgres
     databaseDatabase = example
     databaseUser = albert
     databaseHost = localhost
     databasePort = 5432
   
```
If main.ini is loaded, the 'databasePort' parameter will have value '5555' in the resulting NonsharedParameters instance. Include is recursive, make sure you do not generate a cycle!

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`NonsharedParameters.ParameterFileException` Reading or writing the parameters ini file failed for some reason In some cases the enclosing program might resolve the issue by providing another file
`static class`	`NonsharedParameters.UndefinedParameterException` Thrown for an undefined Parameter

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`basePath` Holds the path that should be assumed to be the base path to the current directory for all local path values
`File`	`iniFile` Holds the filename of the ini-file
`static Pattern`	`INIPATTERN` Holds the pattern used for ini-file-entries
`static FinalSet<String>`	`no` Holds words that count as "no" for boolean parameters
`static Pattern`	`READTIMEVARIABLEPATTERN`
`static Pattern`	`RUNTIMVARIABLEPATTERN`
`Map<String,String>`	`values` Contains the values for the parameters

Constructor Summary

Constructors
Constructor and Description
`NonsharedParameters()` Constructors
`NonsharedParameters(File iniFile)`
`NonsharedParameters(File iniFile, String localPath)`
`NonsharedParameters(NonsharedParameters other)`
`NonsharedParameters(String iniFile)`
`NonsharedParameters(String iniFile, String localPath)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`add(String key, String value)` Adds a value to the map and to the ini file, if not yet there
`NonsharedParameters`	`clone()` Cloning implementation
`void`	`ensureParameters(String... p)` Reports an error message and aborts if the parameters are undefined.
`String`	`get(String s)` Returns a value for a parameter
`String`	`get(String s, String defaultValue)` Returns a value for a parameter, returning a default value by default
`boolean`	`getBoolean(String s)` Returns a value for a boolean parameter
`boolean`	`getBoolean(String s, boolean defaultValue)` Returns a value for a boolean parameter, returning a default value by default
`boolean`	`getBooleanArgument(String[] args, String... argnames)` Parses the arguments of the main method and tells whether a parameter is on or off
`Boolean`	`getBooleanObject(String s)` Returns a value for a boolean parameter
`Boolean`	`getBooleanObject(String s, Boolean defaultValue)` Returns a value for a boolean parameter, returning a default value by default
`Database`	`getDatabase()` Returns the database defined in this ini-file
`double`	`getDouble(String s)` Returns a value for an integer parameter
`Double`	`getDouble(String s, Double defaultValue)` Returns a value for an integer parameter returning the default value if undefined
`File`	`getFile(String s)` Returns a value for a file or folder parameter; same as getPath but returns an actual File instance
`File`	`getFile(String s, File defaultValue)` Returns a value for a file or folder parameter, returning the default value if undefined; same as getPath but returns an actual File instance
`float`	`getFloat(String s)` Returns a value for an integer parameter
`float`	`getFloat(String s, float defaultValue)` Returns a value for an integer parameter returning the default value if undefined
`Float`	`getFloatObject(String s)` Returns a value for an integer parameter
`Float`	`getFloatObject(String s, Float defaultValue)` Returns a value for an integer parameter returning the default value if undefined
`int`	`getInt(String s)` Returns a value for an integer parameter
`int`	`getInt(String s, int defaultValue)` Returns a value for an integer parameter returning the default value if undefined
`Integer`	`getInteger(String s)` Returns a value for an integer parameter as Integer object
`Integer`	`getInteger(String s, Integer defaultValue)` Returns a value for an integer parameter returning the default value if undefined
`List<String>`	`getList(String s)` Returns a value for a list parameter
`Map<String,String>`	`getMap(String s)` Returns a value for a map parameter
`String`	`getMapEntry(String s, String key)` Returns a value for a map parameter
`String`	`getOrRequest(String s, String description)` Returns a value for a parameter.
`String`	`getOrRequestAndAdd(String s, String description)` Returns a value for a parameter.
`boolean`	`getOrRequestAndAddBoolean(String s, String description)` Returns a value for a parameter.
`boolean`	`getOrRequestBoolean(String s, String description)` Returns a value for a parameter.
`File`	`getOrRequestFileParameter(String s, String description)` Returns a value for a parameter.
`int`	`getOrRequestInteger(String s, String description)` Returns a value for a parameter.
`String`	`getPath(String s)` Returns a value for a file or folder parameter; same as getFile but returns the path as String also adjusts local paths such that a global path is returned (if a base path is set)
`String`	`getPath(String s, String defaultValue)` Returns a value for a file or folder parameter, returning the default value if undefined; same as getFile but returns the path as String
`Timestamp`	`getTimestamp(String s)` Returns a value for a date parameter;
`Timestamp`	`getTimestamp(String s, Timestamp defaultValue)` Returns a value for a date parameter, returning the default value if undefined;
`URI`	`getURI(String s)` Returns a URI built from a given parameter's value
`URI`	`getURI(String s, URI defaultValue)` Returns a URI built from a given parameter's value, but returns a given default value if the parameter is undefined
`URL`	`getURL(String s)` Returns a URL built from a given parameter's value
`URL`	`getURL(String s, URL defaultValue)` Returns a URL built from a given parameter's value, but returns a given default value if the parameter is undefined
`void`	`init(File f)` Initializes the parameters from a file
`void`	`init(File f, boolean mainIni)`
`void`	`init(String filename)` Initializes the parameters from a file
`void`	`init(String file, boolean mainIni)`
`void`	`init(String filename, File... folders)` Seeks the file in all given folders
`void`	`initiateAllClassAttributes(Object object)` Checks for all full-upper-case class attributes whether there is a matching parameter and sets its value to the parameter value.
`void`	`initiateClassAttributes(Object object)` Checks for all full-upper-case class attributes whether there is a matching parameter and sets its value to the parameter value.
`void`	`initiateClassAttributes(String className, Object object)` Checks for all full-upper-case class attributes whether there is a matching parameter and sets its value to the parameter value.
`boolean`	`isDefined(String s)` Tells whether a parameter is defined
`static void`	`main(String[] args)` Test routine
`Object`	`matchObjectAttribut(Field field)` Deprecated.
`Set<String>`	`parameters()` Returns all defined parameters
`String`	`remove(String parameter)` Removes a value from the mapping (NOT: from the file)
`void`	`reset()` Deletes all current values
`void`	`saveAs(String file)` Stores the parameters in a given file
`void`	`set(String param, String value)` sets a value for a parameter

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

Field Detail
- iniFile
```
public File iniFile
```
  Holds the filename of the ini-file
- basePath
```
public String basePath
```
  Holds the path that should be assumed to be the base path to the current directory for all local path values
- values
```
public Map<String,String> values
```
  Contains the values for the parameters
- INIPATTERN
```
public static Pattern INIPATTERN
```
  Holds the pattern used for ini-file-entries
- READTIMEVARIABLEPATTERN
```
public static Pattern READTIMEVARIABLEPATTERN
```
- RUNTIMVARIABLEPATTERN
```
public static Pattern RUNTIMVARIABLEPATTERN
```
- no
```
public static FinalSet<String> no
```
  Holds words that count as "no" for boolean parameters

Constructor Detail

NonsharedParameters
```
public NonsharedParameters()
```
Constructors

NonsharedParameters

public NonsharedParameters(File iniFile)
                    throws NonsharedParameters.ParameterFileException

Throws:: NonsharedParameters.ParameterFileException

NonsharedParameters

public NonsharedParameters(String iniFile)
                    throws NonsharedParameters.ParameterFileException

Throws:: NonsharedParameters.ParameterFileException

NonsharedParameters

public NonsharedParameters(File iniFile,
                           String localPath)
                    throws NonsharedParameters.ParameterFileException

Throws:: NonsharedParameters.ParameterFileException

NonsharedParameters

public NonsharedParameters(String iniFile,
                           String localPath)
                    throws NonsharedParameters.ParameterFileException

Throws:: NonsharedParameters.ParameterFileException

NonsharedParameters

public NonsharedParameters(NonsharedParameters other)

Method Detail

clone
```
public NonsharedParameters clone()
```
Cloning implementation

Overrides:

clone in class Object

getTimestamp

public Timestamp getTimestamp(String s)
                       throws NonsharedParameters.UndefinedParameterException

Returns a value for a date parameter;

Throws:: NonsharedParameters.UndefinedParameterException

getTimestamp

public Timestamp getTimestamp(String s,
                              Timestamp defaultValue)
                       throws NonsharedParameters.UndefinedParameterException

Returns a value for a date parameter, returning the default value if undefined;

Throws:: NonsharedParameters.UndefinedParameterException

getPath
```
public String getPath(String s)
               throws NonsharedParameters.UndefinedParameterException
```
Returns a value for a file or folder parameter; same as getFile but returns the path as String also adjusts local paths such that a global path is returned (if a base path is set)

Throws:

NonsharedParameters.UndefinedParameterException

getPath
```
public String getPath(String s,
                      String defaultValue)
               throws NonsharedParameters.UndefinedParameterException
```
Returns a value for a file or folder parameter, returning the default value if undefined; same as getFile but returns the path as String

Throws:

NonsharedParameters.UndefinedParameterException

getFile
```
public File getFile(String s)
             throws NonsharedParameters.UndefinedParameterException
```
Returns a value for a file or folder parameter; same as getPath but returns an actual File instance

Throws:

NonsharedParameters.UndefinedParameterException

getFile
```
public File getFile(String s,
                    File defaultValue)
             throws NonsharedParameters.UndefinedParameterException
```
Returns a value for a file or folder parameter, returning the default value if undefined; same as getPath but returns an actual File instance

Throws:

NonsharedParameters.UndefinedParameterException

getURI

public URI getURI(String s)
           throws NonsharedParameters.UndefinedParameterException,
                  URISyntaxException

Returns a URI built from a given parameter's value

Throws:: URISyntaxException; NonsharedParameters.UndefinedParameterException

getURI

public URI getURI(String s,
                  URI defaultValue)
           throws NonsharedParameters.UndefinedParameterException,
                  URISyntaxException

Returns a URI built from a given parameter's value, but returns a given default value if the parameter is undefined

Throws:: URISyntaxException; NonsharedParameters.UndefinedParameterException

getURL

public URL getURL(String s)
           throws NonsharedParameters.UndefinedParameterException,
                  MalformedURLException

Returns a URL built from a given parameter's value

Throws:: MalformedURLException; NonsharedParameters.UndefinedParameterException

getURL

public URL getURL(String s,
                  URL defaultValue)
           throws NonsharedParameters.UndefinedParameterException,
                  MalformedURLException

Returns a URL built from a given parameter's value, but returns a given default value if the parameter is undefined

Throws:: MalformedURLException; NonsharedParameters.UndefinedParameterException

getInteger
```
public Integer getInteger(String s)
                   throws NonsharedParameters.UndefinedParameterException
```
Returns a value for an integer parameter as Integer object

Throws:

NonsharedParameters.UndefinedParameterException

getInteger

public Integer getInteger(String s,
                          Integer defaultValue)
                   throws NonsharedParameters.UndefinedParameterException

Returns a value for an integer parameter returning the default value if undefined

Throws:: NonsharedParameters.UndefinedParameterException

getInt
```
public int getInt(String s)
           throws NonsharedParameters.UndefinedParameterException
```
Returns a value for an integer parameter

Throws:

NonsharedParameters.UndefinedParameterException

getInt
```
public int getInt(String s,
                  int defaultValue)
           throws NonsharedParameters.UndefinedParameterException
```
Returns a value for an integer parameter returning the default value if undefined

Throws:

NonsharedParameters.UndefinedParameterException

getFloatObject

public Float getFloatObject(String s)
                     throws NonsharedParameters.UndefinedParameterException

Returns a value for an integer parameter

Throws:: NonsharedParameters.UndefinedParameterException

getFloatObject

public Float getFloatObject(String s,
                            Float defaultValue)
                     throws NonsharedParameters.UndefinedParameterException

Returns a value for an integer parameter returning the default value if undefined

Throws:: NonsharedParameters.UndefinedParameterException

getFloat

public float getFloat(String s)
               throws NonsharedParameters.UndefinedParameterException

Returns a value for an integer parameter

Throws:: NonsharedParameters.UndefinedParameterException

getFloat

public float getFloat(String s,
                      float defaultValue)
               throws NonsharedParameters.UndefinedParameterException

Returns a value for an integer parameter returning the default value if undefined

Throws:: NonsharedParameters.UndefinedParameterException

getDouble

public double getDouble(String s)
                 throws NonsharedParameters.UndefinedParameterException

Returns a value for an integer parameter

Throws:: NonsharedParameters.UndefinedParameterException

getDouble

public Double getDouble(String s,
                        Double defaultValue)
                 throws NonsharedParameters.UndefinedParameterException

Returns a value for an integer parameter returning the default value if undefined

Throws:: NonsharedParameters.UndefinedParameterException

getBooleanObject

public Boolean getBooleanObject(String s)
                         throws NonsharedParameters.UndefinedParameterException

Returns a value for a boolean parameter

Throws:: NonsharedParameters.UndefinedParameterException

getBooleanObject

public Boolean getBooleanObject(String s,
                                Boolean defaultValue)

Returns a value for a boolean parameter, returning a default value by default

getBoolean

public boolean getBoolean(String s)
                   throws NonsharedParameters.UndefinedParameterException

Returns a value for a boolean parameter

Throws:: NonsharedParameters.UndefinedParameterException

getBoolean

public boolean getBoolean(String s,
                          boolean defaultValue)

Returns a value for a boolean parameter, returning a default value by default

getList

public List<String> getList(String s)
                     throws NonsharedParameters.UndefinedParameterException

Returns a value for a list parameter

Throws:: NonsharedParameters.UndefinedParameterException

getMap

public Map<String,String> getMap(String s)
                          throws NonsharedParameters.UndefinedParameterException

Returns a value for a map parameter

Throws:: NonsharedParameters.UndefinedParameterException

getMapEntry

public String getMapEntry(String s,
                          String key)
                   throws NonsharedParameters.UndefinedParameterException

Returns a value for a map parameter

Throws:: NonsharedParameters.UndefinedParameterException

get

public String get(String s)
           throws NonsharedParameters.UndefinedParameterException

Returns a value for a parameter

Throws:: NonsharedParameters.UndefinedParameterException

get

public String get(String s,
                  String defaultValue)

Returns a value for a parameter, returning a default value by default

getOrRequest

public String getOrRequest(String s,
                           String description)

Returns a value for a parameter. If not present, asks the user for it

getOrRequestAndAdd

public String getOrRequestAndAdd(String s,
                                 String description)
                          throws IOException

Returns a value for a parameter. If not present, asks the user for it and adds it

Throws:: IOException

getOrRequestAndAddBoolean

public boolean getOrRequestAndAddBoolean(String s,
                                         String description)
                                  throws IOException

Returns a value for a parameter. If not present, asks the user for it and adds it

Throws:: IOException

getOrRequestFileParameter

public File getOrRequestFileParameter(String s,
                                      String description)

Returns a value for a parameter. If not present, asks the user for it

getOrRequestBoolean

public boolean getOrRequestBoolean(String s,
                                   String description)

Returns a value for a parameter. If not present, asks the user for it

getOrRequestInteger

public int getOrRequestInteger(String s,
                               String description)

Returns a value for a parameter. If not present, asks the user for it

add

public void add(String key,
                String value)
         throws IOException

Adds a value to the map and to the ini file, if not yet there

Throws:: IOException

remove
```
public String remove(String parameter)
```
Removes a value from the mapping (NOT: from the file)

set

public void set(String param,
                String value)

sets a value for a parameter

init
```
public void init(File f)
          throws NonsharedParameters.ParameterFileException
```
Initializes the parameters from a file

Throws:

NonsharedParameters.ParameterFileException

init

public void init(File f,
                 boolean mainIni)
          throws NonsharedParameters.ParameterFileException

Throws:: NonsharedParameters.ParameterFileException

init

public void init(String filename,
                 File... folders)
          throws NonsharedParameters.ParameterFileException

Seeks the file in all given folders

Throws:: NonsharedParameters.ParameterFileException

init

public void init(String filename)
          throws NonsharedParameters.ParameterFileException

Initializes the parameters from a file

Throws:: NonsharedParameters.ParameterFileException

init

public void init(String file,
                 boolean mainIni)
          throws NonsharedParameters.ParameterFileException

Throws:: NonsharedParameters.ParameterFileException

isDefined
```
public boolean isDefined(String s)
```
Tells whether a parameter is defined

ensureParameters
```
public void ensureParameters(String... p)
```
Reports an error message and aborts if the parameters are undefined. p may contain strings of the form "parametername explanation"

getBooleanArgument

public boolean getBooleanArgument(String[] args,
                                  String... argnames)

Parses the arguments of the main method and tells whether a parameter is on or off

reset
```
public void reset()
```
Deletes all current values

getDatabase

public Database getDatabase()
                     throws SQLException,
                            InstantiationException,
                            IllegalAccessException,
                            ClassNotFoundException

Returns the database defined in this ini-file

Throws:: SQLException; InstantiationException; IllegalAccessException; ClassNotFoundException

matchObjectAttribut
```
@Deprecated
public Object matchObjectAttribut(Field field)
                                       throws IllegalAccessException
```
Deprecated.

Checks whether a parameter matching the field name is available. There are two ways to declare attributes to configurable parameters, either write them all upper case of use the prefix "cp_"; in the latter case the prefix is ignored when matching parameters to the field. Returns the parameter value in the format corresponding the field.

Parameters:

field - the attribute against which to match the parameters

Returns:

an object representing the value of a parameter that matches the given attribute iff there is a match, otherwise null Note this will become protected, please use the initiateClassAttributes method (if it does not work for you, let me(Steffen) know TODO: make protected

Throws:

IllegalAccessException

initiateClassAttributes
```
public void initiateClassAttributes(String className,
                                    Object object)
```
Checks for all full-upper-case class attributes whether there is a matching parameter and sets its value to the parameter value.

Parameters:

className - name of the class for which to check

object - object, which needs to be an instance of the given class

initiateAllClassAttributes
```
public void initiateAllClassAttributes(Object object)
```
Checks for all full-upper-case class attributes whether there is a matching parameter and sets its value to the parameter value. Does this also for parameters inherited from super-classes.

Parameters:

object - object, which needs to be an instance of the given class

initiateClassAttributes
```
public void initiateClassAttributes(Object object)
```
Checks for all full-upper-case class attributes whether there is a matching parameter and sets its value to the parameter value.

Parameters:

object - object, which needs to be an instance of the given class

parameters
```
public Set<String> parameters()
```
Returns all defined parameters

saveAs

public void saveAs(String file)
            throws NonsharedParameters.ParameterFileException

Stores the parameters in a given file

Throws:: NonsharedParameters.ParameterFileException

main

public static void main(String[] args)
                 throws Exception

Test routine

Throws:: Exception

Class NonsharedParameters

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

iniFile

basePath

values

INIPATTERN

READTIMEVARIABLEPATTERN

RUNTIMVARIABLEPATTERN

no

Constructor Detail

NonsharedParameters

NonsharedParameters

NonsharedParameters

NonsharedParameters

NonsharedParameters

NonsharedParameters

Method Detail

clone

getTimestamp

getTimestamp

getPath

getPath

getFile

getFile

getURI

getURI

getURL

getURL

getInteger

getInteger

getInt

getInt

getFloatObject

getFloatObject

getFloat

getFloat

getDouble

getDouble

getBooleanObject

getBooleanObject

getBoolean

getBoolean

getList

getMap

getMapEntry

get

get

getOrRequest

getOrRequestAndAdd

getOrRequestAndAddBoolean

getOrRequestFileParameter

getOrRequestBoolean

getOrRequestInteger

add

remove

set

init

init

init

init

init

isDefined

ensureParameters

getBooleanArgument

reset

getDatabase

matchObjectAttribut

initiateClassAttributes

initiateAllClassAttributes

initiateClassAttributes

parameters

saveAs

main