org.jboss.aerogear.sync.jsonpatch

Class JsonPatchMessage

java.lang.Object

org.jboss.aerogear.sync.jsonpatch.JsonPatchMessage

All Implemented Interfaces:

PatchMessage<JsonPatchEdit>, Payload<PatchMessage<JsonPatchEdit>>

public class JsonPatchMessage
extends Object
implements PatchMessage<JsonPatchEdit>

Constructor Summary

Constructors

Constructor and Description
JsonPatchMessage(String documentId, String clientId, Queue<JsonPatchEdit> edits)

Method Summary

Modifier and Type	Method and Description
String	asJson() Transforms this payload to a JSON String representation.
String	clientId() Identifies the client that this edit instance belongs to.
String	documentId() Identifies the document that this edit is related to
Queue<JsonPatchEdit>	edits() The individual Edits.
JsonPatchMessage	fromJson(String json) Transforms the passed in String JSON representation into this payloads type.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonPatchMessage

public JsonPatchMessage(String documentId,
                        String clientId,
                        Queue<JsonPatchEdit> edits)

Method Detail

documentId

public String documentId()

Description copied from interface: PatchMessage

Identifies the document that this edit is related to

Specified by:

documentId in interface PatchMessage<JsonPatchEdit>

Returns:

String the document documentId.

clientId

public String clientId()

Description copied from interface: PatchMessage

Identifies the client that this edit instance belongs to.

Specified by:

clientId in interface PatchMessage<JsonPatchEdit>

Returns:

String the client identifier.

edits

public Queue<JsonPatchEdit> edits()

Description copied from interface: PatchMessage

The individual Edits.

Specified by:

edits in interface PatchMessage<JsonPatchEdit>

Returns:

Queue<Edit> the individual edits.

toString

public String toString()

Overrides:

toString in class Object

asJson

public String asJson()

Description copied from interface: Payload

Transforms this payload to a JSON String representation.

Specified by:

asJson in interface Payload<PatchMessage<JsonPatchEdit>>

Returns:

String the payload as a JSON String representation

fromJson

public JsonPatchMessage fromJson(String json)

Description copied from interface: Payload

Transforms the passed in String JSON representation into this payloads type.

Specified by:

fromJson in interface Payload<PatchMessage<JsonPatchEdit>>

Parameters:

json - a string representation of this payloads type

Returns:

T an instance of this payloads type