Package edu.byu.hbll.box.internal.core

Class DocumentIterable

java.lang.Object

edu.byu.hbll.box.internal.core.DocumentIterable

All Implemented Interfaces:

Iterable<BoxDocument>

public class DocumentIterable
extends Object
implements Iterable<BoxDocument>

An iterable for retrieving Box documents. Under the hood it requests documents in small batches as needed until the query is fulfilled.

Author:

Charles Draper

Constructor Summary

Constructors

Constructor	Description
DocumentIterable(BoxQuery query, int batchSize, Function<BoxQuery,QueryResult> retriever)	Creates a new DocumentIterable.
DocumentIterable(BoxQuery query, Function<BoxQuery,QueryResult> retriever)	Creates a new DocumentIterable with default batch size.

Method Summary

Modifier and Type	Method	Description
Iterator<BoxDocument>	iterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

DocumentIterable

public DocumentIterable(BoxQuery query,
 Function<BoxQuery,QueryResult> retriever)

Creates a new DocumentIterable with default batch size.

Parameters:

query - the query to perform

retriever - the function that returns all documents according to the query

DocumentIterable

public DocumentIterable(BoxQuery query,
 int batchSize,
 Function<BoxQuery,QueryResult> retriever)

Creates a new DocumentIterable.

Parameters:

query - the query to perform

batchSize - the internal batch size

retriever - the function that returns all documents according to the query

Method Details

iterator

public Iterator<BoxDocument> iterator()

Specified by:

iterator in interface Iterable<BoxDocument>