org.diirt.pods.web.common

Class MessageErrorEvent

java.lang.Object

org.diirt.pods.web.common.Message

org.diirt.pods.web.common.MessageErrorEvent

public class MessageErrorEvent
extends Message

Message event for errors.

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
MessageErrorEvent(int id, String error) Creates a new message based on the given parameters.
MessageErrorEvent(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.
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

MessageErrorEvent

public MessageErrorEvent(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

MessageErrorEvent

public MessageErrorEvent(int id,
                         String error)

Creates a new message based on the given parameters.

Parameters:

id - the channel id

error - the error message

Method Detail

getError

public String getError()

The error message.

Returns:

error message

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