JsonObject (library 0.9.2-SNAPSHOT API)

java.lang.Object
- com.baasbox.android.json.JsonStructure
- - com.baasbox.android.json.JsonObject

All Implemented Interfaces:

android.os.Parcelable, java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Object>>
```
public class JsonObject
extends JsonStructure
implements java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Object>>, android.os.Parcelable
```
Represents a JSON object. Created by Andrea Tortorella on 01/01/14.

Nested Class Summary
- Nested classes/interfaces inherited from interface android.os.Parcelable
  android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields
Modifier and Type Field and Description

static android.os.Parcelable.Creator<JsonObject> CREATOR

protected java.util.Map<java.lang.String,java.lang.Object> map
- Fields inherited from class com.baasbox.android.json.JsonStructure
  ABSENT, ARRAY, BOOLEAN, NULL, NUMBER, OBJECT, STRING
- Fields inherited from interface android.os.Parcelable
  CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Fields
Modifier and Type	Field and Description
`static android.os.Parcelable.Creator<JsonObject>`	`CREATOR`
`protected java.util.Map<java.lang.String,java.lang.Object>`	`map`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`JsonObject()` Creates a new JsonObject with no mappings
`protected`	`JsonObject(JsonObject object)`
`protected`	`JsonObject(android.os.Parcel source)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JsonObject`	`clear()` Removes all the mappings from this object
`boolean`	`contains(java.lang.String name)` Checks if this object contains a mapping with `name` key
`JsonObject`	`copy()` Creates a deeep copy of this structure.
`static JsonObject`	`decode(java.lang.String json)` Decodes the `json` string passed as parameter.
`int`	`describeContents()`
`java.lang.String`	`encode()` Encodes this structure to it's json representation
`boolean`	`equals(java.lang.Object o)`
`java.util.Set<java.lang.String>`	`fields()` Returns a `Set` of all the keys contained in this document
`static JsonObject`	`from(android.content.ContentValues values)` Creates a new JsonObject based on values contained in the `ContentValues`
`<T> T`	`get(java.lang.String name)`
`JsonArray`	`getArray(java.lang.String name)` Returns the value mapped to `name` as a `JsonArray` or `null` if the mapping is absent.
`JsonArray`	`getArray(java.lang.String name, JsonArray otherwise)` Returns the value mapped to `name` as a `JsonArray` or `otherwise` if the mapping is absent.
`byte[]`	`getBinary(java.lang.String name)` Returns the value mapped to `name` as a `byte[]` array or `null` if the mapping is absent.
`byte[]`	`getBinary(java.lang.String name, byte[] otherwise)` Returns the value mapped to `name` as a `byte[]` array or `otherwise` if the mapping is absent.
`java.lang.Boolean`	`getBoolean(java.lang.String name)` Returns the value mapped to `name` as a `Boolean` or `null` if the mapping is absent.
`boolean`	`getBoolean(java.lang.String name, boolean otherwise)` Returns the value mapped to `name` as a `boolean` or `otherwise` if the mapping is absent.
`java.lang.Double`	`getDouble(java.lang.String name)` Returns the value mapped to `name` as a `Double` or `null` if the mapping is absent.
`double`	`getDouble(java.lang.String name, double otherwise)` Returns the value mapped to `name` as a `double` or `otherwise` if the mapping is absent.
`java.lang.Float`	`getFloat(java.lang.String name)` Returns the value mapped to `name` as a `Float` or `null` if the mapping is absent.
`float`	`getFloat(java.lang.String name, float otherwise)` Returns the value mapped to `name` as a `float` or `otherwise` if the mapping is absent.
`java.lang.Integer`	`getInt(java.lang.String name)` Returns the value mapped to `name` as a `Integer` or `null` if the mapping is absent.
`int`	`getInt(java.lang.String name, int otherwise)` Returns the value mapped to `name` as a `int` or `otherwise` if the mapping is absent.
`java.lang.Long`	`getLong(java.lang.String name)` Returns the value mapped to `name` as a `Long` or `null` if the mapping is absent.
`long`	`getLong(java.lang.String name, long otherwise)` Returns the value mapped to `name` as a `long` or `otherwise` if the mapping is absent.
`JsonObject`	`getObject(java.lang.String name)` Returns the value mapped to `name` as a `JsonObject` or `null` if the mapping is absent.
`JsonObject`	`getObject(java.lang.String name, JsonObject otherwise)` Returns the value mapped to `name` as a `JsonObject` or `otherwise` if the mapping is absent.
`java.lang.String`	`getString(java.lang.String name)` Returns the value mapped to `name` as a `String` or `null` if the mapping is absent.
`java.lang.String`	`getString(java.lang.String name, java.lang.String otherwise)` Returns the value mapped to `name` as a `String` or `otherwise` if the mapping is absent.
`JsonStructure`	`getStructure(java.lang.String name)` Returns the value mapped to `name` as a `JsonStructure` or `null` if the mapping is absent.
`JsonStructure`	`getStructure(java.lang.String name, JsonStructure otherwise)` Returns the value mapped to `name` as a `JsonStructure` or `otherwise` if the mapping is absent.
`int`	`hashCode()`
`boolean`	`isNull(java.lang.String name)` Checks if `name` maps explicitly to `null`
`java.util.Iterator<java.util.Map.Entry<java.lang.String,java.lang.Object>>`	`iterator()` Returns an `Iterator` of the mappings contained in this object
`JsonObject`	`merge(JsonObject other)` Merges the mappings of `other` in this object.
`JsonObject`	`mergeMissing(JsonObject other)` Merges the mappings of `other` in this object.
`static JsonObject`	`of(java.lang.Object... keyValues)`
`protected void`	`onModify()`
`JsonObject`	`put(java.lang.String name, boolean value)` Associate `name` key to the `boolean` `value` in this object.
`JsonObject`	`put(java.lang.String name, byte[] value)` Associate `name` key to the `byte[]` `value` in this object.
`JsonObject`	`put(java.lang.String name, double value)` Associate `name` key to the `double` `value` in this object.
`JsonObject`	`put(java.lang.String name, JsonArray value)` Associate `name` key to the `JsonArray` `value` in this object.
`JsonObject`	`put(java.lang.String name, JsonObject value)` Associate `name` key to the `JsonObject` `value` in this object.
`JsonObject`	`put(java.lang.String name, long value)` Associate `name` key to the `long` `value` in this object.
`JsonObject`	`put(java.lang.String name, java.lang.String value)` Associate `name` key to the `String` `value` in this object.
`JsonObject`	`putNull(java.lang.String name)` Puts an explicit mapping to from `name` to `null` in this object.
`java.lang.Object`	`remove(java.lang.String name)` Removes the mapping with `name` key from the object.
`int`	`size()` Returns the number of mappings in this object
`java.lang.String`	`toString()`
`int`	`typeAt(java.lang.String key)`
`JsonArray`	`values()` Returns the values contained in this structure as a `JsonArray`
`JsonObject`	`without(java.lang.String name)` Removes the mapping with `name` key from the object.
`void`	`writeToParcel(android.os.Parcel dest, int flags)`

