org.dizitart.no2.sync

Class SyncHandle

java.lang.Object

org.dizitart.no2.sync.SyncHandle

public final class SyncHandle
extends java.lang.Object

Represents a handle for the replication operation.

Since:

1.0

See Also:

Replicator

Method Summary

Modifier and Type	Method and Description
void	cancelSync() Cancels current replication thread.
boolean	isCancelled() Indicates whether the replicator thread is currently canceled.
boolean	isPaused() Indicates if the replication is paused or not.
boolean	isStopped() Indicates whether the replicator is stopped.
void	pauseSync() Pauses the replicator.
void	resetLocalWithRemote(int offset, int size) Resets local collection with the remote collection.
void	resetRemoteWithLocal(int offset, int size) Resets remote collection with the local collection.
void	resumeSync() Resumes a paused replicator.
void	startSync() Starts replication in a background thread.
void	stopSync() Stops current replicator.

Methods inherited from class java.lang.Object

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

Method Detail

startSync

public void startSync()

Starts replication in a background thread. This background thread will run after every fixed amount of time (sync delay).

This operations will notify all SyncEventListener instances with event type EventType.STARTED.

pauseSync

public void pauseSync()

Pauses the replicator. If any replicator thread is currently running, it will not be paused but the next iteration will be paused until it has been resumed by resumeSync() call.

resumeSync

public void resumeSync()

Resumes a paused replicator.

resetLocalWithRemote

public void resetLocalWithRemote(int offset,
                                 int size)

Resets local collection with the remote collection. Data can be fetched from remote in pages using offset and size parameters.

Parameters:

offset - the pagination offset

size - the pagination size

resetRemoteWithLocal

public void resetRemoteWithLocal(int offset,
                                 int size)

Resets remote collection with the local collection. Data can be fetched from local in pages using offset and size parameters.

Parameters:

offset - the pagination offset

size - the pagination size

cancelSync

public void cancelSync()

Cancels current replication thread.

This operations will notify all SyncEventListener instances with event type EventType.CANCELED.

isCancelled

public boolean isCancelled()

Indicates whether the replicator thread is currently canceled.

Returns:

true if cancelled; false otherwise.

stopSync

public void stopSync()

Stops current replicator.

isStopped

public boolean isStopped()

Indicates whether the replicator is stopped.

Returns:

true if stopped; false otherwise.

isPaused

@Generated(value="lombok")
public boolean isPaused()

Indicates if the replication is paused or not.

Returns:

a boolean value indicating the pause status.