JsonObject (jjson-core API)

java.lang.Object
- org.djodjo.json.JsonElement
- - org.djodjo.json.JsonObject

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable<java.util.Map.Entry<java.lang.String,JsonElement>>, Freezable<JsonObject>
```
public final class JsonObject
extends JsonElement
implements java.lang.Iterable<java.util.Map.Entry<java.lang.String,JsonElement>>, Freezable<JsonObject>
```
A modifiable set of name/value mappings. Names are unique, non-null strings. Values may be any mix of JsonObjects, JsonArrays, Strings, Booleans, Integers, Longs, Doubles or JsonNull. Values may not be null, NaNs, infinities, or of any type not listed here.
This class can coerce values to another type when requested.
- When the requested type is a boolean, strings will be coerced using a case-insensitive comparison to "true" and "false".
- When the requested type is a double, other Number types will be coerced using doubleValue. Strings that can be coerced using Double.valueOf(String) will be.
- When the requested type is an int, other Number types will be coerced using intValue. Strings that can be coerced using Double.valueOf(String) will be, and then cast to int.
- When the requested type is a long, other Number types will be coerced using longValue. Strings that can be coerced using Double.valueOf(String) will be, and then cast to long. This two-step conversion is lossy for very large values. For example, the string "9223372036854775806" yields the long 9223372036854775807.
- When the requested type is a String, other non-null values will be coerced using String.valueOf(Object). Although null cannot be coerced, the sentinel value JsonNull is coerced to the string "null".
This class can look up both mandatory and optional values:
- Use getType() to retrieve a mandatory value. This fails with a JsonException if the requested name has no value or if the value cannot be coerced to the requested type.
- Use optType() to retrieve an optional value. This returns a system- or user-supplied default if the requested name has no value or if the value cannot be coerced to the requested type.
Warning: this class represents null in two incompatible ways: the standard Java null reference, and the sentinel value JsonNull. In particular, calling put(name, null) removes the named entry from the object but put(name, JsonObject.NULL) stores an entry whose value is JsonObject.NULL.
Instances of this class are not thread safe. Although this class is nonfinal, it was not designed for inheritance and should not be subclassed. In particular, self-use by overrideable methods is not specified. See Effective Java Item 17, "Design and Document or inheritance or else prohibit it" for further information.

Constructor Summary

Constructors
Constructor and Description
`JsonObject()` Creates a `JsonObject` with no name/value mappings.
`JsonObject(java.util.Map copyFrom)` Creates a new `JSONObject` by copying all name/value mappings from the given map.

Method Summary

