JsonObject (PF-All 7.4.0 API)

java.lang.Object
- java.util.AbstractMap<K,V>
- - java.util.HashMap<K,V>
  - - java.util.LinkedHashMap<java.lang.String,java.lang.Object>
    - - org.pfsw.text.json.JsonObject

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>, IReadOnlyNamedValues<java.lang.Object>, IJSONConvertible, IStringRepresentation, JsonType
```
public class JsonObject
extends java.util.LinkedHashMap<java.lang.String,java.lang.Object>
implements JsonType, IReadOnlyNamedValues<java.lang.Object>
```
The Java representation of a JSON object. A typed map that has string keys.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Field Summary
- Fields inherited from interface org.pfsw.bif.text.IJSONConvertible
  JSON_ARRAY_END, JSON_ARRAY_START, JSON_ELEMENT_SEPARATOR, JSON_LITERAL_FALSE, JSON_LITERAL_NULL, JSON_LITERAL_TRUE, JSON_OBJECT_END, JSON_OBJECT_START, JSON_PAIR_SEPARATOR, JSON_STRING_DELIMITER, JSON_STRING_ESCAPE

Constructor Summary

Constructors
Constructor and Description
`JsonObject()`
`JsonObject(int initialCapacity)`
`JsonObject(int initialCapacity, float loadFactor)`
`JsonObject(java.util.Map<? extends java.lang.String,? extends java.lang.Object> map)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`appendAsJSONString(java.lang.Appendable output)` The receiver of this method must append its internal state as JSON string representation to the given buffer.
`java.lang.String`	`asString()` Returns the JSON string representation of this object.
`static JsonObject`	`create()` Returns a new empty JSON object.
`java.math.BigDecimal`	`getBigDecimal(IStringConstant name)` Returns the value for the given name as BigDecimal (if it is one).
`java.math.BigDecimal`	`getBigDecimal(java.lang.String name)` Returns the value for the given name as BigDecimal (if it is one).
`java.lang.Boolean`	`getBoolean(IStringConstant name)` Returns the value for the given name as Boolean (if it is one).
`java.lang.Boolean`	`getBoolean(java.lang.String name)` Returns the value for the given name as Boolean (if it is one).
`java.lang.Integer`	`getInteger(IStringConstant name)` Returns the value for the given name as Integer (if it is one).
`java.lang.Integer`	`getInteger(java.lang.String name)` Returns the value for the given name as Integer (if it is one).
`JsonArray`	`getJsonArray(IStringConstant name)` Returns the value for the given name as JsonArray (if it is one).
`JsonArray`	`getJsonArray(java.lang.String name)` Returns the value for the given name as JsonArray (if it is one).
`JsonObject`	`getJsonObject(IStringConstant name)` Returns the value for the given name as JsonObject (if it is one).
`JsonObject`	`getJsonObject(java.lang.String name)` Returns the value for the given name as JsonObject (if it is one).
`java.lang.Long`	`getLong(IStringConstant name)` Returns the value for the given name as Long (if it is one).
`java.lang.Long`	`getLong(java.lang.String name)` Returns the value for the given name as Long (if it is one).
`java.util.Collection<java.lang.String>`	`getNames()` Returns all names (maybe empty but never null).
`java.lang.Number`	`getNumber(IStringConstant name)` Returns the value for the given name as Number (if it is one).
`java.lang.Number`	`getNumber(java.lang.String name)` Returns the value for the given name as Number (if it is one).
`java.lang.String`	`getString(IStringConstant name)` Returns the value for the given name as String (if it is one).
`java.lang.String`	`getString(java.lang.String name)` Returns the value for the given name as String (if it is one).
`protected <T> T`	`getTypedElement(java.lang.String name, java.lang.Class<T> type)`
`java.lang.Object`	`getValue(IStringConstant name)`
`java.lang.Object`	`getValue(java.lang.String name)` Returns the value associated with the given name.
`<T> T`	`getValueOfType(IStringConstant name, java.lang.Class<T> type)` Returns the value for the given name as type of the given class.
`<T> T`	`getValueOfType(java.lang.String name, java.lang.Class<T> type)` Returns the value for the given name as type of the given class.
`boolean`	`hasField(IStringConstant name)` Returns whether or not this JSON object contains a field with the given name.
`boolean`	`hasField(java.lang.String name)` Returns whether or not this JSON object contains a field with the given name.
`boolean`	`isArray()` Returns false because this is no JSON array representation (in Java).
`boolean`	`isObject()` Returns true because this is a JSON object representation (in Java).
`java.lang.Object`	`put(java.lang.String key, java.lang.Object value)` Adds the given element if it is a valid JSON object type.
`JsonObject`	`setField(IStringConstant name, java.lang.Object value)` Adds the given element if it is a valid JSON object type.
`JsonObject`	`setField(java.lang.String name, java.lang.Object value)` Adds the given element if it is a valid JSON object type.
`java.lang.String`	`toJSON()` The receiver of this method returns its internal state as JSON string representation.

Methods inherited from class java.util.LinkedHashMap
clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap
clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap
equals, hashCode, toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pfsw.bif.facet.IReadOnlyNamedValues
isEmpty

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, putAll, putIfAbsent, remove, remove, replace, replace, size

- Constructor Detail
  - JsonObject
```
public JsonObject()
```
  - JsonObject
```
public JsonObject(int initialCapacity,
                  float loadFactor)