Methods inherited from class com.baasbox.android.json.JsonStructure
asArray, asObject, isArray, isObject

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - CREATOR
```
public static final android.os.Parcelable.Creator<JsonObject> CREATOR
```
  - map
```
protected java.util.Map<java.lang.String,java.lang.Object> map
```
- Constructor Detail
  - JsonObject
```
public JsonObject()
```
    Creates a new JsonObject with no mappings
  - JsonObject
```
protected JsonObject(android.os.Parcel source)
```
  - JsonObject
```
protected JsonObject(JsonObject object)
```
- Method Detail
  - copy
```
public JsonObject copy()
```
    Description copied from class: JsonStructure
    
    Creates a deeep copy of this structure.
    
    Specified by:
    
    copy in class JsonStructure
    
    Returns:
    
    a new JsonStructure with the same content
  - from
```
public static JsonObject from(android.content.ContentValues values)
```
    Creates a new JsonObject based on values contained in the ContentValues
    
    Parameters:
    
    values - non null values
    
    Returns:
    
    a new JsonObject with the values mapped in
  - of
```
public static JsonObject of(java.lang.Object... keyValues)
```
  - decode
```
public static JsonObject decode(java.lang.String json)
```
    Decodes the json string passed as parameter.
    
    Parameters:
    
    json - the string to decode
    
    Returns:
    
    a new JsonObject representation of the string
    
    Throws:
    
    JsonException - if an error happens during parsing of the string
  - put