Methods
Modifier and Type	Method and Description
`JsonObject`	`accumulate(java.lang.String name, java.lang.Object value)` Appends `value` to the array already mapped to `name`.
`JsonObject`	`append(java.lang.String name, java.lang.Object value)` Appends values to the array mapped to `name`.
`JsonObject`	`asJsonObject()`
`void`	`checkIfFrozen()`
`JsonObject`	`clear()`
`JsonObject`	`cloneAsThawed()` Provides for the clone operation.
`boolean`	`equals(java.lang.Object o)`
`JsonObject`	`freeze()` Freezes the object.
`JsonElement`	`get(java.lang.String name)` Returns the value mapped by `name`, or throws if no such mapping exists.
`java.lang.Boolean`	`getBoolean(java.lang.String name)` Returns the value mapped by `name` if it exists and is a boolean or can be coerced to a boolean, or throws otherwise.
`java.lang.Boolean`	`getBoolean(java.lang.String name, boolean strict)` Returns the value mapped by `name` if it exists and is a boolean or can be coerced to a boolean, or throws otherwise.
`java.lang.Double`	`getDouble(java.lang.String name)`
`java.lang.Double`	`getDouble(java.lang.String name, boolean strict)` Returns the value mapped by `name` if it exists and is a double or can be coerced to a double, or throws otherwise.
`java.lang.Integer`	`getInt(java.lang.String name)`
`java.lang.Integer`	`getInt(java.lang.String name, boolean strict)` Returns the value mapped by `name` if it exists and is an int or can be coerced to an int, or throws otherwise.
`JsonArray`	`getJsonArray(java.lang.String name)` Returns the value mapped by `name` if it exists and is a `JsonArray`, or throws otherwise.
`JsonObject`	`getJsonObject(java.lang.String name)` Returns the value mapped by `name` if it exists and is a `JsonObject`, or throws otherwise.
`java.lang.String`	`getJsonType()`
`java.lang.Long`	`getLong(java.lang.String name)`
`java.lang.Long`	`getLong(java.lang.String name, boolean strict)` Returns the value mapped by `name` if it exists and is a long or can be coerced to a long, or throws otherwise.
`java.lang.String`	`getString(java.lang.String name)`
`java.lang.String`	`getString(java.lang.String name, boolean strict)` Returns the value mapped by `name` if it exists, coercing it if necessary, or throws if no such mapping exists.
`boolean`	`has(java.lang.String name)` Returns true if this object has a mapping for `name`.
`boolean`	`isFrozen()` Determines whether the object has been frozen or not.
`boolean`	`isJsonObject()`
`boolean`	`isNull(java.lang.String name)` Returns true if this object has no mapping for `name` or if it has a mapping whose value is `JsonNull`.
`java.util.Iterator<java.util.Map.Entry<java.lang.String,JsonElement>>`	`iterator()`
`java.util.Iterator<java.lang.String>`	`keys()` Returns an iterator of the `String` names in this object.
`java.util.Set<java.lang.String>`	`keySet()` Returns the set of `String` names in this object.
`int`	`length()` Returns the number of name/value mappings in this object.
`JsonObject`	`merge(JsonObject another)` Merge Json Object with another Json Object.
`JsonArray`	`names()` Returns an array containing the string names in this object.
`JsonElement`	`opt(java.lang.String name)` Returns the value mapped by `name`, or null if no such mapping exists.
`java.lang.Boolean`	`optBoolean(java.lang.String name)` Returns the value mapped by `name` if it exists and is a boolean or can be coerced to a boolean, or false otherwise.
`java.lang.Boolean`	`optBoolean(java.lang.String name, java.lang.Boolean fallback)` Returns the value mapped by `name` if it exists and is a boolean or `fallback` otherwise.
`java.lang.Boolean`	`optBoolean(java.lang.String name, java.lang.Boolean fallback, boolean strict)`
`java.lang.Double`	`optDouble(java.lang.String name)` Returns the value mapped by `name` if it exists and is a double or can be coerced to a double, or `NaN` otherwise.
`java.lang.Double`	`optDouble(java.lang.String name, java.lang.Double fallback)` Returns the value mapped by `name` if it exists and is a double or can be coerced to a double, or `fallback` otherwise.
`java.lang.Double`	`optDouble(java.lang.String name, java.lang.Double fallback, boolean strict)`
`java.lang.Integer`	`optInt(java.lang.String name)` Returns the value mapped by `name` if it exists and is an int or can be coerced to an int, or 0 otherwise.
`java.lang.Integer`	`optInt(java.lang.String name, java.lang.Integer fallback)` Returns the value mapped by `name` if it exists and is an int or can be coerced to an int, or `fallback` otherwise.
`java.lang.Integer`	`optInt(java.lang.String name, java.lang.Integer fallback, boolean strict)`
`JsonArray`	`optJsonArray(java.lang.String name)` Returns the value mapped by `name` if it exists and is a `JsonArray`, or null otherwise.
`JsonObject`	`optJsonObject(java.lang.String name)` Returns the value mapped by `name` if it exists and is a `JsonObject`, or null otherwise.
`java.lang.Long`	`optLong(java.lang.String name)` Returns the value mapped by `name` if it exists and is a long or can be coerced to a long, or 0 otherwise.
`java.lang.Long`	`optLong(java.lang.String name, java.lang.Long fallback)` Returns the value mapped by `name` if it exists and is a long or can be coerced to a long, or `fallback` otherwise.
`java.lang.Long`	`optLong(java.lang.String name, java.lang.Long fallback, boolean strict)`
`java.lang.String`	`optString(java.lang.String name)` Returns the value mapped by `name` if it exists, coercing it if necessary, or the empty string if no such mapping exists.
`java.lang.String`	`optString(java.lang.String name, java.lang.String fallback)` Returns the value mapped by `name` if it exists, coercing it if necessary, or `fallback` if no such mapping exists.
`java.lang.String`	`optString(java.lang.String name, java.lang.String fallback, boolean strict)`
`JsonObject`	`put(java.lang.String name, boolean value)` Maps `name` to `value`, clobbering any existing name/value mapping with the same name.
`JsonObject`	`put(java.lang.String name, double value)` Maps `name` to `value`, clobbering any existing name/value mapping with the same name.
`JsonObject`	`put(java.lang.String name, int value)` Maps `name` to `value`, clobbering any existing name/value mapping with the same name.
`JsonObject`	`put(java.lang.String name, JsonElement value)` Maps `name` to `value`, clobbering any existing name/value mapping with the same name.
`JsonObject`	`put(java.lang.String name, long value)` Maps `name` to `value`, clobbering any existing name/value mapping with the same name.
`JsonObject`	`put(java.lang.String name, java.lang.Object value)` Maps `name` to `value`, clobbering any existing name/value mapping with the same name.
`JsonObject`	`putOpt(java.lang.String name, java.lang.Object value)` Equivalent to `put(name, value)` when both parameters are non-null; does nothing otherwise.
`java.lang.Object`	`remove(java.lang.String name)` Removes the named mapping if it exists; does nothing otherwise.
`JsonArray`	`toJsonArray(JsonArray names)` Returns an array with the values corresponding to `names`.
`java.util.Collection<JsonElement>`	`valuesSet()`
`void`	`write(JsonWriter writer)`

