websocket.drawboard

Enum Room.MessageType

java.lang.Object

java.lang.Enum<Room.MessageType>

websocket.drawboard.Room.MessageType

All Implemented Interfaces:

Serializable, Comparable<Room.MessageType>

Enclosing class:

Room

public static enum Room.MessageType
extends Enum<Room.MessageType>

Specifies the type of a room message that is sent to a client.
Note: Currently we are sending simple string messages - for production apps, a JSON lib should be used for object-level messages.

The number (single char) will be prefixed to the string when sending the message.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DRAW_MESSAGE '1': DrawMesssage: contains serialized DrawMessage(s) prefixed with the current Player's Room.Player.lastReceivedMessageId and ",". Multiple draw messages are concatenated with "|" as separator.
ERROR '0': Error: contains error message.
IMAGE_MESSAGE '2': ImageMessage: Contains number of current players in this room.
PLAYER_CHANGED '3': PlayerChanged: contains "+" or "-" which indicate a player was added or removed to this Room.

Method Summary

Methods

Modifier and Type	Method and Description
static Room.MessageType	valueOf(String name) Returns the enum constant of this type with the specified name.
static Room.MessageType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ERROR

public static final Room.MessageType ERROR

'0': Error: contains error message.

DRAW_MESSAGE

public static final Room.MessageType DRAW_MESSAGE

'1': DrawMesssage: contains serialized DrawMessage(s) prefixed with the current Player's Room.Player.lastReceivedMessageId and ",".
Multiple draw messages are concatenated with "|" as separator.

IMAGE_MESSAGE

public static final Room.MessageType IMAGE_MESSAGE

'2': ImageMessage: Contains number of current players in this room. After this message a Binary Websocket message will follow, containing the current Room image as PNG.
This is the first message that a Room sends to a new Player.

PLAYER_CHANGED

public static final Room.MessageType PLAYER_CHANGED

'3': PlayerChanged: contains "+" or "-" which indicate a player was added or removed to this Room.

Method Detail

values

public static Room.MessageType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Room.MessageType c : Room.MessageType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Room.MessageType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null