jsimple.json.objectmodel

Class JsonObject

java.lang.Object

jsimple.json.objectmodel.JsonObjectOrArray

jsimple.json.objectmodel.JsonObject

public final class JsonObject
extends JsonObjectOrArray

A JsonObject represents an ordered list of name/value pairs. Note that unlike a HashMap, the list is ordered, so that the order in the serialized text can be controlled. For now, queries just do a linear search, but we might create a HashMap later, say if there are > 5 items in the object, for performance. There's currently no prohibition against a name being duplicated in the object; if that happens the value of the first occurrence is returned currently but future implementations may change that.

Since:

5/6/12 12:29 AM

Constructor Summary

Constructors

Constructor and Description
JsonObject()

Method Summary

Modifier and Type	Method and Description
JsonObject	add(java.lang.String name, java.lang.Object value)
JsonArray	addChildArray(java.lang.String name)
JsonObject	addChildObject(java.lang.String name)
boolean	containsKey(java.lang.String keyName) Return true if the object contains the specified key, false otherwise.
java.lang.Object	get(java.lang.String name) Return the value of the specified key.
boolean	getBoolean(java.lang.String name)
boolean	getBooleanOrDefault(java.lang.String name, boolean defaultValue)
double	getDouble(java.lang.String name)
double	getDoubleOrDefault(java.lang.String name, double defaultValue)
java.lang.Double	getDoubleOrNull(java.lang.String name)
int	getInt(java.lang.String name)
int	getIntOrDefault(java.lang.String name, int defaultValue)
JsonArray	getJsonArray(java.lang.String name)
JsonArray	getJsonArrayOrNull(java.lang.String name)
JsonObject	getJsonObject(java.lang.String name)
JsonObject	getJsonObjectOrNull(java.lang.String name)
long	getLong(java.lang.String name)
long	getLongOrDefault(java.lang.String name, long defaultValue)
java.lang.String	getName(int index) Get name at the specified index.
java.lang.Object	getOrNull(java.lang.String name) Return the value of the specified key.
java.lang.String	getString(java.lang.String name)
java.lang.String	getStringOrDefault(java.lang.String name, java.lang.String defaultValue)
java.lang.String	getStringOrNull(java.lang.String name)
java.lang.Object	getValue(int index) Get value at the specified index.
int	size() Get number of name/value pairs in the object.

Methods inherited from class jsimple.json.objectmodel.JsonObjectOrArray

toString, toUtf8Bytes, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JsonObject

public JsonObject()

Method Detail

size

public int size()

Get number of name/value pairs in the object.

Returns:

number of name/value pairs

getName

public java.lang.String getName(int index)

Get name at the specified index.

Parameters:

index - index in question; must be < size()

Returns:

name at that index

getValue

public java.lang.Object getValue(int index)

Get value at the specified index.

Parameters:

index - index in question; must be < size()

Returns:

value at that index

get

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

Return the value of the specified key. If the key isn't present, an exception is thrown. If the key is present and explicitly has the value null, then the JsonNull singleton is returned. Technically, nothing prevents a key being duplicated in a JSON file; if that happens, the value of the first occurrence is returned here.

Parameters:

name - key name

Returns:

value of key

getOrNull

@Nullable
public java.lang.Object getOrNull(java.lang.String name)

Return the value of the specified key. If the key isn't present, null is returned. If the key is present and explicitly has the value null, then the JsonNull singleton is returned. Technically, nothing prevents a key being duplicated in a JSON file; if that happens, the value of the first occurrence is returned here.

Parameters:

name - key name

Returns:

value of key

getBoolean

public boolean getBoolean(java.lang.String name)

getBooleanOrDefault

public boolean getBooleanOrDefault(java.lang.String name,
                                   boolean defaultValue)

getString

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

getStringOrNull

@Nullable
public java.lang.String getStringOrNull(java.lang.String name)

getStringOrDefault

public java.lang.String getStringOrDefault(java.lang.String name,
                                           java.lang.String defaultValue)

getInt

public int getInt(java.lang.String name)

getIntOrDefault

public int getIntOrDefault(java.lang.String name,
                           int defaultValue)

getLong

public long getLong(java.lang.String name)

getLongOrDefault

public long getLongOrDefault(java.lang.String name,
                             long defaultValue)

getDouble

public double getDouble(java.lang.String name)

getDoubleOrNull

@Nullable
public java.lang.Double getDoubleOrNull(java.lang.String name)

getDoubleOrDefault

public double getDoubleOrDefault(java.lang.String name,
                                 double defaultValue)

getJsonObject

public JsonObject getJsonObject(java.lang.String name)

getJsonObjectOrNull

@Nullable
public JsonObject getJsonObjectOrNull(java.lang.String name)

getJsonArray

public JsonArray getJsonArray(java.lang.String name)

getJsonArrayOrNull

@Nullable
public JsonArray getJsonArrayOrNull(java.lang.String name)

containsKey

public boolean containsKey(java.lang.String keyName)

Return true if the object contains the specified key, false otherwise. Like a Java HashMap, calling containsKey is the only way to distinguish between a key not being present and it being present but explicitly set to null in the JSON as the getOrNull method returns null in both cases here.

Parameters:

keyName - key keyName

Returns:

true iff the object contains the key (even if its value is null)

add

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

addChildObject

public JsonObject addChildObject(java.lang.String name)

addChildArray

public JsonArray addChildArray(java.lang.String name)