Methods inherited from class org.djodjo.json.JsonElement
asBoolean, asByte, asDouble, asFloat, asInt, asJsonArray, asLong, asString, hashCode, isBoolean, isJsonArray, isNull, isNumber, isString, readFrom, readFrom, toString, wrap, writeTo

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

- Constructor Detail
  - JsonObject
```
public JsonObject()
```
    Creates a JsonObject with no name/value mappings.
  - JsonObject
```
public JsonObject(java.util.Map copyFrom)
           throws JsonException
```
    Creates a new JSONObject by copying all name/value mappings from the given map.
    
    Parameters:
    copyFrom - a map whose keys are of type String and whose values are of supported types.
    
    Throws:
    
    java.lang.NullPointerException - if any of the map's keys are null.
    
    JsonException
- Method Detail
  - length
```
public int length()
```
    Returns the number of name/value mappings in this object.
  - put
```
public JsonObject put(java.lang.String name,
             boolean value)
               throws JsonException
```
    Maps name to value, clobbering any existing name/value mapping with the same name.
    
    Returns:
    this object.
    
    Throws:
    
    JsonException
  - put
```
public JsonObject put(java.lang.String name,
             double value)
               throws JsonException
```
    Maps name to value, clobbering any existing name/value mapping with the same name.
    
    Parameters:
    value - a finite value. May not be NaNs or infinities.
    
    Returns:
    this object.
    
    Throws:
    
    JsonException
  - put
```
public JsonObject put(java.lang.String name,
             int value)
               throws JsonException
```
    Maps name to value, clobbering any existing name/value mapping with the same name.
    
    Returns:
    this object.
    
    Throws:
    
    JsonException
  - put
```
public JsonObject put(java.lang.String name,
             long value)
               throws JsonException
```
    Maps name to value, clobbering any existing name/value mapping with the same name.
    
    Returns:
    this object.
    
    Throws:
    
    JsonException
  - put
```
public JsonObject put(java.lang.String name,
             java.lang.Object value)
               throws JsonException
```
    Maps name to value, clobbering any existing name/value mapping with the same name. If the value is null, any existing mapping for name is removed.
    
    Parameters:
    value - a JsonObject, JsonArray, String, Boolean, Integer, Long, Double, null. May not be NaNs or infinities.
    
    Returns:
    this object.
    
    Throws:
    
    JsonException
  - put
```
public JsonObject put(java.lang.String name,
             JsonElement value)
               throws JsonException
```
    Maps name to value, clobbering any existing name/value mapping with the same name. If the value is null, any existing mapping for name is removed.
    
    Parameters:
    value - a JsonObject, JsonArray, JsonString, JsonBoolean, JsonNumber, JsonNull. May not be NaNs or infinities.
    
    Returns:
    this object.
    
    Throws:
    
    JsonException
  - putOpt
