com.couchbase.lite.replicator

Class Replication.ChangeEvent

java.lang.Object

com.couchbase.lite.replicator.Replication.ChangeEvent

Enclosing class:

Replication

public static class Replication.ChangeEvent
extends java.lang.Object

The type of event raised by a Replication when any of the following properties change: mode, running, error, completed, total.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ChangeEvent(com.couchbase.lite.replicator.ReplicationInternal replInternal)
protected	ChangeEvent(com.couchbase.lite.replicator.ReplicationInternal replInternal, ReplicationStateTransition transition)
protected	ChangeEvent(com.couchbase.lite.replicator.ReplicationInternal replInternal, java.lang.Throwable error)

Method Summary

Modifier and Type	Method and Description
int	getChangeCount() The total number of changes to be processed, if the task is active, else 0.
int	getCompletedChangeCount() The number of completed changes processed, if the task is active, else 0.
java.lang.Throwable	getError() Get the error that triggered this callback, if any.
Replication	getSource() Get the owner Replication object that generated this ChangeEvent.
Replication.ReplicationStatus	getStatus() The replication's current state, one of {stopped, offline, idle, active}.
ReplicationStateTransition	getTransition() Get the ReplicationStateTransition associated with this ChangeEvent, or nil if it was not associated with a state transition.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ChangeEvent

protected ChangeEvent(com.couchbase.lite.replicator.ReplicationInternal replInternal)

ChangeEvent

protected ChangeEvent(com.couchbase.lite.replicator.ReplicationInternal replInternal,
                      ReplicationStateTransition transition)

ChangeEvent

protected ChangeEvent(com.couchbase.lite.replicator.ReplicationInternal replInternal,
                      java.lang.Throwable error)

Method Detail

getSource

public Replication getSource()

Get the owner Replication object that generated this ChangeEvent.

getTransition

public ReplicationStateTransition getTransition()

Get the ReplicationStateTransition associated with this ChangeEvent, or nil if it was not associated with a state transition.

This is not in our official public API, and is subject to change/removal.

getChangeCount

public int getChangeCount()

The total number of changes to be processed, if the task is active, else 0.

This is not in our official public API, and is subject to change/removal.

getCompletedChangeCount

public int getCompletedChangeCount()

The number of completed changes processed, if the task is active, else 0.

This is not in our official public API, and is subject to change/removal.

getStatus

public Replication.ReplicationStatus getStatus()

The replication's current state, one of {stopped, offline, idle, active}.

This is not in our official public API, and is subject to change/removal.

getError

public java.lang.Throwable getError()

Get the error that triggered this callback, if any. There also might be a non-null error saved by the replicator from something that previously happened, which you can get by calling getSource().getLastError().

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object