com.cloudant.client.api

Class Changes

java.lang.Object

com.cloudant.client.api.Changes

public class Changes
extends java.lang.Object

Contains the Change Notifications API, supports normal and continuous feed Changes.

Usage example for normal feed limiting to 10 results, with a filter:

 
 // feed type normal
 String since = db.info().getUpdateSeq(); // latest update seq
 ChangesResult changeResult = db.changes()
 	.since(since)
 	.limit(10)
 	.filter("example/filter")
 	.getChanges();

 //process the ChangesResult
 for (ChangesResult.Row row : changeResult.getResults()) {
   String docId = row.getId()
   JsonObject doc = row.getDoc();
 }
 
 

Usage example for continuous feed, including document content:

 
 // feed type continuous
 Changes changes = db.changes()
 	.includeDocs(true)
 	.heartBeat(30000)
 	.continuousChanges();

 while (changes.hasNext()) {
 	ChangesResult.Row feed = changes.next();
  String docId = feed.getId();
  JsonObject doc = feed.getDoc();
 }

 //while loop blocks; stop from another thread
 changes.stop(); // stop continuous feed
 
 

Since:

0.0.1

See Also:

ChangesResult, Databases - get changes

Method Summary

Modifier and Type	Method and Description
Changes	continuousChanges() Requests Change notifications of feed type continuous.
Changes	filter(java.lang.String filter)
ChangesResult	getChanges() Requests Change notifications of feed type normal.
boolean	hasNext() Checks whether a feed is available in the continuous stream, blocking until a feed is received.
Changes	heartBeat(long heartBeat)
Changes	includeDocs(boolean includeDocs)
Changes	limit(int limit)
ChangesResult.Row	next()
Changes	since(java.lang.String since)
void	stop() Stops a running continuous feed.
Changes	style(java.lang.String style)
Changes	timeout(long timeout)

Methods inherited from class java.lang.Object

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

Method Detail

continuousChanges

public Changes continuousChanges()

Requests Change notifications of feed type continuous.

Feed notifications are accessed in an iterator style.

Returns:

this Changes object configured for continuous feed.

hasNext

public boolean hasNext()

Checks whether a feed is available in the continuous stream, blocking until a feed is received.

Returns:

true if there is a change

next

public ChangesResult.Row next()

Returns:

The next feed in the stream.

stop

public void stop()

Stops a running continuous feed.

getChanges

public ChangesResult getChanges()

Requests Change notifications of feed type normal.

Returns:

ChangesResult encapsulating the normal feed changes

since

public Changes since(java.lang.String since)

limit

public Changes limit(int limit)

filter

public Changes filter(java.lang.String filter)

heartBeat

public Changes heartBeat(long heartBeat)

timeout

public Changes timeout(long timeout)

includeDocs

public Changes includeDocs(boolean includeDocs)

style

public Changes style(java.lang.String style)