```
public JsonObject put(java.lang.String name,
                      java.lang.String value)
```
    Associate name key to the String value in this object.
    
    Parameters:
    
    name - a non null key
    
    value - a String value
    
    Returns:
    
    this object with the new mapping created
  - put
```
public JsonObject put(java.lang.String name,
                      boolean value)
```
    Associate name key to the boolean value in this object.
    
    Parameters:
    
    name - a non null key
    
    value - a boolean value
    
    Returns:
    
    this object with the new mapping created
  - put
```
public JsonObject put(java.lang.String name,
                      long value)
```
    Associate name key to the long value in this object.
    
    Parameters:
    
    name - a non null key
    
    value - a long value
    
    Returns:
    
    this object with the new mapping created
  - put
```
public JsonObject put(java.lang.String name,
                      double value)
```
    Associate name key to the double value in this object.
    
    Parameters:
    
    name - a non null key
    
    value - a double value
    
    Returns:
    
    this object with the new mapping created
  - putNull
```
public JsonObject putNull(java.lang.String name)
```
    Puts an explicit mapping to from name to null in this object.
    This is different from not having the mapping at all, to completely remove the mapping use instead JsonObject.remove(String)
    
    Parameters:
    
    name - a non null key
    
    Returns:
    
    this object with the new mapping created
    
    See Also:
    
    JsonObject.remove(String)
  - put
```
public JsonObject put(java.lang.String name,
                      JsonArray value)
```
    Associate name key to the JsonArray value in this object.
    
    Parameters:
    
    name - a non null key
    
    value - a JsonArray or null
    
    Returns:
    
    this object with the new mapping created
  - onModify
```
protected void onModify()
```
  - put
```
public JsonObject put(java.lang.String name,
                      JsonObject value)
```
    Associate name key to the JsonObject value in this object.
    
    Parameters:
    
    name - a non null key
    
    value - a JsonObject
    
    Returns:
    
    this object with the new mapping created
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - encode
```
public java.lang.String encode()
```
    Description copied from class: JsonStructure
    
    Encodes this structure to it's json representation
    
    Specified by:
    
    encode in class JsonStructure
    
    Returns:
    
    a string representation of this structure
  - iterator
```
public java.util.Iterator<java.util.Map.Entry<java.lang.String,java.lang.Object>> iterator()
```
    Returns an Iterator of the mappings contained in this object
    
    Specified by:
    
    iterator in interface java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Object>>
    
    Returns:
    
    an iterator of the mappings
  - describeContents
```
public int describeContents()
```
    Specified by:
    
    describeContents in interface android.os.Parcelable
  - writeToParcel
```
public void writeToParcel(android.os.Parcel dest,
                          int flags)
```
    Specified by:
    
    writeToParcel in interface android.os.Parcelable
  - clear
```
public JsonObject clear()
```
    Removes all the mappings from this object
    
    Specified by:
    
    clear in class JsonStructure
    
    Returns:
    
    this object without any mapping
  - contains
```
public boolean contains(java.lang.String name)
```
    Checks if this object contains a mapping with name key
    
    Parameters:
    
    name - a non null key
    
    Returns:
    
    true if the object contains the mapping false otherwise
  - get
```
public <T> T get(java.lang.String name)
```
  - getArray
```
public JsonArray getArray(java.lang.String name)
```
    Returns the value mapped to name as a JsonArray or null if the mapping is absent.
    
    Parameters:
    
    name - a non null key
    
    Returns:
    
    the value mapped to name or null
  - getArray
```
public JsonArray getArray(java.lang.String name,
                          JsonArray otherwise)
```
    Returns the value mapped to name as a JsonArray or otherwise if the mapping is absent.
    
    Parameters:
    
    name - a non null key
    
    otherwise - a default value
    
    Returns:
    
    the value mapped to name or otherwise
  - getBinary
```
public byte[] getBinary(java.lang.String name)
```
    Returns the value mapped to name as a byte[] array or null if the mapping is absent.
    
    Parameters:
    
    name - a non null key
    
    Returns:
    
    the value mapped to name or null
  - getBinary
```
public byte[] getBinary(java.lang.String name,
                        byte[] otherwise)
```
    Returns the value mapped to name as a byte[] array or otherwise if the mapping is absent.
    
    Parameters:
    
    name - a non null key
    
    otherwise - a default value
    
    Returns:
    
    the value mapped to name or otherwise
  - getBoolean
```
public java.lang.Boolean getBoolean(java.lang.String name)
```
    Returns the value mapped to name as a Boolean or null if the mapping is absent.
    
    Parameters:
    
    name - a non null key
    
    Returns:
    
    the value mapped to name or null
  - getBoolean
```
public boolean getBoolean(java.lang.String name,
                          boolean otherwise)
```
    Returns the value mapped to name as a boolean or otherwise if the mapping is absent.
    
    Parameters:
    
    otherwise - a boolean default
    
    name - a non null key
    
    Returns:
    
    the value mapped to name or otherwise
  - getDouble
```
public double getDouble(java.lang.String name,
                        double otherwise)
```
    Returns the value mapped to name as a double or otherwise if the mapping is absent.
    
    Parameters:
    
    otherwise - a double default
    
    name - a non null key
    
    Returns:
    
    the value mapped to name or otherwise
  - getFloat
```
public java.lang.Float getFloat(java.lang.String name)
```
    Returns the value mapped to name as a Float or null if the mapping is absent.
    
    Parameters:
    
    name - a non null key
    
    Returns:
    
    the value mapped to name or null
  - getDouble
```
public java.lang.Double getDouble(java.lang.String name)
```
    Returns the value mapped to name as a Double or null if the mapping is absent.
    
    Parameters:
    
    name - a non null key
    
    Returns:
    
    the value mapped to name or null
  - getFloat
```
public float getFloat(java.lang.String name,
                      float otherwise)
```
    Returns the value mapped to name as a float or otherwise if the mapping is absent.
    
    Parameters:
    
    otherwise - a float default
    
    name - a non null key
    
    Returns:
    
    the value mapped to name or otherwise
  - getInt
```
public java.lang.Integer getInt(java.lang.String name)
```
    Returns the value mapped to name as a Integer or null if the mapping is absent.
    
    Parameters:
    
    name - a non null key
    
    Returns:
    
    the value mapped to name or null
  - getLong
```
public java.lang.Long getLong(java.lang.String name)
```
    Returns the value mapped to name as a Long or null if the mapping is absent.
    
    Parameters:
    
    name - a non null key
    
    Returns:
    
    the value mapped to name or null
  - getInt
```
public int getInt(java.lang.String name,
                  int otherwise)
```
    Returns the value mapped to name as a int or otherwise if the mapping is absent.
    
    Parameters:
    
    otherwise - a int default
    
    name - a non null key
    
    Returns:
    
    the value mapped to name or otherwise
  - getLong
```
public long getLong(java.lang.String name,
                    long otherwise)
```
    Returns the value mapped to name as a long or otherwise if the mapping is absent.
    
    Parameters:
    
    otherwise - a long default
    
    name - a non null key
    
    Returns:
    
    the value mapped to name or otherwise
  - getObject
```
public JsonObject getObject(java.lang.String name)
```
    Returns the value mapped to name as a JsonObject or null if the mapping is absent.
    
    Parameters:
    
    name - a non null key
    
    Returns:
    
    the value mapped to name or null
  - getObject
```
public JsonObject getObject(java.lang.String name,
                            JsonObject otherwise)
```
    Returns the value mapped to name as a JsonObject or otherwise if the mapping is absent.
    
    Parameters:
    
    name - a non null key
    
    otherwise - a default value
    
    Returns:
    
    the value mapped to name or otherwise
  - getString
