com.flyingspaniel.nava.hash

Class Hash

java.lang.Object

com.flyingspaniel.nava.hash.Hash

public class Hash
extends Object

Since:

Copyright (c) 2013 by Morgan Conrad Utilities to simplify reading values from a Map

Typical name is getType(Map map, String key, Type...or)

Almost all methods take the varargs or... argument. Only the 0th value is ever used. If present, and the key is not in the map, the or[0] will be returned If not present, and the key is not in the map, a NoSuchKeyException will be thrown

Author:

Morgan Conrad

See Also:

This software is released under the MIT License

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Hash.NoSuchKeyException

Constructor Summary

Constructors

Constructor and Description
Hash()

Method Summary

Methods

Modifier and Type	Method and Description
static Object	get(Map<String,?> map, String key, boolean mustBePresent) Get the value for that key (mainly used internally)
static boolean	getBoolean(Map<String,?> map, String key, boolean... or) Return the value for that key, converted to a boolean
static double	getDouble(Map<String,?> map, String key, double... or) Return the value for that key, converted to a double
static int	getInt(Map<String,?> map, String key, int... or) Return the value for that key, converted to a int
static List<Object>	getList(Map<String,Object> map, String key, boolean create) Return the value for that key, converted to a List
static Map<String,Object>	getMap(Map<String,Object> map, String key, boolean create) Return the value for that key, converted to a Map (e.g.
static Object	getObject(Map<String,?> map, String key, Object defaultObject) Return an Object from the map
static String	getString(Map<String,?> map, String key)
static String	getString(Map<String,?> map, String key, String... or) Return the value for that key, converted to a String

Methods inherited from class java.lang.Object

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

Constructor Detail

Hash

public Hash()

Method Detail

get

public static Object get(Map<String,?> map,
         String key,
         boolean mustBePresent)

Get the value for that key (mainly used internally)

Parameters:

map - may be null

key - generally non-null

mustBePresent - if true, and key does not exist, will throw a NoSuchKeyException

Returns:

value, possibly null iff !mustBePresent

getBoolean

public static boolean getBoolean(Map<String,?> map,
                 String key,
                 boolean... or)

Return the value for that key, converted to a boolean

Parameters:

map - non-null

key - generally non-null

or - optional

Returns:

boolean

getDouble

public static double getDouble(Map<String,?> map,
               String key,
               double... or)

Return the value for that key, converted to a double

Parameters:

map - non-null

key - generally non-null

or - optional

Returns:

double

getInt

public static int getInt(Map<String,?> map,
         String key,
         int... or)

Return the value for that key, converted to a int

Parameters:

map - non-null

key - generally non-null

or - optional

Returns:

int

getList

public static List<Object> getList(Map<String,Object> map,
                   String key,
                   boolean create)

Return the value for that key, converted to a List