com.couchbase.lite

Class Replicator

java.lang.Object

com.couchbase.lite.Replicator

All Implemented Interfaces:

NetworkReachabilityListener

public class Replicator
extends Object
implements NetworkReachabilityListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Replicator.ActivityLevel Activity level of a replicator.
class	Replicator.Progress Progress of a replicator.
class	Replicator.Status Combined activity level and progress of a replicator.

Constructor Summary

Constructors

Constructor and Description
Replicator(ReplicatorConfiguration config) Initializes a replicator with the given configuration.

Method Summary

Modifier and Type	Method and Description
ListenerToken	addChangeListener(Executor executor, ReplicatorChangeListener listener) Set the given ReplicatorChangeListener to the this replicator.
ListenerToken	addChangeListener(ReplicatorChangeListener listener)
protected void	finalize()
ReplicatorConfiguration	getConfig() The replicator's configuration.
Replicator.Status	getStatus() The replicator's current status: its activity level and progress.
void	networkReachable()
void	networkUnreachable()
void	removeChangeListener(ListenerToken token) Remove the given ReplicatorChangeListener from the this replicator.
void	start() Starts the replicator.
void	stop() Stops a running replicator.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Replicator

public Replicator(ReplicatorConfiguration config)

Initializes a replicator with the given configuration.

Parameters:

config -

Method Detail

start

public void start()

Starts the replicator. This method returns immediately; the replicator runs asynchronously and will report its progress throuh the replicator change notification.

stop

public void stop()

Stops a running replicator. This method returns immediately; when the replicator actually stops, the replicator will change its status's activity level to `kCBLStopped` and the replicator change notification will be notified accordingly.

getConfig

public ReplicatorConfiguration getConfig()

The replicator's configuration.

Returns:

getStatus

public Replicator.Status getStatus()

The replicator's current status: its activity level and progress. Observable.

Returns:

addChangeListener

public ListenerToken addChangeListener(ReplicatorChangeListener listener)

addChangeListener

public ListenerToken addChangeListener(Executor executor,
                                       ReplicatorChangeListener listener)

Set the given ReplicatorChangeListener to the this replicator.

Parameters:

listener -

removeChangeListener

public void removeChangeListener(ListenerToken token)

Remove the given ReplicatorChangeListener from the this replicator.

toString

public String toString()

Overrides:

toString in class Object

networkReachable

public void networkReachable()

Specified by:

networkReachable in interface NetworkReachabilityListener

networkUnreachable

public void networkUnreachable()

Specified by:

networkUnreachable in interface NetworkReachabilityListener

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable