com.couchbase.client.java.document.json

Class JsonObject

java.lang.Object

com.couchbase.client.java.document.json.JsonValue

com.couchbase.client.java.document.json.JsonObject

public class JsonObject
extends JsonValue

Represents a JSON object that can be stored and loaded from Couchbase Server.

If boxed return values are unboxed, the calling code needs to make sure to handle potential NullPointerExceptions.

The JsonObject is backed by a Map and is intended to work similar to it API wise, but to only allow to store such objects which can be represented by JSON.

Since:

2.0

Field Summary

Fields inherited from class com.couchbase.client.java.document.json.JsonValue

NULL

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsKey(java.lang.String name) Checks if the JsonObject contains the field name.
boolean	containsValue(java.lang.Object value) Checks if the JsonObject contains the value.
static JsonObject	create() Creates a empty JsonObject.
static JsonObject	empty() Creates a empty JsonObject.
boolean	equals(java.lang.Object o)
java.lang.Object	get(java.lang.String name) Retrieves the (potential null) content and not casting its type.
JsonArray	getArray(java.lang.String name) Retrieves the value from the field name and casts it to JsonArray.
java.lang.Boolean	getBoolean(java.lang.String name) Retrieves the value from the field name and casts it to Boolean.
java.lang.Double	getDouble(java.lang.String name) Retrieves the value from the field name and casts it to Double.
java.lang.Integer	getInt(java.lang.String name) Retrieves the value from the field name and casts it to Integer.
java.lang.Long	getLong(java.lang.String name) Retrieves the value from the field name and casts it to Long.
java.util.Set<java.lang.String>	getNames() Returns a set of field names on the JsonObject.
JsonObject	getObject(java.lang.String name) Retrieves the value from the field name and casts it to JsonObject.
java.lang.String	getString(java.lang.String name) Retrieves the value from the field name and casts it to String.
int	hashCode()
boolean	isEmpty() Returns true if the JsonObject is empty, false otherwise.
JsonObject	put(java.lang.String name, boolean value) Stores a Boolean value identified by the field name.
JsonObject	put(java.lang.String name, double value) Stores a Double value identified by the field name.
JsonObject	put(java.lang.String name, int value) Stores a Integer value identified by the field name.
JsonObject	put(java.lang.String name, JsonArray value) Stores a JsonArray value identified by the field name.
JsonObject	put(java.lang.String name, JsonObject value) Stores a JsonObject value identified by the field name.
JsonObject	put(java.lang.String name, long value) Stores a Long value identified by the field name.
JsonObject	put(java.lang.String name, java.lang.Object value) Stores a Object value identified by the field name.
JsonObject	put(java.lang.String name, java.lang.String value) Stores a String value identified by the field name.
int	size() The size of the JsonObject.
java.util.Map<java.lang.String,java.lang.Object>	toMap() Creates a copy of the underlying Map and returns it.
java.lang.String	toString() Converts the JsonObject into its JSON string representation.

Methods inherited from class com.couchbase.client.java.document.json.JsonValue

checkType, ja, jo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

empty

public static JsonObject empty()

Creates a empty JsonObject.

Returns:

a empty JsonObject.

create

public static JsonObject create()

Creates a empty JsonObject.

Returns:

a empty JsonObject.

put

public JsonObject put(java.lang.String name,
             java.lang.Object value)

Stores a Object value identified by the field name.

Note that the value is checked and a IllegalArgumentException is thrown if not supported.

Parameters:

name - the name of the JSON field.

value - the value of the JSON field.

Returns:

the JsonObject.

get

public java.lang.Object get(java.lang.String name)

Retrieves the (potential null) content and not casting its type.

Parameters:

name - the key of the field.

Returns:

the value of the field, or null if it does not exist.

put

public JsonObject put(java.lang.String name,
             java.lang.String value)

Stores a String value identified by the field name.

Parameters:

name - the name of the JSON field.

value - the value of the JSON field.

Returns:

the JsonObject.

getString

public java.lang.String getString(java.lang.String name)

Retrieves the value from the field name and casts it to String.

Parameters:

name - the name of the field.

Returns:

the result or null if it does not exist.

put

public JsonObject put(java.lang.String name,
             int value)

Stores a Integer value identified by the field name.

Parameters:

name - the name of the JSON field.

value - the value of the JSON field.

Returns:

the JsonObject.

getInt

public java.lang.Integer getInt(java.lang.String name)

Retrieves the value from the field name and casts it to Integer.

Parameters:

name - the name of the field.

Returns:

the result or null if it does not exist.

put

public JsonObject put(java.lang.String name,
             long value)

Stores a Long value identified by the field name.

Parameters:

name - the name of the JSON field.

value - the value of the JSON field.

Returns:

the JsonObject.

getLong

public java.lang.Long getLong(java.lang.String name)

Retrieves the value from the field name and casts it to Long.

Parameters:

name - the name of the field.

Returns:

the result or null if it does not exist.

put

public JsonObject put(java.lang.String name,
             double value)

Stores a Double value identified by the field name.

Parameters:

name - the name of the JSON field.

value - the value of the JSON field.

Returns:

the JsonObject.

getDouble

public java.lang.Double getDouble(java.lang.String name)

Retrieves the value from the field name and casts it to Double.

Parameters:

name - the name of the field.

Returns:

the result or null if it does not exist.

put

public JsonObject put(java.lang.String name,
             boolean value)

Stores a Boolean value identified by the field name.

Parameters:

name - the name of the JSON field.

value - the value of the JSON field.

Returns:

the JsonObject.

getBoolean

public java.lang.Boolean getBoolean(java.lang.String name)

Retrieves the value from the field name and casts it to Boolean.

Parameters:

name - the name of the field.

Returns:

the result or null if it does not exist.

put

public JsonObject put(java.lang.String name,
             JsonObject value)

Stores a JsonObject value identified by the field name.

Parameters:

name - the name of the JSON field.

value - the value of the JSON field.

Returns:

the JsonObject.

getObject

public JsonObject getObject(java.lang.String name)

Retrieves the value from the field name and casts it to JsonObject.

Parameters:

name - the name of the field.

Returns:

the result or null if it does not exist.

put

public JsonObject put(java.lang.String name,
             JsonArray value)

Stores a JsonArray value identified by the field name.

Parameters:

name - the name of the JSON field.

value - the value of the JSON field.

Returns:

the JsonObject.

getArray

public JsonArray getArray(java.lang.String name)

Retrieves the value from the field name and casts it to JsonArray.

Parameters:

name - the name of the field.

Returns:

the result or null if it does not exist.

getNames

public java.util.Set<java.lang.String> getNames()

Returns a set of field names on the JsonObject.

Returns:

the set of names on the object.

isEmpty

public boolean isEmpty()

Returns true if the JsonObject is empty, false otherwise.

Returns:

true if empty, false otherwise.

toMap

public java.util.Map<java.lang.String,java.lang.Object> toMap()

Creates a copy of the underlying Map and returns it.

Returns:

the Map of the content.

containsKey

public boolean containsKey(java.lang.String name)

Checks if the JsonObject contains the field name.

Parameters:

name - the name of the field.

Returns:

true if its contained, false otherwise.

containsValue

public boolean containsValue(java.lang.Object value)

Checks if the JsonObject contains the value.

Parameters:

value - the actual value.

Returns:

true if its contained, false otherwise.

size

public int size()

The size of the JsonObject.

Returns:

the size.

toString

public java.lang.String toString()

Converts the JsonObject into its JSON string representation.

Overrides:

toString in class java.lang.Object

Returns:

the JSON string representing this JsonObject.

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