com.box.sdk

Class BoxResourceIterable<T>

Object

BoxResourceIterable<T>

Type Parameters:

T - type of iterated entity

All Implemented Interfaces:

Iterable<T>

public abstract class BoxResourceIterable<T>
extends Object
implements Iterable<T>

Common implementation for paging support.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BODY_PARAMETER_ENTRIES Body parameter for page entries.
static String	BODY_PARAMETER_MARKER_NEXT Body Parameter for marker for the beginning of next page.
static String	PARAMETER_LIMIT Parameter for max page size.
static String	PARAMETER_MARKER Parameter for marker for the beginning of next page.

Constructor Summary

Constructors

Constructor and Description
BoxResourceIterable(BoxAPIConnection api, URL url, int limit) Constructor.
BoxResourceIterable(BoxAPIConnection api, URL url, int limit, JsonObject body) Constructor.
BoxResourceIterable(BoxAPIConnection api, URL url, int limit, JsonObject body, String marker) Constructor.
BoxResourceIterable(BoxAPIConnection api, URL url, int limit, String marker) Constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract T	factory(JsonObject jsonObject) Factory to build a new instance for a received JSON item.
String	getNextMarker() Builds internal read-only iterator over BoxResource-s.
Iterator<T>	iterator() Builds internal read-only iterator over BoxResource-s.

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Field Detail

PARAMETER_LIMIT

public static final String PARAMETER_LIMIT

Parameter for max page size.

See Also:

Constant Field Values

PARAMETER_MARKER

public static final String PARAMETER_MARKER

Parameter for marker for the beginning of next page.

See Also:

Constant Field Values

BODY_PARAMETER_MARKER_NEXT

public static final String BODY_PARAMETER_MARKER_NEXT

Body Parameter for marker for the beginning of next page.

See Also:

Constant Field Values

BODY_PARAMETER_ENTRIES

public static final String BODY_PARAMETER_ENTRIES

Body parameter for page entries.

See Also:

Constant Field Values

Constructor Detail

BoxResourceIterable

public BoxResourceIterable(BoxAPIConnection api,
                           URL url,
                           int limit)

Constructor.

Parameters:

api - the API connection to be used by the resource

url - endpoint with paging support

limit - the maximum number of items to return in a page

BoxResourceIterable

public BoxResourceIterable(BoxAPIConnection api,
                           URL url,
                           int limit,
                           JsonObject body)

Constructor.

Parameters:

api - the API connection to be used by the resource.

url - to endpoint with paging support.

limit - the maximum number of items to return in a page.

body - the body to send to the requested endpoint.

BoxResourceIterable

public BoxResourceIterable(BoxAPIConnection api,
                           URL url,
                           int limit,
                           String marker)

Constructor.

Parameters:

api - the API connection to be used by the resource.

url - to endpoint with paging support.

limit - the maximum number of items to return in a page.

marker - the marker where the iterator will begin

BoxResourceIterable

public BoxResourceIterable(BoxAPIConnection api,
                           URL url,
                           int limit,
                           JsonObject body,
                           String marker)

Constructor.

Parameters:

api - the API connection to be used by the resource.

url - to endpoint with paging support.

limit - the maximum number of items to return in a page.

body - the body to send to the requested endpoint.

marker - the marker where the iterator will begin

Method Detail

factory

protected abstract T factory(JsonObject jsonObject)

Factory to build a new instance for a received JSON item.

Parameters:

jsonObject - of the item

Returns:

the item instance

iterator

public Iterator<T> iterator()

Builds internal read-only iterator over BoxResource-s.

Specified by:

iterator in interface Iterable<T>

Returns:

iterator implementation

See Also:

Iterable.iterator()

getNextMarker

public String getNextMarker()

Builds internal read-only iterator over BoxResource-s.

Returns:

iterator implementation

See Also:

Iterable.iterator()