Couchbase Lite
Objective-C API for iOS and Mac OS
Instance Methods | Properties | List of all members
CBLQueryEnumerator Class Reference

Enumerator on a CBLQuery's result rows. More...

#import <CBLQuery.h>

Inheritance diagram for CBLQueryEnumerator:

Instance Methods

(CBLQueryRow *) - nextRow
 The next result row. More...
 
(CBLQueryRow *) - rowAtIndex:
 Random access to a row in the result. More...
 
(void) - reset
 Resets the enumeration so the next call to -nextObject or -nextRow will return the first row. More...
 

Properties

NSUInteger count
 The number of rows returned in this enumerator. More...
 
UInt64 sequenceNumber
 The database's current sequenceNumber at the time the view was generated. More...
 
BOOL stale
 YES if the database has changed since the view was generated. More...
 

Detailed Description

Enumerator on a CBLQuery's result rows.

The objects returned are instances of CBLQueryRow.

Method Documentation

- (CBLQueryRow*) nextRow

The next result row.

This is the same as -nextObject but with a checked return type.

- (CBLQueryRow*) rowAtIndex: (NSUInteger)  index

Random access to a row in the result.

- (void) reset

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

Property Documentation

- (NSUInteger) count
readatomicassign

The number of rows returned in this enumerator.

- (UInt64) sequenceNumber
readatomicassign

The database's current sequenceNumber at the time the view was generated.

- (BOOL) stale
readatomicassign

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


The documentation for this class was generated from the following file: