com.softwareag.connectivity

Class MapHelper

java.lang.Object

com.softwareag.connectivity.MapHelper

public final class MapHelper
extends java.lang.Object

Helper class for extracting values from a java.util.Map<String,Object> in a type-safe way with error checking and support for default values.

This class will be deprecated in a future release; we recommend using the MapExtractor class for this purpose instead.

See Also:

MapExtractor

Method Summary

Modifier and Type	Method and Description
static boolean	getBoolean(java.util.Map<?,?> map, java.lang.String key) Get a boolean value from the specified map, throwing an exception if it is not present.
static boolean	getBoolean(java.util.Map<?,?> map, java.lang.String key, boolean defaultValue) Get a boolean value from the specified map, returning a specified default value if it is not present.
static double	getDouble(java.util.Map<?,?> map, java.lang.String key) Get a double value from the specified map, throwing an exception if it is not present.
static double	getDouble(java.util.Map<?,?> map, java.lang.String key, double defaultValue) Get a double value from the specified map, returning a specified default value if it is not present.
static long	getInteger(java.util.Map<?,?> map, java.lang.String key) Get a long value from the specified map, throwing an exception if it is not present.
static long	getInteger(java.util.Map<?,?> map, java.lang.String key, long defaultValue) Get a long value from the specified map, returning a specified default value if it is not present.
static java.util.List<java.lang.Object>	getList(java.util.Map<?,?> map, java.lang.String key) Get a List value from the specified map, throwing an exception if it is not present.
static java.util.List<java.lang.Object>	getList(java.util.Map<?,?> map, java.lang.String key, java.util.List<?> defaultValue) Get a List value from the specified map, returning a specified default value if it is not present.
static java.util.Map<java.lang.Object,java.lang.Object>	getMap(java.util.Map<?,?> map, java.lang.String key) Get a Map value from the specified map, throwing an exception if it is not present.
static java.util.Map<java.lang.Object,java.lang.Object>	getMap(java.util.Map<?,?> map, java.lang.String key, java.util.Map<?,?> defaultValue) Get a Map value from the specified map, returning a specified default value if it is not present.
static java.lang.String	getString(java.util.Map<?,?> map, java.lang.String key) Get a String value from the specified map, throwing an exception if it is not present.
static java.lang.String	getString(java.util.Map<?,?> map, java.lang.String key, java.lang.String defaultValue) Get a String value from the specified map, returning a specified default value if it is not present.

Methods inherited from class java.lang.Object

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

Method Detail

getString

public static java.lang.String getString(java.util.Map<?,?> map,
                                         java.lang.String key,
                                         java.lang.String defaultValue)
                                  throws java.lang.IllegalArgumentException

Get a String value from the specified map, returning a specified default value if it is not present.

Parameters:

map - May be null

key -

Returns:

Either defaultValue, or the non-null value for this key.

Throws:

java.lang.IllegalArgumentException

getString

public static java.lang.String getString(java.util.Map<?,?> map,
                                         java.lang.String key)
                                  throws java.lang.IllegalArgumentException

Get a String value from the specified map, throwing an exception if it is not present.

Parameters:

map - May be null

key -

Returns:

Never null

Throws:

java.lang.IllegalArgumentException

getBoolean

public static boolean getBoolean(java.util.Map<?,?> map,
                                 java.lang.String key,
                                 boolean defaultValue)
                          throws java.lang.IllegalArgumentException

Get a boolean value from the specified map, returning a specified default value if it is not present.

Parameters:

map - May be null

key -

Returns:

Either defaultValue, or the value for this property name.

Throws:

java.lang.IllegalArgumentException

getBoolean

public static boolean getBoolean(java.util.Map<?,?> map,
                                 java.lang.String key)
                          throws java.lang.IllegalArgumentException

Get a boolean value from the specified map, throwing an exception if it is not present.

Parameters:

map - May be null

key -

Returns:

Throws:

java.lang.IllegalArgumentException

getInteger

public static long getInteger(java.util.Map<?,?> map,
                              java.lang.String key,
                              long defaultValue)
                       throws java.lang.IllegalArgumentException

Get a long value from the specified map, returning a specified default value if it is not present.

Parameters:

map - May be null

key -

Returns:

Either defaultValue, or the value for this property name.

Throws:

java.lang.IllegalArgumentException

getInteger

public static long getInteger(java.util.Map<?,?> map,
                              java.lang.String key)
                       throws java.lang.IllegalArgumentException

Get a long value from the specified map, throwing an exception if it is not present.

Parameters:

map - May be null

key -

Returns:

Throws:

java.lang.IllegalArgumentException

getDouble

public static double getDouble(java.util.Map<?,?> map,
                               java.lang.String key,
                               double defaultValue)
                        throws java.lang.IllegalArgumentException

Get a double value from the specified map, returning a specified default value if it is not present.

Parameters:

map - May be null

key -

Returns:

Either defaultValue, or the value for this property name.

Throws:

java.lang.IllegalArgumentException

getDouble

public static double getDouble(java.util.Map<?,?> map,
                               java.lang.String key)
                        throws java.lang.IllegalArgumentException

Get a double value from the specified map, throwing an exception if it is not present.

Parameters:

map - May be null

key -

Returns:

Throws:

java.lang.IllegalArgumentException

getMap

public static java.util.Map<java.lang.Object,java.lang.Object> getMap(java.util.Map<?,?> map,
                                                                      java.lang.String key,
                                                                      java.util.Map<?,?> defaultValue)
                                                               throws java.lang.IllegalArgumentException

Get a Map value from the specified map, returning a specified default value if it is not present.

Parameters:

map - May be null

key -

Returns:

Either defaultValue, or the value for this property name.

Throws:

java.lang.IllegalArgumentException

getMap

public static java.util.Map<java.lang.Object,java.lang.Object> getMap(java.util.Map<?,?> map,
                                                                      java.lang.String key)
                                                               throws java.lang.IllegalArgumentException

Get a Map value from the specified map, throwing an exception if it is not present.

Parameters:

map - May be null

key -

Returns:

Throws:

java.lang.IllegalArgumentException

getList

public static java.util.List<java.lang.Object> getList(java.util.Map<?,?> map,
                                                       java.lang.String key,
                                                       java.util.List<?> defaultValue)
                                                throws java.lang.IllegalArgumentException

Get a List value from the specified map, returning a specified default value if it is not present.

Parameters:

map - May be null

key -

Returns:

Either defaultValue, or the value for this property name.

Throws:

java.lang.IllegalArgumentException

getList

public static java.util.List<java.lang.Object> getList(java.util.Map<?,?> map,
                                                       java.lang.String key)
                                                throws java.lang.IllegalArgumentException

Get a List value from the specified map, throwing an exception if it is not present.

Parameters:

map - May be null

key -

Returns:

Throws:

java.lang.IllegalArgumentException