com.box.androidsdk.content.models

Class BoxEntity

java.lang.Object

com.box.androidsdk.content.models.BoxObject

com.box.androidsdk.content.models.BoxJsonObject

com.box.androidsdk.content.models.BoxEntity

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BoxCollaboration, BoxCollaborator, BoxCollection, BoxComment, BoxEnterprise, BoxEvent, BoxFileVersion, BoxItem, BoxRealTimeServer

public class BoxEntity
extends BoxJsonObject

Class that represents an entity with a type and ID on Box.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BoxEntity.BoxEntityCreator This interface should be used if new types should be added dynamically.

Nested classes/interfaces inherited from class com.box.androidsdk.content.models.BoxJsonObject

BoxJsonObject.BoxJsonObjectCreator<E extends BoxJsonObject>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIELD_ID
static java.lang.String	FIELD_ITEM_ID
static java.lang.String	FIELD_ITEM_TYPE
static java.lang.String	FIELD_TYPE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static void	addEntityType(java.lang.String type, BoxEntity.BoxEntityCreator creator) Add or replace a type to be recognized by classes using the static helper method createEntityFromJson.
static BoxEntity	createEntityFromJson(com.eclipsesource.json.JsonObject json) Helper method that will parse into a known child of BoxEntity.
static BoxEntity	createEntityFromJson(java.lang.String json) Helper method that will parse into a known child of BoxEntity.
static BoxJsonObject.BoxJsonObjectCreator<BoxEntity>	getBoxJsonObjectCreator()
java.lang.String	getId() Gets the id.
java.lang.String	getType() Gets the type of the entity.

Methods inherited from class com.box.androidsdk.content.models.BoxJsonObject

addInJsonArray, addInJsonArray, createFromJson, createFromJson, equals, getBoxJsonObjectCreator, getPropertiesKeySet, getPropertyAsBoolean, getPropertyAsDate, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsJsonArray, getPropertyAsJsonObject, getPropertyAsJsonObjectArray, getPropertyAsLong, getPropertyAsString, getPropertyAsStringArray, getPropertyAsStringHashSet, getPropertyValue, hashCode, parseJSONMember, remove, set, set, set, set, set, set, set, set, set, toJson, toJsonObject

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_ID

public static final java.lang.String FIELD_ID

See Also:

Constant Field Values

FIELD_TYPE

public static final java.lang.String FIELD_TYPE

See Also:

Constant Field Values

FIELD_ITEM_TYPE

public static final java.lang.String FIELD_ITEM_TYPE

See Also:

Constant Field Values

FIELD_ITEM_ID

public static final java.lang.String FIELD_ITEM_ID

See Also:

Constant Field Values

Constructor Detail

BoxEntity

public BoxEntity()

Constructs an empty BoxEntity object.

BoxEntity

public BoxEntity(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

getId

public java.lang.String getId()

Gets the id.

Returns:

the id of the entity.

getType

public java.lang.String getType()

Gets the type of the entity.

Returns:

the entity type.

createEntityFromJson

public static BoxEntity createEntityFromJson(java.lang.String json)

Helper method that will parse into a known child of BoxEntity.

Parameters:

json - json representing a BoxEntity or one of its known children.

Returns:

a BoxEntity or one of its known children.

createEntityFromJson

public static BoxEntity createEntityFromJson(com.eclipsesource.json.JsonObject json)

Helper method that will parse into a known child of BoxEntity.

Parameters:

json - JsonObject representing a BoxEntity or one of its known children.

Returns:

a BoxEntity or one of its known children.

addEntityType

public static void addEntityType(java.lang.String type,
                                 BoxEntity.BoxEntityCreator creator)

Add or replace a type to be recognized by classes using the static helper method createEntityFromJson.

Parameters:

type - the string type of the item.

creator - A BoxEntityCreator that can create a child of BoxEntity.

getBoxJsonObjectCreator

public static BoxJsonObject.BoxJsonObjectCreator<BoxEntity> getBoxJsonObjectCreator()