```
public JsonObject putOpt(java.lang.String name,
                java.lang.Object value)
                  throws JsonException
```
    Equivalent to put(name, value) when both parameters are non-null; does nothing otherwise.
    
    Throws:
    
    JsonException
  - accumulate
```
public JsonObject accumulate(java.lang.String name,
                    java.lang.Object value)
                      throws JsonException
```
    Appends value to the array already mapped to name. If this object has no mapping for name, this inserts a new mapping. If the mapping exists but its value is not an array, the existing and new values are inserted in order into a new array which is itself mapped to name. In aggregate, this allows values to be added to a mapping one at a time.
    Note that append(String, Object) provides better semantics. In particular, the mapping for name will always be a JsonArray. Using accumulate will result in either a JsonArray or a mapping whose type is the type of value depending on the number of calls to it.
    
    Parameters:
    value - a JsonObject, JsonArray, String, Boolean, Integer, Long, Double or null. May not be NaNs or infinities.
    
    Throws:
    
    JsonException
  - append
```
public JsonObject append(java.lang.String name,
                java.lang.Object value)
                  throws JsonException
```
    Appends values to the array mapped to name. A new JsonArray mapping for name will be inserted if no mapping exists. If the existing mapping for name is not a JsonArray, a JsonException will be thrown.
    
    Throws:
    
    JsonException - if name is null or if the mapping for name is non-null and is not a JsonArray.
  - remove
```
public java.lang.Object remove(java.lang.String name)
```
    Removes the named mapping if it exists; does nothing otherwise.
    
    Returns:
    the value previously mapped by name, or null if there was no such mapping.
  - isNull
```
public boolean isNull(java.lang.String name)
```
    Returns true if this object has no mapping for name or if it has a mapping whose value is JsonNull.
  - has
```
public boolean has(java.lang.String name)
```
    Returns true if this object has a mapping for name. The mapping may be JsonNull.
  - get
```
public JsonElement get(java.lang.String name)
                throws JsonException
```
    Returns the value mapped by name, or throws if no such mapping exists.
    
    Throws:
    
    JsonException - if no such mapping exists.
  - opt
```
public JsonElement opt(java.lang.String name)
```
    Returns the value mapped by name, or null if no such mapping exists.
  - getBoolean
```
public java.lang.Boolean getBoolean(java.lang.String name,
                           boolean strict)
                             throws JsonException
```
    Returns the value mapped by name if it exists and is a boolean or can be coerced to a boolean, or throws otherwise.
    
    Throws:
    
    JsonException - if the mapping doesn't exist or cannot be coerced to a boolean.
  - getBoolean
```
public java.lang.Boolean getBoolean(java.lang.String name)
                             throws JsonException
```
    Returns the value mapped by name if it exists and is a boolean or can be coerced to a boolean, or throws otherwise.
    
    Throws:
    
    JsonException - if the mapping doesn't exist or cannot be coerced to a boolean.
  - optBoolean
```
public java.lang.Boolean optBoolean(java.lang.String name)
```
    Returns the value mapped by name if it exists and is a boolean or can be coerced to a boolean, or false otherwise.
  - optBoolean
```
public java.lang.Boolean optBoolean(java.lang.String name,
                           java.lang.Boolean fallback)
```
    Returns the value mapped by name if it exists and is a boolean or fallback otherwise.
  - optBoolean
```
public java.lang.Boolean optBoolean(java.lang.String name,
                           java.lang.Boolean fallback,
                           boolean strict)
```
  - getDouble
```
public java.lang.Double getDouble(java.lang.String name,
                         boolean strict)
                           throws JsonException
```
    Returns the value mapped by name if it exists and is a double or can be coerced to a double, or throws otherwise.
    
    Throws:
    
    JsonException - if the mapping doesn't exist or cannot be coerced to a double.
  - getDouble
```
public java.lang.Double getDouble(java.lang.String name)
                           throws JsonException
```
    Throws:
    
    JsonException
  - optDouble