```
public java.lang.String getString(java.lang.String name)
```
    Returns the value mapped to name as a String or null if the mapping is absent.
    
    Parameters:
    
    name - a non null key
    
    Returns:
    
    the value mapped to name or null
  - getString
```
public java.lang.String getString(java.lang.String name,
                                  java.lang.String otherwise)
```
    Returns the value mapped to name as a String or otherwise if the mapping is absent.
    
    Parameters:
    
    name - a non null key
    
    otherwise - a default value
    
    Returns:
    
    the value mapped to name or otherwise
  - getStructure
```
public JsonStructure getStructure(java.lang.String name)
```
    Returns the value mapped to name as a JsonStructure or null if the mapping is absent.
    
    Parameters:
    
    name - a non null key
    
    Returns:
    
    the value mapped to name or null
  - getStructure
```
public JsonStructure getStructure(java.lang.String name,
                                  JsonStructure otherwise)
```
    Returns the value mapped to name as a JsonStructure or otherwise if the mapping is absent.
    
    Parameters:
    
    name - a non null key
    
    otherwise - a default value
    
    Returns:
    
    the value mapped to name or otherwise
  - typeAt
```
public int typeAt(java.lang.String key)
```
  - isNull
```
public boolean isNull(java.lang.String name)
```
    Checks if name maps explicitly to null
    
    Parameters:
    
    name - a non null key
    
    Returns:
    
    true if the object contains a mapping from name to null false otherwise
  - merge
```
public JsonObject merge(JsonObject other)
```
    Merges the mappings of other in this object.
    
    Parameters:
    
    other - an object to merge in
    
    Returns:
    
    this object with the mappings of other
  - mergeMissing
```
public JsonObject mergeMissing(JsonObject other)
```
    Merges the mappings of other in this object. Fields that are present in this object are not overwritten.
    
    Parameters:
    
    other - an object to merge in
    
    Returns:
    
    this object with the mappings of other
  - fields
```
public java.util.Set<java.lang.String> fields()
```
    Returns a Set of all the keys contained in this document
    
    Returns:
    
    a set of the keys contained in this document
  - put
```
public JsonObject put(java.lang.String name,
                      byte[] value)
```
    Associate name key to the byte[] value in this object. Note that binary data is encoded using base64 and added as strings in the object.
    
    Parameters:
    
    name - a non null key
    
    value - a byte[] array
    
    Returns:
    
    this object with the new mapping created
  - size
```
public int size()
```
    Returns the number of mappings in this object
    
    Returns:
    
    the size of this object
  - values
```
public JsonArray values()
```
    Description copied from class: JsonStructure
    
    Returns the values contained in this structure as a JsonArray
    
    Specified by:
    
    values in class JsonStructure
    
    Returns:
    
    the values of this structure
  - without
```
public JsonObject without(java.lang.String name)
```
    Removes the mapping with name key from the object.
    
    Parameters:
    
    name - a non null key
    
    Returns:
    
    this object with the mapping removed
  - remove
```
public java.lang.Object remove(java.lang.String name)
```
    Removes the mapping with name key from the object.
    
    Parameters:
    
    name - a non null key
    
    Returns:
    
    the value that was mapped to name if present or null

Class JsonObject

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Field Summary

Fields inherited from class com.baasbox.android.json.JsonStructure

Fields inherited from interface android.os.Parcelable

Constructor Summary

Method Summary

Methods inherited from class com.baasbox.android.json.JsonStructure

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

CREATOR

map

Constructor Detail

JsonObject

JsonObject

JsonObject

Method Detail

copy

from

of

decode

put

put

put

put

putNull

put

onModify

put

equals

hashCode

toString

encode

iterator

describeContents

writeToParcel

clear

contains

get

getArray

getArray

getBinary

getBinary

getBoolean

getBoolean

getDouble

getFloat

getDouble

getFloat

getInt

getLong

getInt

getLong

getObject

getObject

getString

getString

getStructure

getStructure

typeAt

isNull

merge

mergeMissing

fields

put

size

values

without

remove