org.diirt.pods.web.common

Class Message

java.lang.Object

org.diirt.pods.web.common.Message

Direct Known Subclasses:

MessageConnectionEvent, MessageErrorEvent, MessagePause, MessageResume, MessageSubscribe, MessageUnsubscribe, MessageValueEvent, MessageWrite, MessageWriteCompletedEvent

public abstract class Message
extends Object

A message being sent as part of the WebPods protocol.

Subclasses provide serialization (through toJson(java.io.Writer) and de-serialization (through the constructor) of JSON messages. Each instance of the message is immutable.

Author:

carcassi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Message.MessageType The type of message.

Method Summary

Modifier and Type	Method and Description
int	getId() The id of the channel this message refers to.
Message.MessageType	getMessage() The message type.
static Object	readValueFromJson(javax.json.JsonValue msgValue) Converts the given JSON value to either a vtype, a Java time or a ListNumber.
void	toJson(Writer writer) Serializes this message as JSON onto the given writer.
static void	writeValueToJson(javax.json.stream.JsonGenerator gen, String name, Object value) Converts the given value to a JSON representation.

Methods inherited from class java.lang.Object

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

Method Detail

getMessage

public Message.MessageType getMessage()

The message type. Can't be null.

Returns:

the message type

getId

public int getId()

The id of the channel this message refers to.

Returns:

the channel id

toJson

public void toJson(Writer writer)

Serializes this message as JSON onto the given writer.

Parameters:

writer - the destination where to serialize the message

readValueFromJson

public static Object readValueFromJson(javax.json.JsonValue msgValue)

Converts the given JSON value to either a vtype, a Java time or a ListNumber.

Parameters:

msgValue - the JSON value

Returns:

the converted type

writeValueToJson

public static void writeValueToJson(javax.json.stream.JsonGenerator gen,
                                    String name,
                                    Object value)

Converts the given value to a JSON representation.

Parameters:

gen - the object to create/store the JSON representation

name - the JSON name to store the value as

value - the value to store