org.apache.juneau

Class ObjectMap

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<String,Object>

org.apache.juneau.ObjectMap

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

Direct Known Subclasses:

Args, DelegateMap, ManifestFile, ResolvingObjectMap, RestContextProperties, RestMethodProperties

public class ObjectMap
extends LinkedHashMap<String,Object>

Java implementation of a JSON object.

An extension of LinkedHashMap, so all methods available in that class are also available to this class.

Note that the use of this class is optional. The serializers will accept any objects that implement the Map interface. But this class provides some useful additional functionality when working with JSON models constructed from Java Collections Framework objects. For example, a constructor is provided for converting a JSON object string directly into a Map. It also contains accessor methods for to avoid common typecasting when accessing elements in a list.

Example:

// Construct an empty Map Map m = new ObjectMap(); // Construct a Map from JSON String json = "{a:'A',b:{c:'C',d:123}}"; m = new ObjectMap(json); // Construct a Map using the append method m = new ObjectMap().append("foo","x").append("bar",123) .append("baz",true); // Construct a Map from XML generated by XmlSerializer String xml = "<object><a type='string'>A</a><b type='object'><c type='string'>C</c><d type='number'>123</d></b></object>"; m = new ObjectMap(xml, DataFormat.XML); m = (Map)XmlParser.DEFAULT.parse(xml); // Equivalent m = (Map)XmlParser.DEFAULT.parse(Object.class, xml); // Equivalent m = XmlParser.DEFAULT.parse(Map.class, xml); // Equivalent m = XmlParser.DEFAULT.parse(ObjectMap.class, xml); // Equivalent // Construct a Map from a URL GET parameter string generated by UrlEncodingParser String urlParams = "?a='A'&b={c:'C',d:123}"; m = new ObjectMap(urlParams, DataFormat.URLPARAM); m = (Map)UrlEncodingParser.DEFAULT.parse(Object.class, xml); // Equivalent m = UrlEncodingParser.DEFAULT.parse(Map.class, xml); // Equivalent m = UrlEncodingParser.DEFAULT.parse(ObjectMap.class, xml); // Equivalent // Construct JSON from ObjectMap m = new ObjectMap("{foo:'bar'},{baz:[123,true]}"); json = m.toString(); // Produces "{foo:'bar'},{baz:[123,true]}" json = m.toString(JsonSerializer.DEFAULT_CONDENSED); // Equivalent json = JsonSerializer.DEFAULT_CONDENSED.serialize(m); // Equivalent // Get a map entry as an Integer m = new ObjectMap("{foo:123}"); Integer i = m.getInt("foo"); i = m.get(Integer.class, "foo"); // Equivalent // Get a map entry as a Float m = new ObjectMap("{foo:123}"); Float f = m.getFloat("foo"); f = m.get(Float.class, "foo"); // Equivalent // Same as above, except converted to a String m = new ObjectMap("{foo:123}"); String s = m.getString("foo"); // Returns "123" s = m.get(String.class, "foo"); // Equivalent // Get one of the entries in the list as a bean (converted to a bean if it isn't already one) m = new ObjectMap("{person:{name:'John Smith',age:45}}"); Person p = m.get(Person.class, "person"); // Add an inner map ObjectMap m1 = new ObjectMap("{a:1}"); ObjectMap m2 = new ObjectMap("{b:2}").setInner(m1); int a = m2.getInt("a"); // a == 1

This class is not thread safe.

See Also:

Serialized Form

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static ObjectMap	EMPTY_MAP An empty read-only ObjectMap.

Constructor Summary

Constructors

