info.bioinfweb.commons.collections

Class ParameterMap

java.lang.Object

java.util.AbstractMap<K,V>

java.util.TreeMap<java.lang.String,java.lang.Object>

info.bioinfweb.commons.collections.ParameterMap

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>, java.util.NavigableMap<java.lang.String,java.lang.Object>, java.util.SortedMap<java.lang.String,java.lang.Object>

Direct Known Subclasses:

ApplicationLoggerParameterMap

public class ParameterMap
extends java.util.TreeMap<java.lang.String,java.lang.Object>

Class that stores different objects by string keys. Methods that return theses values directly as basic java types are available. Instances of this class can e.g. be used to specify varying and extensible sets of parameters to methods without having to change their signature.

Author:

Ben Stöver

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor and Description
ParameterMap()

Method Summary

Modifier and Type	Method and Description
ApplicationLogger	getApplicationLogger(java.lang.String key) Returns the application logger registered for the specified key.
ApplicationLogger	getApplicationLogger(java.lang.String key, ApplicationLogger defaultValue) Checks if a ApplicationLogger object is stored under the specified key.
boolean	getBoolean(java.lang.String key, boolean defaultValue) Checks if a Boolean object is stored under the specified key.
double	getDouble(java.lang.String key, double defaultValue) Checks if a Double object is stored under the specified key.If the stored object has another numeric type, it is converted to double.
java.io.File	getFile(java.lang.String key) Checks if a File object is stored under the specified key.
java.io.File	getFile(java.lang.String key, java.io.File defaultValue) Checks if a File object is stored under the specified key.
float	getFloat(java.lang.String key, float defaultValue) Checks if a Float object is stored under the specified key.
int	getInteger(java.lang.String key, int defaultValue) Checks if a Integer object is stored under the specified key.
long	getLong(java.lang.String key, long defaultValue) Checks if a Long object is stored under the specified key.
java.lang.Object	getObject(java.lang.String key, java.lang.Object defaultValue) Returns the stored object for the key or defaultValue if no object is found.
<O> O	getObject(java.lang.String key, O defaultValue, java.lang.Class<O> objectClass) Returns the stored object for the key if it is an instance of the specified class.
java.lang.String	getString(java.lang.String key) Checks if an object is stored under the specified key.
java.lang.String	getString(java.lang.String key, java.lang.String defaultValue) Checks if an object is stored under the specified key.

Methods inherited from class java.util.TreeMap

ceilingEntry, ceilingKey, clear, clone, comparator, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, forEach, get, headMap, headMap, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, put, putAll, remove, replace, replace, replaceAll, size, subMap, subMap, tailMap, tailMap, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove

Constructor Detail

ParameterMap

public ParameterMap()

Method Detail

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.String defaultValue)

Checks if an object is stored under the specified key. If so the result of Object.toString() is returned, otherwise defaultValue is returned.

Parameters:

key - the key under which the result is stored

defaultValue - the value to be returned, if no appropriate object is found

Returns:

the string representation of the stored object or defaultValue

getString

public java.lang.String getString(java.lang.String key)

Checks if an object is stored under the specified key. If so the result of Object.toString() is returned, otherwise null is returned.

Parameters:

key - the key under which the result is stored

Returns:

the string representation of the stored object or null

getFloat

public float getFloat(java.lang.String key,
                      float defaultValue)

Checks if a Float object is stored under the specified key. (Objects of the types Integer or Long are converted.) If the stored object has another type or no object is found, defaultValue is returned.

Parameters:

key - the key under which the result is stored

defaultValue - the value to be returned, if no appropriate object is found

Returns:

an appropriate object or defaultValue

getDouble

public double getDouble(java.lang.String key,
                        double defaultValue)

Checks if a Double object is stored under the specified key.If the stored object has another numeric type, it is converted to double. If it has a non-numeric type or no object is found, defaultValue is returned.

Parameters:

key - the key under which the result is stored

defaultValue - the value to be returned, if no appropriate object is found

Returns:

an appropriate object or defaultValue

getInteger

public int getInteger(java.lang.String key,
                      int defaultValue)

Checks if a Integer object is stored under the specified key. If the stored object has another type or no object is found, defaultValue is returned.

Parameters:

key - the key under which the result is stored

defaultValue - the value to be returned, if no appropriate object is found

Returns:

an appropriate object or defaultValue

getLong

public long getLong(java.lang.String key,
                    long defaultValue)

Checks if a Long object is stored under the specified key. (Objects of the types Integer are converted.) If the stored object has another type or no object is found, defaultValue is returned.

Parameters:

key - the key under which the result is stored

defaultValue - the value to be returned, if no appropriate object is found

Returns:

an appropriate object or defaultValue

getBoolean

public boolean getBoolean(java.lang.String key,
                          boolean defaultValue)

Checks if a Boolean object is stored under the specified key. If the stored object has another type or no object is found, defaultValue is returned.

Parameters:

key - the key under which the result is stored

defaultValue - the value to be returned, if no appropriate object is found

Returns:

an appropriate object or defaultValue

getFile

public java.io.File getFile(java.lang.String key,
                            java.io.File defaultValue)

Checks if a File object is stored under the specified key. If the stored object has another type or no object is found, defaultValue is returned. (This method does not convert String objects into File objects, even if the string represents a valid file path.)

Parameters:

key - the key under which the result is stored

defaultValue - the value to be returned, if no appropriate object is found

Returns:

an appropriate object or defaultValue

getFile

public java.io.File getFile(java.lang.String key)

Checks if a File object is stored under the specified key. If the stored object has another type or no object is found, null is returned. (This method does not convert String objects into File objects, even if the string represents a valid file path.)

Parameters:

key - the key under which the result is stored

Returns:

an appropriate object or null

getApplicationLogger

public ApplicationLogger getApplicationLogger(java.lang.String key,
                                              ApplicationLogger defaultValue)

Checks if a ApplicationLogger object is stored under the specified key. If the stored object has another type or no object is found, defaultValue is returned.

Parameters:

key - the key under which the result is stored

defaultValue - the value to be returned, if no appropriate object is found

Returns:

an appropriate object or defaultValue

getApplicationLogger

public ApplicationLogger getApplicationLogger(java.lang.String key)

Returns the application logger registered for the specified key.

If no objects with this key is contained in the map, an new instance of VoidApplicationLogger is created, add to the map and returned.

Parameters:

key - the key indent

Returns:

the application logger stored (from now on) for the specified key

Throws:

java.lang.IllegalArgumentException - if an object, that is not an instance of ApplicationLogger is contained in the map under the specified key

getObject

public java.lang.Object getObject(java.lang.String key,
                                  java.lang.Object defaultValue)

Returns the stored object for the key or defaultValue if no object is found.

Parameters:

key - the key under which the result is stored

defaultValue - the value to be returned, if no appropriate object is found

Returns:

the stored object or defaultValue

getObject

public <O> O getObject(java.lang.String key,
                       O defaultValue,
                       java.lang.Class<O> objectClass)

Returns the stored object for the key if it is an instance of the specified class. Otherwise defaultValue is returned.

Type Parameters:

O - the class of the object to be returned

Parameters:

key - the key under which the result is stored

defaultValue - the value to be returned, if no appropriate object is found

objectClass - the class the returned object must have

Returns:

the stored object or defaultValue