com.couchbase.lite

Class QueryEnumerator

java.lang.Object

com.couchbase.lite.QueryEnumerator

All Implemented Interfaces:

java.lang.Iterable<QueryRow>, java.util.Iterator<QueryRow>

public class QueryEnumerator
extends java.lang.Object
implements java.util.Iterator<QueryRow>, java.lang.Iterable<QueryRow>

An enumerator for Couchbase Lite View Query results.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compare this to given QueryEnumerator to check if equals.
int	getCount() Gets the number of rows in the QueryEnumerator.
QueryRow	getRow(int index) Gets the QueryRow at the specified index in the results.
long	getSequenceNumber() Gets the Database's current sequence number at the time the View was generated for the results.
boolean	hasNext() Required to satisfy java Iterator interface
boolean	isStale() True if the database has changed since the view was generated.
java.util.Iterator<QueryRow>	iterator()
QueryRow	next() Gets the next QueryRow from the results, or null if there are no more results.
void	remove() Required to satisfy java Iterator interface
void	reset() Resets the enumeration so the next call to -nextObject or -nextRow will return the first row.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getCount

public int getCount()

Gets the number of rows in the QueryEnumerator.

getSequenceNumber

public long getSequenceNumber()

Gets the Database's current sequence number at the time the View was generated for the results.

next

public QueryRow next()

Gets the next QueryRow from the results, or null if there are no more results.

Specified by:

next in interface java.util.Iterator<QueryRow>

getRow

public QueryRow getRow(int index)

Gets the QueryRow at the specified index in the results.

equals

public boolean equals(java.lang.Object o)

Compare this to given QueryEnumerator to check if equals. This compares the underlying rows of the two QueryEnumerator instances.

Overrides:

equals in class java.lang.Object

Parameters:

o - the QueryEnumerator to compare this instance with.

Returns:

true if equal, false otherwise.

hasNext

public boolean hasNext()

Required to satisfy java Iterator interface

Specified by:

hasNext in interface java.util.Iterator<QueryRow>

remove

public void remove()

Required to satisfy java Iterator interface

Specified by:

remove in interface java.util.Iterator<QueryRow>

isStale

public boolean isStale()

True if the database has changed since the view was generated.

reset

public void reset()

Resets the enumeration so the next call to -nextObject or -nextRow will return the first row.

iterator

public java.util.Iterator<QueryRow> iterator()

Specified by:

iterator in interface java.lang.Iterable<QueryRow>