Package edu.byu.hbll.box

Class QueryResult

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<BoxDocument>

edu.byu.hbll.box.QueryResult

All Implemented Interfaces:

Serializable, Cloneable, Iterable<BoxDocument>, Collection<BoxDocument>, List<BoxDocument>, RandomAccess

public class QueryResult
extends ArrayList<BoxDocument>

A response from a querying box.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
QueryResult()	Constructs a new blank QueryResult.
QueryResult(Collection<? extends BoxDocument> documents)	Constructs a new QueryResult initialized with the given documents.

Method Summary

Modifier and Type	Method	Description
long	getNextCursor()	Returns the nextCursor.
QueryResult	setNextCursor(long nextCursor)	Sets the next cursor.
QueryResult	updateNextCursor(BoxQuery query)	Updates nextCursor according to the last document in the query result.

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, equals, forEach, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.util.List

containsAll

Constructor Detail

QueryResult

public QueryResult()

Constructs a new blank QueryResult.

QueryResult

public QueryResult(Collection<? extends BoxDocument> documents)

Constructs a new QueryResult initialized with the given documents.

Parameters:

documents - the intial documents

Method Detail

getNextCursor

public long getNextCursor()

Returns the nextCursor.

Returns:

the nextCursor

setNextCursor

public QueryResult setNextCursor(long nextCursor)

Sets the next cursor.

Parameters:

nextCursor - the nextCursor to set

Returns:

this

updateNextCursor

public QueryResult updateNextCursor(BoxQuery query)

Updates nextCursor according to the last document in the query result. If the result is empty, it reuses the cursor in the query.

Parameters:

query - the original query containing the cursor

Returns:

this