```
  - JsonObject
```
public JsonObject(int initialCapacity)
```
  - JsonObject
```
public JsonObject(java.util.Map<? extends java.lang.String,? extends java.lang.Object> map)
```
- Method Detail
  - create
```
public static JsonObject create()
```
    Returns a new empty JSON object.
  - put
```
public java.lang.Object put(java.lang.String key,
                            java.lang.Object value)
```
    Adds the given element if it is a valid JSON object type.
    Valid types are:
    - JsonObject
    - JsonArray
    - String
    - Boolean
    - Integer
    - Long
    - BigDecimal
    - null
    Objects of other types will cause an exception.
    Specified by:
    
    put in interface java.util.Map<java.lang.String,java.lang.Object>
    
    Overrides:
    
    put in class java.util.HashMap<java.lang.String,java.lang.Object>
    
    Returns:
    
    true if the object was added.
    
    Throws:
    
    java.lang.IllegalArgumentException - If the given object is not of a valid JSON type.
  - setField
```
public JsonObject setField(java.lang.String name,
                           java.lang.Object value)
```
    Adds the given element if it is a valid JSON object type.
    Valid types are:
    - JsonObject
    - JsonArray
    - String
    - Boolean
    - Integer
    - Long
    - BigDecimal
    - null
    Objects of other types will cause an exception.
    Returns:
    
    this JSON object.
    
    Throws:
    
    java.lang.IllegalArgumentException - If the given object is not of a valid JSON type.
  - setField
```
public JsonObject setField(IStringConstant name,
                           java.lang.Object value)
