ObjectMap (Juneau)

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, ManifestFile
-
-
-
-
```
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. - -
Examples
-
- // 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. -
-
-
Author:
-
James Bognar (james.bognar@salesforce.com)
-
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.
-
-

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(BeanContext beanContext)` - 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

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ObjectMap`	`append(String key, - Object value)` - Convenience method for adding multiple objects to this map. -
`Object`	`cast()` - Converts this map into the class type specified by the "_class" entry value. -
`<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`. -
`<T> T`	`get(Class<T> type, - String key)` - Same as `get()`, but casts or converts the value to the specified class type. -
`<T> T`	`get(Class<T> type, - String key, - T def)` - Same as `get()`, but casts or converts the value to the specified class type. -
`<T> T`	`get(ClassMeta<T> type, - String key)` - Same as `get()`, but casts or converts the value to the specified class type. -
`<T> T`	`get(ClassMeta<T> type, - String key, - T def)` - Same as `get()`, but casts or converts the value to the specified class type. -
`Object`	`get(Object key)`
`<T> T`	`get(PojoTransform<T,?> transform, - String key)` - Same as `get()`, but converts the raw value to the specified class type using the specified transform. -
`Object`	`get(String key, - Object def)` - Same as `get()`, but returns the default value if the key - could not be found. -
`<T> T`	`getAt(Class<T> type, - String path)` - Same as `get(Class,String)`, but the key is a slash-delimited - path used to traverse entries in this POJO. -
`BeanContext`	`getBeanContext()` - Returns the `BeanContext` 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. -
`ObjectMap`	`getInner()` - Returns the inner map if one was set through `setInner(ObjectMap)`. -
`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`. -
`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`. -
`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)` - Specialized method that calls `getString(String)` and splits the - results as a simple comma-delimited list. -
`String[]`	`getStringArray(String key, - String[] def)` - Same as `getStringArray(String)` but returns a default value if the value cannot be found. -
`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. -
`<T> T`	`remove(Class<T> type, - String key, - T defVal)` - Equivalent to calling `get(class,key,def)` followed by `remove(key);` -
`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. -
`ObjectMap`	`serializeTo(Writer w)` - Convenience method for serializing this map to the specified `Writer` using - the `JsonSerializer.DEFAULT` serializer. -
`ObjectMap`	`setBeanContext(BeanContext beanContext)` - Override the default bean context used for converting POJOs. -
`ObjectMap`	`setInner(ObjectMap 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(BeanContext beanContext)
```
    -
    Construct an empty JSON object (i.e. an empty LinkedHashMap) with the specified bean context.
    -
    -
    Parameters:
    -
    beanContext - The bean context 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(ObjectMap 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 preferrable that the key be all lowercase.
    -
    Returns:
    -
    The key, or null if map does not contain this key.
    -
    -
  - - - -
  - -
    getInner
    -
```
public ObjectMap getInner()
```
    -
    Returns the inner map if one was set through setInner(ObjectMap).
    -
    -
    Returns:
    -
    The inner map if one was set through setInner(ObjectMap), or null if no inner map is present.
    -
    -
  - - - -
  - -
    setBeanContext
    -
```
public 
```

Class ObjectMap

Examples

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.LinkedHashMap

Methods inherited from class java.util.HashMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Field Detail

EMPTY_MAP

Constructor Detail

ObjectMap

ObjectMap

ObjectMap

ObjectMap

ObjectMap

ObjectMap

ObjectMap

Method Detail

setInner

findKeyIgnoreCase

getInner

setBeanContext