com.box.androidsdk.content.models

Class BoxJsonObject

java.lang.Object

com.box.androidsdk.content.models.BoxObject

com.box.androidsdk.content.models.BoxJsonObject

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BoxAuthentication.BoxAuthenticationInfo, BoxDownload, BoxEmbedLink, BoxEntity, BoxError, BoxError.ErrorContext, BoxIterator, BoxMap, BoxMDMData, BoxMetadata, BoxOrder, BoxPermission, BoxRepresentation, BoxRepresentation.Link, BoxSharedLink, BoxSharedLink.Permissions, BoxSimpleMessage, BoxUploadEmail

public abstract class BoxJsonObject
extends BoxObject

The abstract base class for all types that contain JSON data returned by the Box API.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BoxJsonObject.BoxJsonObjectCreator<E extends BoxJsonObject>

Constructor Summary

Constructors

Constructor and Description
BoxJsonObject() Constructs an empty BoxJSONObject.
BoxJsonObject(com.eclipsesource.json.JsonObject jsonObject) Constructs a BoxJsonObject based on given JsonObject

Method Summary

Modifier and Type	Method and Description
protected void	addInJsonArray(java.lang.String field, BoxJsonObject value)
protected void	addInJsonArray(java.lang.String field, com.eclipsesource.json.JsonObject value)
void	createFromJson(com.eclipsesource.json.JsonObject object) Creates the BoxJsonObject from a JsonObject
void	createFromJson(java.lang.String json) Serializes a json blob into a BoxJsonObject.
boolean	equals(java.lang.Object o)
static <T extends BoxJsonObject> BoxJsonObject.BoxJsonObjectCreator<T>	getBoxJsonObjectCreator(java.lang.Class<T> jsonObjectClass)
java.util.List<java.lang.String>	getPropertiesKeySet() Gets the Key set of the properties map
protected java.lang.Boolean	getPropertyAsBoolean(java.lang.String field)
protected java.util.Date	getPropertyAsDate(java.lang.String field)
protected java.lang.Double	getPropertyAsDouble(java.lang.String field)
protected java.lang.Float	getPropertyAsFloat(java.lang.String field)
protected java.lang.Integer	getPropertyAsInt(java.lang.String field)
protected com.eclipsesource.json.JsonArray	getPropertyAsJsonArray(java.lang.String field)
protected <T extends BoxJsonObject> T	getPropertyAsJsonObject(BoxJsonObject.BoxJsonObjectCreator<T> creator, java.lang.String field)
protected <T extends BoxJsonObject> java.util.ArrayList<T>	getPropertyAsJsonObjectArray(BoxJsonObject.BoxJsonObjectCreator<T> creator, java.lang.String field)
protected java.lang.Long	getPropertyAsLong(java.lang.String field)
protected java.lang.String	getPropertyAsString(java.lang.String field)
protected java.util.ArrayList<java.lang.String>	getPropertyAsStringArray(java.lang.String field)
protected java.util.HashSet<java.lang.String>	getPropertyAsStringHashSet(java.lang.String field)
com.eclipsesource.json.JsonValue	getPropertyValue(java.lang.String name) Gets the value associated with the key in the property map
int	hashCode()
protected void	parseJSONMember(com.eclipsesource.json.JsonObject.Member member) Deprecated.
protected boolean	remove(java.lang.String field)
protected void	set(java.lang.String field, java.lang.Boolean value)
protected void	set(java.lang.String field, BoxJsonObject value)
protected void	set(java.lang.String field, java.lang.Double value)
protected void	set(java.lang.String field, java.lang.Float value)
protected void	set(java.lang.String field, java.lang.Integer value)
protected void	set(java.lang.String field, com.eclipsesource.json.JsonArray value)
protected void	set(java.lang.String field, com.eclipsesource.json.JsonObject value)
protected void	set(java.lang.String field, java.lang.Long value)
protected void	set(java.lang.String field, java.lang.String value)
java.lang.String	toJson() Returns a JSON string representing the object.
com.eclipsesource.json.JsonObject	toJsonObject()

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxJsonObject

public BoxJsonObject()

Constructs an empty BoxJSONObject.

BoxJsonObject

public BoxJsonObject(com.eclipsesource.json.JsonObject jsonObject)

