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, BoxFileVersion, BoxItem

public class BoxEntity
extends BoxJsonObject

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

See Also:

Serialized Form

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

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

mProperties

Constructor Summary

Constructors

Constructor and Description
BoxEntity() Constructs an empty BoxEntity object.
BoxEntity(java.util.Map<java.lang.String,java.lang.Object> map) Constructs a BoxEntity with the provided map values.

Method Summary

Methods

Modifier and Type	Method and Description
static BoxEntity	createEntityFromJson(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.
java.lang.String	getId() Gets the id.
java.lang.String	getType() Gets the type of the entity.
protected void	parseJSONMember(JsonObject.Member member) Invoked with a JSON member whenever this object is updated or created from a JSON object.

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

createFromJson, createFromJson, getPropertiesAsHashMap, parseJsonObject, parseNullJsonMember, toJson, toJsonObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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(java.util.Map<java.lang.String,java.lang.Object> map)

Constructs a BoxEntity with the provided map values.

Parameters:

map - map of keys and values of the object.

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.

parseJSONMember

protected void parseJSONMember(JsonObject.Member member)

Description copied from class: BoxJsonObject

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.

Overrides:

parseJSONMember in class BoxJsonObject

Parameters:

member - the JSON member to be parsed.

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(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.