Package com.reportmill.base

Class RMMapUtils

java.lang.Object

com.reportmill.base.RMMapUtils

public class RMMapUtils
extends java.lang.Object

Utility methods for use with Java.util.Map.

Constructor Summary

Constructors

Constructor	Description
RMMapUtils()

Method Summary

Modifier and Type	Method	Description
static java.lang.Object	anyElement(java.util.Map aMap)	Returns any element from a map.
static boolean	boolValue(java.util.Map aMap, java.lang.String aKey)	Returns a key value interpreted as a boolean.
static boolean	boolValue(java.util.Map aMap, java.lang.String aKey, boolean defaultValue)	Returns a key value interpreted as a boolean (with optional default value).
static java.util.Map	clone(java.util.Map aMap)	Clones a map.
static float	floatValue(java.util.Map aMap, java.lang.String aKey)	Returns a key value interpreted as a float.
static float	floatValue(java.util.Map aMap, java.lang.String aKey, float defaultValue)	Returns a key value interpreted as a float (with optional default value).
static java.lang.Object	get(java.util.Map aMap, java.lang.Object aKey)	Returns value for aKey in given map (accepts null map).
static java.lang.Object	get(java.util.Map aMap, java.lang.Object aKey, java.lang.Object defaultValue)	Returns value for aKey in given map with an optional default value for missing keys.
static java.lang.Object	getKey(java.util.Map aMap, java.lang.Object aValue)	Returns the key for a given object in the given map.
static java.lang.Object	getKeyIdentical(java.util.Map aMap, java.lang.Object aValue)	Returns the key for a given identical object in the given map.
static int	intValue(java.util.Map aMap, java.lang.String aKey)	Returns a key value interpreted as an int.
static int	intValue(java.util.Map aMap, java.lang.String aKey, int defaultValue)	Returns a key value interpreted as an int (with optional default value).
static java.util.Map	newMap(java.lang.Object aKey, java.lang.Object anObj)	Creates a new map for given key and object.
static void	put(java.util.Map aMap, java.lang.String aKey, java.lang.Object aValue)	Adds given key and value to given map (removes key if value is null).
static java.util.Map	putAllIfAbsent(java.util.Map m1, java.util.Map m2, boolean copyIfAbsent)	Same as putAll, but only adds absent keys (option to copy if there are absent keys).
static void	rename(java.util.Map aMap, java.lang.Object aKey, java.lang.Object newKey)	Renames a key in a map to a new key.
static int	size(java.util.Map aMap)	Returns the size of given map (accepts null map).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RMMapUtils

public RMMapUtils()

Method Detail

newMap

public static java.util.Map newMap(java.lang.Object aKey,
                                   java.lang.Object anObj)

Creates a new map for given key and object.

size

public static int size(java.util.Map aMap)

Returns the size of given map (accepts null map).

get

public static java.lang.Object get(java.util.Map aMap,
                                   java.lang.Object aKey)

Returns value for aKey in given map (accepts null map).

get

public static java.lang.Object get(java.util.Map aMap,
                                   java.lang.Object aKey,
                                   java.lang.Object defaultValue)

Returns value for aKey in given map with an optional default value for missing keys.

put

public static void put(java.util.Map aMap,
                       java.lang.String aKey,
                       java.lang.Object aValue)

Adds given key and value to given map (removes key if value is null).

rename

public static void rename(java.util.Map aMap,
                          java.lang.Object aKey,
                          java.lang.Object newKey)

Renames a key in a map to a new key.

clone

public static java.util.Map clone(java.util.Map aMap)

Clones a map.

boolValue

public static boolean boolValue(java.util.Map aMap,
                                java.lang.String aKey)

Returns a key value interpreted as a boolean.

boolValue

public static boolean boolValue(java.util.Map aMap,
                                java.lang.String aKey,
                                boolean defaultValue)

Returns a key value interpreted as a boolean (with optional default value).

intValue

public static int intValue(java.util.Map aMap,
                           java.lang.String aKey)

Returns a key value interpreted as an int.

intValue

public static int intValue(java.util.Map aMap,
                           java.lang.String aKey,
                           int defaultValue)

Returns a key value interpreted as an int (with optional default value).

floatValue

public static float floatValue(java.util.Map aMap,
                               java.lang.String aKey)

Returns a key value interpreted as a float.

floatValue

public static float floatValue(java.util.Map aMap,
                               java.lang.String aKey,
                               float defaultValue)

Returns a key value interpreted as a float (with optional default value).

putAllIfAbsent

public static java.util.Map putAllIfAbsent(java.util.Map m1,
                                           java.util.Map m2,
                                           boolean copyIfAbsent)

Same as putAll, but only adds absent keys (option to copy if there are absent keys).

getKey

public static java.lang.Object getKey(java.util.Map aMap,
                                      java.lang.Object aValue)

Returns the key for a given object in the given map.

getKeyIdentical

public static java.lang.Object getKeyIdentical(java.util.Map aMap,
                                               java.lang.Object aValue)

Returns the key for a given identical object in the given map.

anyElement

public static java.lang.Object anyElement(java.util.Map aMap)

Returns any element from a map.