```
    Adds the given element if it is a valid JSON object type.
    Valid types are:
    - JsonObject
    - JsonArray
    - String
    - Boolean
    - Integer
    - Long
    - BigDecimal
    - null
    Objects of other types will cause an exception.
    Returns:
    
    this JSON object.
    
    Throws:
    
    java.lang.IllegalArgumentException - If the given object is not of a valid JSON type.
  - getJsonObject
```
public JsonObject getJsonObject(java.lang.String name)
```
    Returns the value for the given name as JsonObject (if it is one).
    
    Parameters:
    
    name - The name of the object to look for (must not be null).
    
    Returns:
    
    The found JsonObject or null if not existent.
    
    Throws:
    
    java.lang.ClassCastException - If the object associated to the given name is no JsonObject.
  - getJsonObject
```
public JsonObject getJsonObject(IStringConstant name)
```
    Returns the value for the given name as JsonObject (if it is one).
    
    Parameters:
    
    name - The name of the object to look for (must not be null).
    
    Returns:
    
    The found JsonObject or null if not existent.
    
    Throws:
    
    java.lang.ClassCastException - If the object associated to the given name is no JsonObject.
  - getJsonArray
```
public JsonArray getJsonArray(java.lang.String name)
```
    Returns the value for the given name as JsonArray (if it is one).
    
    Parameters:
    
    name - The name of the array to look for (must not be null).
    
    Returns:
    
    The found JsonArray or null if not existent.
    
    Throws:
    
    java.lang.ClassCastException - If the object associated to the given name is no JsonArray.
  - getJsonArray
```
public JsonArray getJsonArray(IStringConstant name)
```
    Returns the value for the given name as JsonArray (if it is one).
    
    Parameters:
    
    name - The name of the array to look for (must not be null).
    
    Returns:
    
    The found JsonArray or null if not existent.
    
    Throws:
    
    java.lang.ClassCastException - If the object associated to the given name is no JsonArray.
  - getString
```
public java.lang.String getString(java.lang.String name)
```
    Returns the value for the given name as String (if it is one).
    
    Parameters:
    
    name - The name of the value to look for (must not be null).
    
    Returns:
    
    The found String or null if not existent.
    
    Throws:
    
    java.lang.ClassCastException - If the object associated to the given name is no String.
  - getString
```
public java.lang.String getString(IStringConstant name)
```
    Returns the value for the given name as String (if it is one).
    
    Parameters:
    
    name - The name of the value to look for (must not be null).
    
    Returns:
    
    The found String or null if not existent.
    
    Throws:
    
    java.lang.ClassCastException - If the object associated to the given name is no String.
  - getBoolean
```
public java.lang.Boolean getBoolean(java.lang.String name)
```
    Returns the value for the given name as Boolean (if it is one).
    
    Parameters:
    
    name - The name of the value to look for (must not be null).
    
    Returns:
    
    The found Boolean or null if not existent.
    
    Throws:
    
    java.lang.ClassCastException - If the object associated to the given name is no Boolean.
  - getBoolean
```
public java.lang.Boolean getBoolean(IStringConstant name)
```
    Returns the value for the given name as Boolean (if it is one).
    
    Parameters:
    
    name - The name of the value to look for (must not be null).
    
    Returns:
    
    The found Boolean or null if not existent.
    
    Throws:
    
    java.lang.ClassCastException - If the object associated to the given name is no Boolean.
  - getNumber
```
public java.lang.Number getNumber(java.lang.String name)
```
    Returns the value for the given name as Number (if it is one).
    
    Parameters:
    
    name - The name of the value to look for (must not be null).
    
    Returns:
    
    The found Number or null if not existent.
    
    Throws:
    
    java.lang.ClassCastException - If the object associated to the given name is no Number.
  - getNumber
```
public java.lang.Number getNumber(IStringConstant name)
```
    Returns the value for the given name as Number (if it is one).
    
    Parameters:
    
    name - The name of the value to look for (must not be null).
    
    Returns:
    
    The found Number or null if not existent.
    
    Throws:
    
    java.lang.ClassCastException - If the object associated to the given name is no Number.
  - getInteger
```
public java.lang.Integer getInteger(java.lang.String name)
```
    Returns the value for the given name as Integer (if it is one).
    
    Parameters:
    
    name - The name of the value to look for (must not be null).
    
    Returns:
    
    The found Integer or null if not existent.
    
    Throws:
    
    java.lang.ClassCastException - If the object associated to the given name is no Integer.
  - getInteger
```
public java.lang.Integer getInteger(IStringConstant name)
```
    Returns the value for the given name as Integer (if it is one).
    
    Parameters:
    
    name - The name of the value to look for (must not be null).
    
    Returns:
    
    The found Integer or null if not existent.
    
    Throws:
    
    java.lang.ClassCastException - If the object associated to the given name is no Integer.
  - getLong
```
public java.lang.Long getLong(java.lang.String name)
```
    Returns the value for the given name as Long (if it is one).
    
    Parameters:
    
    name - The name of the value to look for (must not be null).
    
    Returns:
    
    The found Long or null if not existent.
    
    Throws:
    
    java.lang.ClassCastException - If the object associated to the given name is no Long.
  - getLong
```
public java.lang.Long getLong(IStringConstant name)
```
    Returns the value for the given name as Long (if it is one).
    
    Parameters:
    
    name - The name of the value to look for (must not be null).
    
    Returns:
    
    The found Long or null if not existent.
    
    Throws:
    
    java.lang.ClassCastException - If the object associated to the given name is no Long.
  - getBigDecimal
```
public java.math.BigDecimal getBigDecimal(java.lang.String name)
```
    Returns the value for the given name as BigDecimal (if it is one).
    
    Parameters:
    
    name - The name of the value to look for (must not be null).
    
    Returns:
    
    The found BigDecimal or null if not existent.
    
    Throws:
    
    java.lang.ClassCastException - If the object associated to the given name is no BigDecimal.
  - getBigDecimal
```
public java.math.BigDecimal getBigDecimal(IStringConstant name)
```
    Returns the value for the given name as BigDecimal (if it is one).
    
    Parameters:
    
    name - The name of the value to look for (must not be null).
    
    Returns:
    
    The found BigDecimal or null if not existent.
    
    Throws:
    
    java.lang.ClassCastException - If the object associated to the given name is no BigDecimal.
  - getValueOfType
```
public <T> T getValueOfType(java.lang.String name,
                            java.lang.Class<T> type)