Constructs a BoxJsonObject based on given JsonObject

Parameters:

jsonObject - A JsonObject that represents that can be represented by this class.

Method Detail

createFromJson

public void createFromJson(java.lang.String json)

Serializes a json blob into a BoxJsonObject.

Parameters:

json - json blob to deserialize.

createFromJson

public void createFromJson(com.eclipsesource.json.JsonObject object)

Creates the BoxJsonObject from a JsonObject

Parameters:

object - json object to parse.

parseJSONMember

@Deprecated
protected void parseJSONMember(com.eclipsesource.json.JsonObject.Member member)

Deprecated.

Invoked with a JSON member whenever this object is updated or created from a JSON object.

Subclasses should override this method in order to parse any JSON members it knows about. This method is a no-op by default.

Parameters:

member - the JSON member to be parsed.

toJsonObject

public com.eclipsesource.json.JsonObject toJsonObject()

Returns:

a copy of the json object backing this object.

toJson

public java.lang.String toJson()

Returns a JSON string representing the object.

Returns:

JSON string representation of the object.

getPropertyValue

public com.eclipsesource.json.JsonValue getPropertyValue(java.lang.String name)

Gets the value associated with the key in the property map

Parameters:

name - name of the property

Returns:

Value of the key

getPropertiesKeySet

public java.util.List<java.lang.String> getPropertiesKeySet()

Gets the Key set of the properties map

Returns:

Key set of the properties map

getPropertyAsString

protected java.lang.String getPropertyAsString(java.lang.String field)

set

protected void set(java.lang.String field,
                   java.lang.String value)

getPropertyAsBoolean

protected java.lang.Boolean getPropertyAsBoolean(java.lang.String field)

set

protected void set(java.lang.String field,
                   java.lang.Boolean value)

getPropertyAsDate

protected java.util.Date getPropertyAsDate(java.lang.String field)

getPropertyAsDouble

protected java.lang.Double getPropertyAsDouble(java.lang.String field)

set

protected void set(java.lang.String field,
                   java.lang.Double value)

getPropertyAsFloat

protected java.lang.Float getPropertyAsFloat(java.lang.String field)

set

protected void set(java.lang.String field,
                   java.lang.Float value)

getPropertyAsInt

protected java.lang.Integer getPropertyAsInt(java.lang.String field)

set

protected void set(java.lang.String field,
                   java.lang.Integer value)

getPropertyAsLong

protected java.lang.Long getPropertyAsLong(java.lang.String field)

set

protected void set(java.lang.String field,
                   java.lang.Long value)

getPropertyAsJsonArray

protected com.eclipsesource.json.JsonArray getPropertyAsJsonArray(java.lang.String field)

set

protected void set(java.lang.String field,
                   com.eclipsesource.json.JsonArray value)

addInJsonArray

protected void addInJsonArray(java.lang.String field,
                              com.eclipsesource.json.JsonObject value)

addInJsonArray

protected void addInJsonArray(java.lang.String field,
                              BoxJsonObject value)

getPropertyAsStringHashSet

protected java.util.HashSet<java.lang.String> getPropertyAsStringHashSet(java.lang.String field)

getPropertyAsStringArray

protected java.util.ArrayList<java.lang.String> getPropertyAsStringArray(java.lang.String field)

getPropertyAsJsonObjectArray

protected <T extends BoxJsonObject> java.util.ArrayList<T> getPropertyAsJsonObjectArray(BoxJsonObject.BoxJsonObjectCreator<T> creator,
                                                                                        java.lang.String field)

getPropertyAsJsonObject

protected <T extends BoxJsonObject> T getPropertyAsJsonObject(BoxJsonObject.BoxJsonObjectCreator<T> creator,
                                                              java.lang.String field)

remove

protected boolean remove(java.lang.String field)

set

protected void set(java.lang.String field,
                   com.eclipsesource.json.JsonObject value)

set

protected void set(java.lang.String field,
                   BoxJsonObject value)

getBoxJsonObjectCreator

public static <T extends BoxJsonObject> BoxJsonObject.BoxJsonObjectCreator<T> getBoxJsonObjectCreator(java.lang.Class<T> jsonObjectClass)

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