com.box.androidsdk.content.models

Class BoxCollection

java.lang.Object

com.box.androidsdk.content.models.BoxObject

com.box.androidsdk.content.models.BoxJsonObject

com.box.androidsdk.content.models.BoxEntity

com.box.androidsdk.content.models.BoxCollection

All Implemented Interfaces:

java.io.Serializable

public class BoxCollection
extends BoxEntity

Class that represents a collection on Box.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIELD_COLLECTION_TYPE
static java.lang.String	FIELD_NAME
static java.lang.String	TYPE

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

FIELD_ID, FIELD_ITEM_ID, FIELD_ITEM_TYPE, FIELD_TYPE

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

mProperties

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCollectionType() Gets the type of the collection.
java.lang.String	getName() Gets the name of the collection.
protected void	parseJSONMember(com.eclipsesource.json.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.BoxEntity

createEntityFromJson, createEntityFromJson, getId, getType

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

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

FIELD_NAME

public static final java.lang.String FIELD_NAME

See Also:

Constant Field Values

FIELD_COLLECTION_TYPE

public static final java.lang.String FIELD_COLLECTION_TYPE

See Also:

Constant Field Values

Constructor Detail

BoxCollection

public BoxCollection()

Constructs an empty BoxCollection object.

BoxCollection

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

Constructs a BoxCollection with the provided map values

Parameters:

map - - map of keys and values of the object

Method Detail

getName

public java.lang.String getName()

Gets the name of the collection.

Returns:

the name of the collection.

getCollectionType

public java.lang.String getCollectionType()

Gets the type of the collection. Currently only "favorites" is supported.

Returns:

type of collection.

parseJSONMember

protected void parseJSONMember(com.eclipsesource.json.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 BoxEntity

Parameters:

member - the JSON member to be parsed.