org.jboss.aerogear.sync

Interface PatchMessage<T extends Edit<? extends Diff>>

Type Parameters:

T - The type of the Edit that this PatchMessage holds

All Superinterfaces:

Payload<PatchMessage<T>>

All Known Implementing Classes:

DiffMatchPatchMessage, JsonMergePatchMessage, JsonPatchMessage

public interface PatchMessage<T extends Edit<? extends Diff>>
extends Payload<PatchMessage<T>>

Represents a stack of changes made on the server of client side.

A PatchMessage is what is passed between the client and the server. It contains a Queue of Edits that represent updates to be performed on the opposing sides document.

Method Summary

Modifier and Type	Method and Description
String	clientId() Identifies the client that this edit instance belongs to.
String	documentId() Identifies the document that this edit is related to
Queue<T>	edits() The individual Edits.

Methods inherited from interface org.jboss.aerogear.sync.Payload

asJson, fromJson

Method Detail

clientId

String clientId()

Identifies the client that this edit instance belongs to.

Returns:

String the client identifier.

documentId

String documentId()

Identifies the document that this edit is related to

Returns:

String the document documentId.

edits

Queue<T> edits()

The individual Edits.

Returns:

Queue<Edit> the individual edits.