org.diirt.pods.web.common

Class MessageWriteCompletedEvent

java.lang.Object

org.diirt.pods.web.common.Message

org.diirt.pods.web.common.MessageWriteCompletedEvent

public class MessageWriteCompletedEvent
extends Message

Message event for the response to a write.

Author:

carcassi

Nested Class Summary

Nested classes/interfaces inherited from class org.diirt.pods.web.common.Message

Message.MessageType

Constructor Summary

Constructors

Constructor and Description
MessageWriteCompletedEvent(int id) Creates a new message based on the given parameters.
MessageWriteCompletedEvent(int id, String error) Creates a new message based on the given parameters.
MessageWriteCompletedEvent(javax.json.JsonObject obj) Creates a new message based on the JSON representation.

Method Summary

Modifier and Type	Method and Description
String	getError() The error message if the write was unsuccessful or null.
boolean	isSuccessful() Whether the write was successful.
void	toJson(Writer writer) Serializes this message as JSON onto the given writer.

Methods inherited from class org.diirt.pods.web.common.Message

getId, getMessage, readValueFromJson, writeValueToJson

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageWriteCompletedEvent

public MessageWriteCompletedEvent(javax.json.JsonObject obj)
                           throws MessageDecodeException

Creates a new message based on the JSON representation.

Parameters:

obj - JSON object

Throws:

MessageDecodeException - if json format is incorrect

MessageWriteCompletedEvent

public MessageWriteCompletedEvent(int id)

Creates a new message based on the given parameters. Creates a successful write response.

Parameters:

id - the channel id

MessageWriteCompletedEvent

public MessageWriteCompletedEvent(int id,
                                  String error)

Creates a new message based on the given parameters. Creates an unsuccessful write response.

Parameters:

id - the channel id

error - the error message

Method Detail

getError

public String getError()

The error message if the write was unsuccessful or null.

Returns:

an error message or null

isSuccessful

public boolean isSuccessful()

Whether the write was successful.

Returns:

true if successful

toJson

public void toJson(Writer writer)

Description copied from class: Message

Serializes this message as JSON onto the given writer.

Overrides:

toJson in class Message

Parameters:

writer - the destination where to serialize the message