```
    Returns the value for the given name as type of the given class.
    
    Parameters:
    
    name - The name of the value to look for (must not be null).
    
    Returns:
    
    The found object or null if not existent.
    
    Throws:
    
    java.lang.IllegalArgumentException - If the specified type is no valid JSON type.
    
    java.lang.ClassCastException - If the object associated to the given name is not of the specified type.
  - getValueOfType
```
public <T> T getValueOfType(IStringConstant name,
                            java.lang.Class<T> type)
```
    Returns the value for the given name as type of the given class.
    
    Parameters:
    
    name - The name of the value to look for (must not be null).
    
    Returns:
    
    The found object or null if not existent.
    
    Throws:
    
    java.lang.IllegalArgumentException - If the specified type is no valid JSON type.
    
    java.lang.ClassCastException - If the object associated to the given name is not of the specified type.
  - isObject
```
public boolean isObject()
```
    Returns true because this is a JSON object representation (in Java).
    
    Specified by:
    
    isObject in interface JsonType
  - isArray
```
public boolean isArray()
```
    Returns false because this is no JSON array representation (in Java).
    
    Specified by:
    
    isArray in interface JsonType
  - getNames
```
public java.util.Collection<java.lang.String> getNames()
```
    Description copied from interface: IReadOnlyNamedValues
    
    Returns all names (maybe empty but never null).
    
    Specified by:
    
    getNames in interface IReadOnlyNamedValues<java.lang.Object>
  - getValue
```
public java.lang.Object getValue(java.lang.String name)
```
    Description copied from interface: IReadOnlyNamedValues
    
    Returns the value associated with the given name.
    
    Specified by:
    
    getValue in interface IReadOnlyNamedValues<java.lang.Object>
    
    Parameters:
    
    name - The identifier for which the associated value must be returned (must not be null).
    
    Returns:
    
    The values associated with the name or null if the name is unknown.
  - getValue
```
public java.lang.Object getValue(IStringConstant name)
```
  - hasField
```
public boolean hasField(java.lang.String name)
```
    Returns whether or not this JSON object contains a field with the given name.
  - hasField
```
public boolean hasField(IStringConstant name)
```
    Returns whether or not this JSON object contains a field with the given name.
  - asString
```
public java.lang.String asString()
```
    Returns the JSON string representation of this object.
    
    Specified by:
    
    asString in interface IStringRepresentation
  - appendAsJSONString
```
public void appendAsJSONString(java.lang.Appendable output)
```
    Description copied from interface: IJSONConvertible
    
    The receiver of this method must append its internal state as JSON string representation to the given buffer.
    
    Specified by:
    
    appendAsJSONString in interface IJSONConvertible
    
    Parameters:
    
    output - The output target to which to append the JSON string (must not be null).
  - toJSON
```
public java.lang.String toJSON()
```
    Description copied from interface: IJSONConvertible
    
    The receiver of this method returns its internal state as JSON string representation.
    
    Specified by:
    
    toJSON in interface IJSONConvertible
  - getTypedElement
```
protected <T> T getTypedElement(java.lang.String name,
                                java.lang.Class<T> type)
```

Class JsonObject

Nested Class Summary

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

Field Summary

Fields inherited from interface org.pfsw.bif.text.IJSONConvertible

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 org.pfsw.bif.facet.IReadOnlyNamedValues

Methods inherited from interface java.util.Map

Constructor Detail

JsonObject

JsonObject

JsonObject

JsonObject

Method Detail

create

put

setField

setField

getJsonObject

getJsonObject

getJsonArray

getJsonArray

getString

getString

getBoolean

getBoolean

getNumber

getNumber

getInteger

getInteger

getLong

getLong

getBigDecimal

getBigDecimal

getValueOfType

getValueOfType

isObject

isArray

getNames

getValue

getValue

hasField

hasField

asString

appendAsJSONString

toJSON

getTypedElement