Constructor and Description
ObjectMap() Construct an empty JSON object (i.e.
ObjectMap(BeanSession session) Construct an empty JSON object (i.e.
ObjectMap(CharSequence s) Shortcut for new ObjectMap(string,JsonParser.DEFAULT);
ObjectMap(CharSequence s, Parser p) Construct an ObjectMap directly from a string using the specified parser.
ObjectMap(Map<?,?> m) Construct a JSON object and fill it with the contents from the specified Map.
ObjectMap(Reader r) Shortcut for new ObjectMap(reader, JsonParser.DEFAULT).
ObjectMap(Reader r, Parser p) Construct an ObjectMap directly from a reader using the specified parser.

Method Summary

Modifier and Type	Method and Description
ObjectMap	append(String key, Object value) Convenience method for adding multiple objects to this map.
ObjectMap	appendAll(Map<String,Object> m) Convenience method for adding a contents of another map to this map.
<T> T	cast(Class<T> type) Converts this map into an object of the specified type.
<T> T	cast(ClassMeta<T> cm) Same as cast(Class), except allows you to specify a ClassMeta parameter.
boolean	containsKey(Object key)
boolean	containsOuterKey(Object key) Returns true if this map contains the specified key, ignoring the inner map if it exists.
Object	deleteAt(String path) Similar to remove(Object), but the key is a slash-delimited path used to traverse entries in this POJO.
Set<Map.Entry<String,Object>>	entrySet()
ObjectMap	exclude(String... keys) Returns a copy of this ObjectMap without the specified keys.
<T> T	find(Class<T> type, String... keys) Returns the value for the first key in the list that has an entry in this map.
Object	find(String... keys) Returns the value for the first key in the list that has an entry in this map.
Boolean	findBoolean(String... keys) Returns the first entry that exists converted to a Boolean.
Integer	findInt(String... keys) Returns the first entry that exists converted to an Integer.
String	findKeyIgnoreCase(String key) Searches for the specified key in this map ignoring case.
List<?>	findList(String... keys) Returns the first entry that exists converted to a List.
Long	findLong(String... keys) Returns the first entry that exists converted to a Long.
Map<?,?>	findMap(String... keys) Returns the first entry that exists converted to a Map.
ObjectList	findObjectList(String... keys) Returns the first entry that exists converted to a ObjectList.
ObjectMap	findObjectMap(String... keys) Returns the first entry that exists converted to a ObjectMap.
String	findString(String... keys) Returns the first entry that exists converted to a String.
Object	get(Object key)
<T> T	get(String key, Class<T> type) Same as get(), but casts or converts the value to the specified class type.
<T> T	get(String key, Type type, Type... args) Same as get(String,Class), but allows for complex data types consisting of collections or maps.
<T> T	getAt(String path, Class<T> type) Same as get(String,Class), but the key is a slash-delimited path used to traverse entries in this POJO.
<T> T	getAt(String path, Type type, Type... args) Same as getAt(String,Class), but allows for conversion to complex maps and collections.
BeanSession	getBeanSession() Returns the BeanSession currently associated with this map.
Boolean	getBoolean(String key) Returns the specified entry value converted to a Boolean.
Boolean	getBoolean(String key, Boolean defVal) Returns the specified entry value converted to a Boolean.
ClassMeta<?>	getClassMeta(String key) Returns the class type of the object at the specified index.
String	getFirstKey() Returns the first key in the map.
Integer	getInt(String key) Returns the specified entry value converted to an Integer.
Integer	getInt(String key, Integer defVal) Returns the specified entry value converted to an Integer.
List<?>	getList(String key) Returns the specified entry value converted to a List.
<E> List<E>	getList(String key, Class<E> elementType, List<E> def) Same as getList(String, List) except converts the elements to the specified types.
List<?>	getList(String key, List<?> defVal) Returns the specified entry value converted to a List.
Long	getLong(String key) Returns the specified entry value converted to a Long.
Long	getLong(String key, Long defVal) Returns the specified entry value converted to a Long.
Map<?,?>	getMap(String key) Returns the specified entry value converted to a Map.
<K,V> Map<K,V>	getMap(String key, Class<K> keyType, Class<V> valType, Map<K,V> def) Same as getMap(String, Map) except converts the keys and values to the specified types.
Map<?,?>	getMap(String key, Map<?,?> defVal) Returns the specified entry value converted to a Map.
ObjectList	getObjectList(String key) Returns the specified entry value converted to a ObjectList.
ObjectList	getObjectList(String key, ObjectList defVal) Returns the specified entry value converted to a ObjectList.
ObjectMap	getObjectMap(String key) Returns the specified entry value converted to a Map.
ObjectMap	getObjectMap(String key, ObjectMap defVal) Returns the specified entry value converted to a ObjectMap.
String	getString(String key) Returns the specified entry value converted to a String.
String	getString(String key, String defVal) Returns the specified entry value converted to a String.
String[]	getStringArray(String key) Returns the specified entry value converted to a String.
String[]	getStringArray(String key, String[] def) Same as getStringArray(String) but returns a default value if the value cannot be found.
<T> T	getSwapped(String key, PojoSwap<T,?> pojoSwap) Same as get(), but converts the raw value to the specified class type using the specified POJO swap.
Object	getWithDefault(String key, Object def) Same as get(), but returns the default value if the key could not be found.
<T> T	getWithDefault(String key, T def, Class<T> type) Same as get(String,Class) but returns a default value if the value does not exist.
<T> T	getWithDefault(String key, T def, Type type, Type... args) Same as get(String,Type,Type...) but returns a default value if the value does not exist.
ObjectMap	include(String... keys) Returns a copy of this ObjectMap with only the specified keys.
Set<String>	keySet()
Object	postAt(String path, Object o) Similar to putAt(String,Object), but used to append to collections and arrays.
Object	putAt(String path, Object o) Same as put(String,Object), but the key is a slash-delimited path used to traverse entries in this POJO.
ObjectMap	putIfEmpty(String key, Object val) Sets a value in this map if the entry does not exist or the value is null or an empty string.
ObjectMap	putIfNull(String key, Object val) Sets a value in this map if the entry does not exist or the value is null.
void	putJson(String key, String json) Convenience method for inserting JSON directly into an attribute on this object.
void	removeAll(Collection<String> keys) Convenience method for removing several keys at once.
void	removeAll(String... keys) Convenience method for removing several keys at once.
<T> T	removeWithDefault(String key, T defVal, Class<T> type) Equivalent to calling get(class,key,def) followed by remove(key);
ObjectMap	serializeTo(Writer w) Convenience method for serializing this map to the specified Writer using the JsonSerializer.DEFAULT serializer.
ObjectMap	setBeanSession(BeanSession session) Override the default bean session used for converting POJOs.
ObjectMap	setInner(Map<String,Object> inner) Set an inner map in this map to allow for chained get calls.
String	toString() Serialize this object into a JSON string using the JsonSerializer.DEFAULT serializer.
String	toString(WriterSerializer serializer) Serialize this object into a string using the specified serializer.

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, forEach, getOrDefault, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode

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, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Field Detail

EMPTY_MAP

public static final ObjectMap EMPTY_MAP

An empty read-only ObjectMap.

Constructor Detail

ObjectMap

public ObjectMap(CharSequence s,
                 Parser p)
          throws ParseException

Construct an ObjectMap directly from a string using the specified parser.

Parameters:

s - The string being parsed.

p - The parser to use to parse the input.

Throws:

ParseException - If the input contains a syntax error or is malformed.

ObjectMap

public ObjectMap(CharSequence s)
          throws ParseException

Shortcut for new ObjectMap(string,JsonParser.DEFAULT);

Parameters:

s - The JSON text to parse.

Throws:

ParseException - If the input contains a syntax error or is malformed.

ObjectMap

public ObjectMap(Reader r,
                 Parser p)
          throws ParseException,
                 IOException

Construct an ObjectMap directly from a reader using the specified parser.

Parameters:

r - The reader to read from. The reader will be wrapped in a BufferedReader if it isn't already.

p - The parser to use to parse the input.

Throws:

ParseException - If the input contains a syntax error or is malformed.

IOException - If a problem occurred trying to read from the reader.

ObjectMap

public ObjectMap(Reader r)
          throws ParseException,
                 IOException

Shortcut for new ObjectMap(reader, JsonParser.DEFAULT).

Parameters:

r - The reader to read from. The reader will be wrapped in a BufferedReader if it isn't already.

Throws:

ParseException - If the input contains a syntax error or is malformed.

IOException - If a problem occurred trying to read from the reader.

ObjectMap

public ObjectMap()

Construct an empty JSON object (i.e. an empty LinkedHashMap).

ObjectMap

public ObjectMap(BeanSession session)

Construct an empty JSON object (i.e. an empty LinkedHashMap) with the specified bean context.

Parameters:

session - The bean session to use for creating beans.

ObjectMap

public ObjectMap(Map<?,?> m)

Construct a JSON object and fill it with the contents from the specified Map.

Parameters:

m - The map whose entries will be copied into this map.

Method Detail

setInner

public ObjectMap setInner(Map<String,Object> inner)

Set an inner map in this map to allow for chained get calls.

If get(Object) returns null, then get(Object) will be called on the inner map.

In addition to providing the ability to chain maps, this method also provides the ability to wrap an existing map inside another map so that you can add entries to the outer map without affecting the values on the inner map.

ObjectMap m1 = new ObjectMap("{foo:1}"); ObjectMap m2 = new ObjectMap().setInner(m1); m2.put("foo", 2); // Overwrite the entry int foo1 = m1.getInt("foo"); // foo1 == 1 int foo2 = m2.getInt("foo"); // foo2 == 2

Parameters:

inner - The inner map. Can be null to remove the inner map from an existing map.

Returns:

This object (for method chaining).

findKeyIgnoreCase

public String findKeyIgnoreCase(String key)

Searches for the specified key in this map ignoring case.

Parameters:

key - The key to search for. For performance reasons, it's preferable that the key be all lowercase.

Returns:

The key, or null if map does not contain this key.

setBeanSession

public ObjectMap setBeanSession(BeanSession session)

Override the default bean session used for converting POJOs.

Default is BeanContext.DEFAULT, which is sufficient in most cases.

Useful if you're serializing/parsing beans with transforms defined.

Parameters:

session - The new bean session.

Returns:

This object (for method chaining).

getBeanSession

public BeanSession getBeanSession()

Returns the BeanSession currently associated with this map.

Returns:

The BeanSession currently associated with this map.

append

public ObjectMap append(String key,
                        Object value)

Convenience method for adding multiple objects to this map.

Equivalent to calling put(key, value), but returns this map so that the method can be chained.

Parameters:

key - The key.

value - The value.

Returns:

This object (for method chaining).

appendAll

public ObjectMap appendAll(Map<String,Object> m)

Convenience method for adding a contents of another map to this map.

Equivalent to calling putAll(m), but returns this map so that the method can be chained.

Parameters:

m - The map whose contents should be added to this map.

Returns:

This object (for method chaining).

get

public Object get(Object key)

Specified by:

get in interface Map<String,Object>

Overrides:

get in class LinkedHashMap<String,Object>

get

public <T> T get(String key,
                 Class<T> type)

Same as get(), but casts or converts the value to the specified class type.

This is the preferred get method for simple types.

Examples:

ObjectMap m = new ObjectMap("..."); // Value converted to a string. String s = m.get("key1", String.class); // Value converted to a bean. MyBean b = m.get("key2", MyBean.class); // Value converted to a bean array. MyBean[] ba = m.get("key3", MyBean[].class); // Value converted to a linked-list of objects. List l = m.get("key4", LinkedList.class); // Value converted to a map of object keys/values. Map m2 = m.get("key5", TreeMap.class);

See BeanSession.convertToType(Object, ClassMeta) for the list of valid data conversions.

Type Parameters:

T - The class type returned.

Parameters:

key - The key.

type - The class type returned.

Returns:

The value, or null if the entry doesn't exist.

get

public <T> T get(String key,
                 Type type,
                 Type... args)

Same as get(String,Class), but allows for complex data types consisting of collections or maps.

The type can be a simple type (e.g. beans, strings, numbers) or parameterized type (collections/maps).

Examples:

ObjectMap m = new ObjectMap("..."); // Value converted to a linked-list of strings. List<String> l1 = m.get("key1", LinkedList.class, String.class); // Value converted to a linked-list of beans. List<MyBean> l2 = m.get("key2", LinkedList.class, MyBean.class); // Value converted to a linked-list of linked-lists of strings. List<List<String>> l3 = m.get("key3", LinkedList.class, LinkedList.class, String.class); // Value converted to a map of string keys/values. Map<String,String> m1 = m.get("key4", TreeMap.class, String.class, String.class); // Value converted to a map containing string keys and values of lists containing beans. Map<String,List<MyBean>> m2 = m.get("key5", TreeMap.class, String.class, List.class, MyBean.class);

Collection classes are assumed to be followed by zero or one objects indicating the element type.

Map classes are assumed to be followed by zero or two meta objects indicating the key and value types.

The array can be arbitrarily long to indicate arbitrarily complex data structures.

See BeanSession.convertToType(Object, ClassMeta) for the list of valid data conversions.

Notes:

• Use the get(String, Class) method instead if you don't need a parameterized map/collection.

Type Parameters:

T - The class type returned.

Parameters:

key - The key.

type - The class type returned.

args - The class type parameters.

Returns:

The value, or null if the entry doesn't exist.

getWithDefault

public Object getWithDefault(String key,
                             Object def)

Same as get(), but returns the default value if the key could not be found.

Parameters:

key - The key.

def - The default value if the entry doesn't exist.

Returns:

The value, or the default value if the entry doesn't exist.

getWithDefault

public <T> T getWithDefault(String key,
                            T def,
                            Class<T> type)

Same as get(String,Class) but returns a default value if the value does not exist.

Type Parameters:

T - The class type returned.

Parameters:

key - The key.

def - The default value. Can be null.

type - The class type returned.

Returns:

The value, or null if the entry doesn't exist.

getWithDefault

public <T> T getWithDefault(String key,
                            T def,
                            Type type,
                            Type... args)

Same as get(String,Type,Type...) but returns a default value if the value does not exist.

Type Parameters:

T - The class type returned.

Parameters:

key - The key.

def - The default value. Can be null.

type - The class type returned.

args - The class type parameters.

Returns:

The value, or null if the entry doesn't exist.

getSwapped

public <T> T getSwapped(String key,
                        PojoSwap<T,?> pojoSwap)
                 throws ParseException

Same as get(), but converts the raw value to the specified class type using the specified POJO swap.

Type Parameters:

T - The transformed class type.

Parameters:

key - The key.

pojoSwap - The swap class used to convert the raw type to a transformed type.

Returns:

The value, or null if the entry doesn't exist.

Throws:

ParseException - Thrown by the POJO swap if a problem occurred trying to parse the value.

find

public Object find(String... keys)

Returns the value for the first key in the list that has an entry in this map.

Parameters:

keys - The keys to look up in order.

Returns:

The value of the first entry whose key exists, or null if none of the keys exist in this map.

find

public <T> T find(Class<T> type,
                  String... keys)

Returns the value for the first key in the list that has an entry in this map.

Casts or converts the value to the specified class type.

See BeanSession.convertToType(Object, ClassMeta) for the list of valid data conversions.

Type Parameters:

T - The class type to convert the value to.

Parameters:

type - The class type to convert the value to.

keys - The keys to look up in order.

Returns:

The value of the first entry whose key exists, or null if none of the keys exist in this map.

getAt

public <T> T getAt(String path,
                   Class<T> type)

Same as get(String,Class), but the key is a slash-delimited path used to traverse entries in this POJO.

For example, the following code is equivalent:

ObjectMap m = getObjectMap(); // Long way long l = m.getObjectMap("foo").getObjectList("bar").getObjectMap("0") .getLong("baz"); // Using this method long l = m.getAt("foo/bar/0/baz", long.class);

This method uses the PojoRest class to perform the lookup, so the map can contain any of the various class types that the PojoRest class supports (e.g. beans, collections, arrays).

Type Parameters:

T - The class type.

Parameters:

path - The path to the entry.

type - The class type.

Returns:

The value, or null if the entry doesn't exist.

getAt

public <T> T getAt(String path,
                   Type type,
                   Type... args)

Same as getAt(String,Class), but allows for conversion to complex maps and collections.

This method uses the PojoRest class to perform the lookup, so the map can contain any of the various class types that the PojoRest class supports (e.g. beans, collections, arrays).

Type Parameters:

T - The class type.

Parameters:

path - The path to the entry.

type - The class type.

args - The class parameter types.

Returns:

The value, or null if the entry doesn't exist.

putAt

public Object putAt(String path,
                    Object o)

Same as put(String,Object), but the key is a slash-delimited path used to traverse entries in this POJO.

For example, the following code is equivalent:

ObjectMap m = getObjectMap(); // Long way m.getObjectMap("foo").getObjectList("bar").getObjectMap("0") .put("baz", 123); // Using this method m.putAt("foo/bar/0/baz", 123);

This method uses the PojoRest class to perform the lookup, so the map can contain any of the various class types that the PojoRest class supports (e.g. beans, collections, arrays).

Parameters:

path - The path to the entry.

o - The new value.

Returns:

The previous value, or null if the entry doesn't exist.

postAt

public Object postAt(String path,
                     Object o)

Similar to putAt(String,Object), but used to append to collections and arrays.

For example, the following code is equivalent:

ObjectMap m = getObjectMap(); // Long way m.getObjectMap("foo").getObjectList("bar").append(123); // Using this method m.postAt("foo/bar", 123);

This method uses the PojoRest class to perform the lookup, so the map can contain any of the various class types that the PojoRest class supports (e.g. beans, collections, arrays).

Parameters:

path - The path to the entry.

o - The new value.

Returns:

The previous value, or null if the entry doesn't exist.

deleteAt

public Object deleteAt(String path)

Similar to remove(Object), but the key is a slash-delimited path used to traverse entries in this POJO.

For example, the following code is equivalent:

ObjectMap m = getObjectMap(); // Long way m.getObjectMap("foo").getObjectList("bar").getObjectMap(0).remove("baz"); // Using this method m.deleteAt("foo/bar/0/baz");

This method uses the PojoRest class to perform the lookup, so the map can contain any of the various class types that the PojoRest class supports (e.g. beans, collections, arrays).

Parameters:

path - The path to the entry.

Returns:

The previous value, or null if the entry doesn't exist.

putJson

public void putJson(String key,
                    String json)
             throws ParseException

Convenience method for inserting JSON directly into an attribute on this object.

The JSON text can be an object (i.e. "{...}") or an array (i.e. "[...]").

Parameters:

key - The key.

json - The JSON text that will be parsed into an Object and then inserted into this map.

Throws:

ParseException - If the input contains a syntax error or is malformed.

getString

public String getString(String key)

Returns the specified entry value converted to a String.

Shortcut for get(key, String.class).

Parameters:

key - The key.

Returns:

The converted value, or null if the map contains no mapping for this key.

getStringArray

public String[] getStringArray(String key)

Returns the specified entry value converted to a String.

Shortcut for get(key, String[].class).

Parameters:

key - The key.

Returns:

The converted value, or null if the map contains no mapping for this key.

getStringArray

public String[] getStringArray(String key,
                               String[] def)

Same as getStringArray(String) but returns a default value if the value cannot be found.

Parameters:

key - The map key.

def - The default value if value is not found.

Returns:

The value converted to a string array.

getString

public String getString(String key,
                        String defVal)

Returns the specified entry value converted to a String.

Shortcut for getWithDefault(key, defVal, String.class).

Parameters:

key - The key.

defVal - The default value if the map doesn't contain the specified mapping.

Returns:

The converted value, or the default value if the map contains no mapping for this key.

getInt

public Integer getInt(String key)

Returns the specified entry value converted to an Integer.

Shortcut for get(key, Integer.class).

Parameters:

key - The key.

Returns:

The converted value, or null if the map contains no mapping for this key.

Throws:

InvalidDataConversionException - If value cannot be converted.

getInt

public Integer getInt(String key,
                      Integer defVal)

Returns the specified entry value converted to an Integer.

Shortcut for getWithDefault(key, defVal, Integer.class).

Parameters:

key - The key.

defVal - The default value if the map doesn't contain the specified mapping.

Returns:

The converted value, or the default value if the map contains no mapping for this key.

Throws:

InvalidDataConversionException - If value cannot be converted.

getLong

public Long getLong(String key)

Returns the specified entry value converted to a Long.

Shortcut for get(key, Long.class).

Parameters:

key - The key.

Returns:

The converted value, or null if the map contains no mapping for this key.

Throws:

InvalidDataConversionException - If value cannot be converted.

getLong

public Long getLong(String key,
                    Long defVal)

Returns the specified entry value converted to a Long.

Shortcut for getWithDefault(key, defVal, Long.class).

Parameters:

key - The key.

defVal - The default value if the map doesn't contain the specified mapping.

Returns:

The converted value, or the default value if the map contains no mapping for this key.

Throws:

InvalidDataConversionException - If value cannot be converted.

getBoolean

public Boolean getBoolean(String key)

Returns the specified entry value converted to a Boolean.

Shortcut for get(key, Boolean.class).

Parameters:

key - The key.

Returns:

The converted value, or null if the map contains no mapping for this key.

Throws:

InvalidDataConversionException - If value cannot be converted.

getBoolean

public Boolean getBoolean(String key,
                          Boolean defVal)

Returns the specified entry value converted to a Boolean.

Shortcut for getWithDefault(key, defVal, Boolean.class).

Parameters:

key - The key.

defVal - The default value if the map doesn't contain the specified mapping.

Returns:

The converted value, or the default value if the map contains no mapping for this key.

Throws:

InvalidDataConversionException - If value cannot be converted.

getMap

public Map<?,?> getMap(String key)

Returns the specified entry value converted to a Map.

Shortcut for get(key, Map.class).

Parameters:

key - The key.

Returns:

The converted value, or null if the map contains no mapping for this key.

Throws:

InvalidDataConversionException - If value cannot be converted.

getMap

public Map<?,?> getMap(String key,
                       Map<?,?> defVal)

Returns the specified entry value converted to a Map.

Shortcut for getWithDefault(key, defVal, Map.class).

Parameters:

key - The key.

defVal - The default value if the map doesn't contain the specified mapping.

Returns:

The converted value, or the default value if the map contains no mapping for this key.

Throws:

InvalidDataConversionException - If value cannot be converted.

getMap

public <K,V> Map<K,V> getMap(String key,
                             Class<K> keyType,
                             Class<V> valType,
                             Map<K,V> def)

Same as getMap(String, Map) except converts the keys and values to the specified types.

Parameters:

key - The key.

keyType - The key type class.

valType - The value type class.

def - The default value if the map doesn't contain the specified mapping.

Returns:

The converted value, or the default value if the map contains no mapping for this key.

Throws:

InvalidDataConversionException - If value cannot be converted.

getList

public List<?> getList(String key)

Returns the specified entry value converted to a List.

Shortcut for get(key, List.class).

Parameters:

key - The key.

Returns:

The converted value, or null if the map contains no mapping for this key.

Throws:

InvalidDataConversionException - If value cannot be converted.

getList

public List<?> getList(String key,
                       List<?> defVal)

Returns the specified entry value converted to a List.

Shortcut for getWithDefault(key, defVal, List.class).

Parameters:

key - The key.

defVal - The default value if the map doesn't contain the specified mapping.

Returns:

The converted value, or the default value if the map contains no mapping for this key.

Throws:

InvalidDataConversionException - If value cannot be converted.

getList

public <E> List<E> getList(String key,
                           Class<E> elementType,
                           List<E> def)

Same as getList(String, List) except converts the elements to the specified types.

Parameters:

key - The key.

elementType - The element type class.

def - The default value if the map doesn't contain the specified mapping.

Returns:

The converted value, or the default value if the map contains no mapping for this key.

Throws:

InvalidDataConversionException - If value cannot be converted.

getObjectMap

public ObjectMap getObjectMap(String key)

Returns the specified entry value converted to a Map.

Shortcut for get(key, ObjectMap.class).

Parameters:

key - The key.

Returns:

The converted value, or null if the map contains no mapping for this key.

Throws:

InvalidDataConversionException - If value cannot be converted.

getObjectMap

public ObjectMap getObjectMap(String key,
                              ObjectMap defVal)

Returns the specified entry value converted to a ObjectMap.

Shortcut for getWithDefault(key, defVal, ObjectMap.class).

Parameters:

key - The key.

defVal - The default value if the map doesn't contain the specified mapping.

Returns:

The converted value, or the default value if the map contains no mapping for this key.

Throws:

InvalidDataConversionException - If value cannot be converted.

getObjectList

public ObjectList getObjectList(String key)

Returns the specified entry value converted to a ObjectList.

Shortcut for get(key, ObjectList.class).

Parameters:

key - The key.

Returns:

The converted value, or null if the map contains no mapping for this key.

Throws:

InvalidDataConversionException - If value cannot be converted.

getObjectList

public ObjectList getObjectList(String key,
                                ObjectList defVal)

Returns the specified entry value converted to a ObjectList.

Shortcut for getWithDefault(key, defVal, ObjectList.class).

Parameters:

key - The key.

defVal - The default value if the map doesn't contain the specified mapping.

Returns:

The converted value, or the default value if the map contains no mapping for this key.

Throws:

InvalidDataConversionException - If value cannot be converted.

findString

public String findString(String... keys)

Returns the first entry that exists converted to a String.

Shortcut for find(String.class, keys).

Parameters:

keys - The list of keys to look for.

Returns:

The converted value of the first key in the list that has an entry in this map, or null if the map contains no mapping for any of the keys.

findInt

public Integer findInt(String... keys)

Returns the first entry that exists converted to an Integer.

Shortcut for find(Integer.class, keys).

Parameters:

keys - The list of keys to look for.

Returns:

The converted value of the first key in the list that has an entry in this map, or null if the map contains no mapping for any of the keys.

Throws:

InvalidDataConversionException - If value cannot be converted.

findLong

public Long findLong(String... keys)

Returns the first entry that exists converted to a Long.

Shortcut for find(Long.class, keys).

Parameters:

keys - The list of keys to look for.

Returns:

The converted value of the first key in the list that has an entry in this map, or null if the map contains no mapping for any of the keys.

Throws:

InvalidDataConversionException - If value cannot be converted.

findBoolean

public Boolean findBoolean(String... keys)

Returns the first entry that exists converted to a Boolean.

Shortcut for find(Boolean.class, keys).

Parameters:

keys - The list of keys to look for.

Returns:

The converted value of the first key in the list that has an entry in this map, or null if the map contains no mapping for any of the keys.

Throws:

InvalidDataConversionException - If value cannot be converted.

findMap

public Map<?,?> findMap(String... keys)

Returns the first entry that exists converted to a Map.

Shortcut for find(Map.class, keys).

Parameters:

keys - The list of keys to look for.

Returns:

The converted value of the first key in the list that has an entry in this map, or null if the map contains no mapping for any of the keys.

Throws:

InvalidDataConversionException - If value cannot be converted.

findList

public List<?> findList(String... keys)

Returns the first entry that exists converted to a List.

Shortcut for find(List.class, keys).

Parameters:

keys - The list of keys to look for.

Returns:

The converted value of the first key in the list that has an entry in this map, or null if the map contains no mapping for any of the keys.

Throws:

InvalidDataConversionException - If value cannot be converted.

findObjectMap

public ObjectMap findObjectMap(String... keys)

Returns the first entry that exists converted to a ObjectMap.

Shortcut for find(ObjectMap.class, keys).

Parameters:

keys - The list of keys to look for.

Returns:

The converted value of the first key in the list that has an entry in this map, or null if the map contains no mapping for any of the keys.

Throws:

InvalidDataConversionException - If value cannot be converted.

findObjectList

public ObjectList findObjectList(String... keys)

Returns the first entry that exists converted to a ObjectList.

Shortcut for find(ObjectList.class, keys).

Parameters:

keys - The list of keys to look for.

Returns:

The converted value of the first key in the list that has an entry in this map, or null if the map contains no mapping for any of the keys.

Throws:

InvalidDataConversionException - If value cannot be converted.

getFirstKey

public String getFirstKey()

Returns the first key in the map.

Returns:

The first key in the map, or null if the map is empty.

getClassMeta

public ClassMeta<?> getClassMeta(String key)

Returns the class type of the object at the specified index.

Parameters:

key - The key into this map.

Returns:

The data type of the object at the specified key, or null if the value is null or does not exist.

removeWithDefault

public <T> T removeWithDefault(String key,
                               T defVal,
                               Class<T> type)

Equivalent to calling get(class,key,def) followed by remove(key);

Type Parameters:

T - The class type.

Parameters:

key - The key.

defVal - The default value if the map doesn't contain the specified mapping.

type - The class type.

Returns:

The converted value, or the default value if the map contains no mapping for this key.

Throws:

InvalidDataConversionException - If value cannot be converted.

removeAll

public void removeAll(Collection<String> keys)

Convenience method for removing several keys at once.

Parameters:

keys - The list of keys to remove.

removeAll

public void removeAll(String... keys)

Convenience method for removing several keys at once.

Parameters:

keys - The list of keys to remove.

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,Object>

Overrides:

containsKey in class HashMap<String,Object>

containsOuterKey

public boolean containsOuterKey(Object key)

Returns true if this map contains the specified key, ignoring the inner map if it exists.

Parameters:

key - The key to look up.

Returns:

true if this map contains the specified key.

include

public ObjectMap include(String... keys)

Returns a copy of this ObjectMap with only the specified keys.

Parameters:

keys - The keys of the entries to copy.

Returns:

A new map with just the keys and values from this map.

exclude

public ObjectMap exclude(String... keys)

Returns a copy of this ObjectMap without the specified keys.

Parameters:

keys - The keys of the entries not to copy.

Returns:

A new map without the keys and values from this map.

putIfNull

public ObjectMap putIfNull(String key,
                           Object val)

Sets a value in this map if the entry does not exist or the value is null.

Parameters:

key - The map key.

val - The value to set if the current value does not exist or is null.

Returns:

This object (for method chaining).

putIfEmpty

public ObjectMap putIfEmpty(String key,
                            Object val)

Sets a value in this map if the entry does not exist or the value is null or an empty string.

Parameters:

key - The map key.

val - The value to set if the current value does not exist or is null or an empty string.

Returns:

This object (for method chaining).

cast

public <T> T cast(Class<T> type)

Converts this map into an object of the specified type.

If this map contains a "_type" entry, it must be the same as or a subclass of the type.

Type Parameters:

T - The class type to convert this map object to.

Parameters:

type - The class type to convert this map object to.

Returns:

The new object.

Throws:

ClassCastException - If the "_type" entry is present and not assignable from type

cast

public <T> T cast(ClassMeta<T> cm)

Same as cast(Class), except allows you to specify a ClassMeta parameter.

Type Parameters:

T - The class type to convert this map object to.

Parameters:

cm - The class type to convert this map object to.

Returns:

The new object.

Throws:

ClassCastException - If the "_type" entry is present and not assignable from type

toString

public String toString(WriterSerializer serializer)
                throws SerializeException

Serialize this object into a string using the specified serializer.

Parameters:

serializer - The serializer to use to convert this object to a string.

Returns:

This object serialized as a string.

Throws:

SerializeException - If a problem occurred trying to convert the output.

toString

public String toString()

Serialize this object into a JSON string using the JsonSerializer.DEFAULT serializer.

Overrides:

toString in class AbstractMap<String,Object>

serializeTo

public ObjectMap serializeTo(Writer w)
                      throws IOException,
                             SerializeException

Convenience method for serializing this map to the specified Writer using the JsonSerializer.DEFAULT serializer.

Parameters:

w - The writer to serialize this object to.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred trying to write to the writer.

SerializeException - If a problem occurred trying to convert the output.

keySet

public Set<String> keySet()

Specified by:

keySet in interface Map<String,Object>

Overrides:

keySet in class LinkedHashMap<String,Object>

entrySet

public Set<Map.Entry<String,Object>> entrySet()

Specified by:

entrySet in interface Map<String,Object>

Overrides:

entrySet in class LinkedHashMap<String,Object>