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 newDocumentIterable
.DocumentIterable(BoxQuery query, Function<BoxQuery,QueryResult> retriever)
Creates a newDocumentIterable
with default batch size.
-
Method Summary
All Methods Instance Methods Concrete Methods 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 Detail
-
DocumentIterable
public DocumentIterable(BoxQuery query, Function<BoxQuery,QueryResult> retriever)
Creates a newDocumentIterable
with default batch size.- Parameters:
query
- the query to performretriever
- the function that returns all documents according to the query
-
DocumentIterable
public DocumentIterable(BoxQuery query, int batchSize, Function<BoxQuery,QueryResult> retriever)
Creates a newDocumentIterable
.- Parameters:
query
- the query to performbatchSize
- the internal batch sizeretriever
- the function that returns all documents according to the query
-
-
Method Detail
-
iterator
public Iterator<BoxDocument> iterator()
- Specified by:
iterator
in interfaceIterable<BoxDocument>
-
-