com.box.androidsdk.content.models

Class BoxIterator<E extends BoxJsonObject>

java.lang.Object

com.box.androidsdk.content.models.BoxObject

com.box.androidsdk.content.models.BoxJsonObject

com.box.androidsdk.content.models.BoxIterator<E>

Type Parameters:

E - the type of elements in this partial collection.

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<E>

Direct Known Subclasses:

BoxIteratorBoxEntity, BoxIteratorRepresentations

public abstract class BoxIterator<E extends BoxJsonObject>
extends BoxJsonObject
implements java.lang.Iterable<E>

A collection that contains a subset of items that are a part of a larger collection. The items within a partial collection begin at an offset within the full collection and end at a specified limit. Note that the actual size of a partial collection may be less than its limit since the limit only specifies the maximum size. For example, if there's a full collection with a size of 3, then a partial collection with offset 0 and limit 3 would be equal to a partial collection with offset 0 and limit 100.

See Also:

Serialized Form

Nested Class Summary

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_ENTRIES
static java.lang.String	FIELD_LIMIT
static java.lang.String	FIELD_OFFSET
static java.lang.String	FIELD_ORDER
static java.lang.String	FIELD_TOTAL_COUNT

Constructor Summary

Constructors

Constructor and Description
BoxIterator()
BoxIterator(com.eclipsesource.json.JsonObject jsonObject)

Method Summary

Modifier and Type	Method and Description
void	createFromJson(com.eclipsesource.json.JsonObject object) Creates the BoxJsonObject from a JsonObject
java.lang.Long	fullSize() Gets the size of the full collection that this partial collection is based off of.
E	get(int index)
E	getAs(BoxJsonObject.BoxJsonObjectCreator<E> creator, int index)
java.util.ArrayList<E>	getEntries()
protected abstract BoxJsonObject.BoxJsonObjectCreator<E>	getObjectCreator()
java.util.ArrayList<BoxOrder>	getSortOrders()
java.util.Iterator<E>	iterator()
java.lang.Long	limit() Gets the maximum number of items within the full collection that begin at offset().
java.lang.Long	offset() Gets the offset within the full collection where this collection's items begin.
int	size()

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

addInJsonArray, addInJsonArray, 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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

FIELD_ORDER

public static final java.lang.String FIELD_ORDER

See Also:

Constant Field Values

FIELD_TOTAL_COUNT

public static final java.lang.String FIELD_TOTAL_COUNT

See Also:

Constant Field Values

FIELD_ENTRIES

public static final java.lang.String FIELD_ENTRIES

See Also:

Constant Field Values

FIELD_OFFSET

public static final java.lang.String FIELD_OFFSET

See Also:

Constant Field Values

FIELD_LIMIT

public static final java.lang.String FIELD_LIMIT

See Also:

Constant Field Values

Constructor Detail

BoxIterator

public BoxIterator()

BoxIterator

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

Method Detail

createFromJson

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

Description copied from class: BoxJsonObject

Creates the BoxJsonObject from a JsonObject

Overrides:

createFromJson in class BoxJsonObject

Parameters:

object - json object to parse.

offset

public java.lang.Long offset()

Gets the offset within the full collection where this collection's items begin.

Returns:

the offset within the full collection where this collection's items begin.

limit

public java.lang.Long limit()

Gets the maximum number of items within the full collection that begin at offset().

Returns:

the maximum number of items within the full collection that begin at the offset.

fullSize

public java.lang.Long fullSize()

Gets the size of the full collection that this partial collection is based off of.

Returns:

the size of the full collection that this partial collection is based off of.

size

public int size()

getEntries

public java.util.ArrayList<E> getEntries()

get

public E get(int index)

getObjectCreator

protected abstract BoxJsonObject.BoxJsonObjectCreator<E> getObjectCreator()

getAs

public E getAs(BoxJsonObject.BoxJsonObjectCreator<E> creator,
               int index)

getSortOrders

public java.util.ArrayList<BoxOrder> getSortOrders()

iterator

public java.util.Iterator<E> iterator()

Specified by:

iterator in interface java.lang.Iterable<E extends BoxJsonObject>