org.jboss.aerogear.sync.client

Interface SyncClient<T,S extends Edit<? extends Diff>>

Type Parameters:

T - The type of the Document that this client can handle

S - The type of Edits that this client can handle

public interface SyncClient<T,S extends Edit<? extends Diff>>

Method Summary

Modifier and Type	Method and Description
void	addDocument(ClientDocument<T> document) Adds a ClientDocument to this SyncClient.
void	addPatchListener(PatchListener<T> patchListener) Add an PatchListener that will be notified when a patch has been perfomed.
String	clientId() Returns the client identifier.
SyncClient<T,S>	connect() Connects this client to a Sync Server.
int	countPatchListeners() Returns the number of currently registered PatchListeners
void	deletePatchListener(PatchListener<T> patchListener) Removes the specified PatchListener from the list of listeners.
void	deletePatchListeners() Deletes all PatchListeners.
void	diffAndSend(ClientDocument<T> document) Diff the specified ClientDocument and send all edits to the sync server
void	disconnect() Disconnect from the sync server.
boolean	isConnected() Determines whether the client is currently connected to the sync server.

Method Detail

connect

SyncClient<T,S> connect()
                 throws Exception

Connects this client to a Sync Server.

Returns:

SyncClient to allow method chaining.

Throws:

Exception - if an occurs while connecting to the sync server

isConnected

boolean isConnected()

Determines whether the client is currently connected to the sync server.

Returns:

true if the client is currently connected.

disconnect

void disconnect()

Disconnect from the sync server.

clientId

String clientId()

Returns the client identifier.

Returns:

String the client identifier

addDocument

void addDocument(ClientDocument<T> document)

Adds a ClientDocument to this SyncClient.

Parameters:

document - the document to add to the SyncClient

diffAndSend

void diffAndSend(ClientDocument<T> document)

Diff the specified ClientDocument and send all edits to the sync server

Parameters:

document - the updates made by the client

addPatchListener

void addPatchListener(PatchListener<T> patchListener)

Add an PatchListener that will be notified when a patch has been perfomed.

Parameters:

patchListener - the listener to add.

deletePatchListener

void deletePatchListener(PatchListener<T> patchListener)

Removes the specified PatchListener from the list of listeners.

Parameters:

patchListener - the listener to delete from the list of listeners.

deletePatchListeners

void deletePatchListeners()

Deletes all PatchListeners.

countPatchListeners

int countPatchListeners()

Returns the number of currently registered PatchListeners

Returns:

int the number of listeners currently registered.