```
public java.lang.Double optDouble(java.lang.String name)
```
    Returns the value mapped by name if it exists and is a double or can be coerced to a double, or NaN otherwise.
  - optDouble
```
public java.lang.Double optDouble(java.lang.String name,
                         java.lang.Double fallback)
```
    Returns the value mapped by name if it exists and is a double or can be coerced to a double, or fallback otherwise.
  - optDouble
```
public java.lang.Double optDouble(java.lang.String name,
                         java.lang.Double fallback,
                         boolean strict)
```
  - getInt
```
public java.lang.Integer getInt(java.lang.String name,
                       boolean strict)
                         throws JsonException
```
    Returns the value mapped by name if it exists and is an int or can be coerced to an int, or throws otherwise.
    
    Throws:
    
    JsonException - if the mapping doesn't exist or cannot be coerced to an int.
  - getInt
```
public java.lang.Integer getInt(java.lang.String name)
                         throws JsonException
```
    Throws:
    
    JsonException
  - optInt
```
public java.lang.Integer optInt(java.lang.String name)
```
    Returns the value mapped by name if it exists and is an int or can be coerced to an int, or 0 otherwise.
  - optInt
```
public java.lang.Integer optInt(java.lang.String name,
                       java.lang.Integer fallback)
```
    Returns the value mapped by name if it exists and is an int or can be coerced to an int, or fallback otherwise.
  - optInt
```
public java.lang.Integer optInt(java.lang.String name,
                       java.lang.Integer fallback,
                       boolean strict)
```
  - getLong
```
public java.lang.Long getLong(java.lang.String name,
                     boolean strict)
                       throws JsonException
```
    Returns the value mapped by name if it exists and is a long or can be coerced to a long, or throws otherwise. Note that Util represents numbers as doubles, so this is lossy; use strings to transfer numbers via Util.
    
    Throws:
    
    JsonException - if the mapping doesn't exist or cannot be coerced to a long.
  - getLong
```
public java.lang.Long getLong(java.lang.String name)
                       throws JsonException
```
    Throws:
    
    JsonException
  - optLong
```
public java.lang.Long optLong(java.lang.String name)
```
    Returns the value mapped by name if it exists and is a long or can be coerced to a long, or 0 otherwise. Note that Util represents numbers as doubles, so this is lossy; use strings to transfer numbers via Util.
  - optLong
```
public java.lang.Long optLong(java.lang.String name,
                     java.lang.Long fallback)
```
    Returns the value mapped by name if it exists and is a long or can be coerced to a long, or fallback otherwise. Note that Util represents numbers as doubles, so this is lossy; use strings to transfer numbers via Util.
  - optLong
```
public java.lang.Long optLong(java.lang.String name,
                     java.lang.Long fallback,
                     boolean strict)
```
  - getString
```
public java.lang.String getString(java.lang.String name,
                         boolean strict)
                           throws JsonException
```
    Returns the value mapped by name if it exists, coercing it if necessary, or throws if no such mapping exists.
    
    Throws:
    
    JsonException - if no such mapping exists.
  - getString
```
public java.lang.String getString(java.lang.String name)
                           throws JsonException
```
    Throws:
    
    JsonException
  - optString
```
public java.lang.String optString(java.lang.String name)
```
    Returns the value mapped by name if it exists, coercing it if necessary, or the empty string if no such mapping exists.
  - optString
```
public java.lang.String optString(java.lang.String name,
                         java.lang.String fallback)
```
    Returns the value mapped by name if it exists, coercing it if necessary, or fallback if no such mapping exists.
  - optString
```
public java.lang.String optString(java.lang.String name,
                         java.lang.String fallback,
                         boolean strict)
```
  - getJsonArray
```
public JsonArray getJsonArray(java.lang.String name)
                       throws JsonException
```
    Returns the value mapped by name if it exists and is a JsonArray, or throws otherwise.
    
    Throws:
    
    JsonException - if the mapping doesn't exist or is not a JsonArray.
  - optJsonArray
```
public JsonArray optJsonArray(java.lang.String name)
```
    Returns the value mapped by name if it exists and is a JsonArray, or null otherwise.
  - getJsonObject
```
public JsonObject getJsonObject(java.lang.String name)
                         throws JsonException
```
    Returns the value mapped by name if it exists and is a JsonObject, or throws otherwise.
    
    Throws:
    
    JsonException - if the mapping doesn't exist or is not a JsonObject.
  - optJsonObject
```
public JsonObject optJsonObject(java.lang.String name)
```
    Returns the value mapped by name if it exists and is a JsonObject, or null otherwise.
  - toJsonArray
```
public JsonArray toJsonArray(JsonArray names)
                      throws JsonException
```
    Returns an array with the values corresponding to names. The array contains null for names that aren't mapped. This method returns null if names is either null or empty.
    
    Throws:
    
    JsonException
  - keys
```
public java.util.Iterator<java.lang.String> keys()
```
    Returns an iterator of the String names in this object. The returned iterator supports remove, which will remove the corresponding mapping from this object. If this object is modified after the iterator is returned, the iterator's behavior is undefined. The order of the keys is undefined.
  - keySet
```
public java.util.Set<java.lang.String> keySet()
```
    Returns the set of String names in this object. The returned set is a view of the keys in this object. Set.remove(Object) will remove the corresponding mapping from this object and set iterator behaviour is undefined if this object is modified after it is returned. See keys().
  - valuesSet
```
public java.util.Collection<JsonElement> valuesSet()
```
  - names
```
public JsonArray names()
                throws JsonException
```
    Returns an array containing the string names in this object. This method returns null if this object contains no mappings.
    
    Throws:
    
    JsonException
  - write
```
public void write(JsonWriter writer)
           throws java.io.IOException
```
    Specified by:
    
    write in class JsonElement
    
    Throws:
    
    java.io.IOException
  - isJsonObject
```
public boolean isJsonObject()
```
    Overrides:
    
    isJsonObject in class JsonElement
  - asJsonObject
```
public JsonObject asJsonObject()
```
    Overrides:
    
    asJsonObject in class JsonElement
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class JsonElement
  - getJsonType
```
public java.lang.String getJsonType()
```
    Specified by:
    
    getJsonType in class JsonElement
  - iterator
```
public java.util.Iterator<java.util.Map.Entry<java.lang.String,JsonElement>> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<java.util.Map.Entry<java.lang.String,JsonElement>>
  - merge
```
public JsonObject merge(JsonObject another)
```
    Merge Json Object with another Json Object. It does not change element of another with the same name exists. However if the element is Json Object then it will go down and merge that object.
    
    Parameters:
    another -
    
    Returns:
  - clear
```
public JsonObject clear()
```
  - isFrozen
```
public boolean isFrozen()
```
    Description copied from interface: Freezable
    
    Determines whether the object has been frozen or not.
    
    Specified by:
    
    isFrozen in interface Freezable<JsonObject>
  - freeze
```
public JsonObject freeze()
```
    Description copied from interface: Freezable
    
    Freezes the object.
    
    Specified by:
    
    freeze in interface Freezable<JsonObject>
    
    Returns:
    the object itself.
  - cloneAsThawed
```
public JsonObject cloneAsThawed()
```
    Description copied from interface: Freezable
    
    Provides for the clone operation. Any clone is initially unfrozen.
    
    Specified by:
    
    cloneAsThawed in interface Freezable<JsonObject>
  - checkIfFrozen
```
public void checkIfFrozen()
```

Class JsonObject

Constructor Summary

Method Summary

Methods inherited from class org.djodjo.json.JsonElement

Methods inherited from class java.lang.Object

Constructor Detail

JsonObject

JsonObject

Method Detail

length

put

put

put

put

put

put

putOpt

accumulate

append

remove

isNull

has

get

opt

getBoolean

getBoolean

optBoolean

optBoolean

optBoolean

getDouble

getDouble

optDouble

optDouble

optDouble

getInt

getInt

optInt

optInt

optInt

getLong

getLong

optLong

optLong

optLong

getString

getString

optString

optString

optString

getJsonArray

optJsonArray

getJsonObject

optJsonObject

toJsonArray

keys

keySet

valuesSet

names

write

isJsonObject

asJsonObject

equals

getJsonType

iterator

merge

clear

isFrozen

freeze

cloneAsThawed

checkIfFrozen