com.box.androidsdk.content.models

Class BoxIteratorEvents

java.lang.Object

com.box.androidsdk.content.models.BoxObject

com.box.androidsdk.content.models.BoxJsonObject

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

com.box.androidsdk.content.models.BoxIteratorBoxEntity<BoxEvent>

com.box.androidsdk.content.models.BoxIteratorEvents

All Implemented Interfaces:

IStreamPosition, java.io.Serializable, java.lang.Iterable<BoxEvent>

public class BoxIteratorEvents
extends BoxIteratorBoxEntity<BoxEvent>
implements IStreamPosition

Class representing a list of events fired off by the Box events API.

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_CHUNK_SIZE
static java.lang.String	FIELD_NEXT_STREAM_POSITION

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

FIELD_ENTRIES, FIELD_LIMIT, FIELD_OFFSET, FIELD_ORDER, FIELD_TOTAL_COUNT

Constructor Summary

Constructors

Constructor and Description
BoxIteratorEvents()

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getChunkSize() Gets the number of event records returned in this chunk.
java.lang.Long	getNextStreamPosition() Gets the next position in the event stream that you should request in order to get the next events.
java.util.ArrayList<BoxEvent>	getWithoutDuplicates()

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

getObjectCreator

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

createFromJson, fullSize, get, getAs, getEntries, getSortOrders, iterator, limit, offset, 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_CHUNK_SIZE

public static final java.lang.String FIELD_CHUNK_SIZE

See Also:

Constant Field Values

FIELD_NEXT_STREAM_POSITION

public static final java.lang.String FIELD_NEXT_STREAM_POSITION

See Also:

Constant Field Values

Constructor Detail

BoxIteratorEvents

public BoxIteratorEvents()

Method Detail

getChunkSize

public java.lang.Long getChunkSize()

Gets the number of event records returned in this chunk.

Returns:

number of event records returned.

getNextStreamPosition

public java.lang.Long getNextStreamPosition()

Gets the next position in the event stream that you should request in order to get the next events.

Specified by:

getNextStreamPosition in interface IStreamPosition

Returns:

next position in the event stream to request in order to get the next events.

getWithoutDuplicates

public java.util.ArrayList<BoxEvent> getWithoutDuplicates()