Package com.jbstrap.core.websocket.messages

Enum Class MessageType

java.lang.Object

java.lang.Enum<MessageType>

com.jbstrap.core.websocket.messages.MessageType

All Implemented Interfaces:

Serializable, Comparable<MessageType>, Constable

public enum MessageType
extends Enum<MessageType>

Since:

4.0

Author:

JBStrap

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEBUG	Debug type message
FUNCTION	Function call type message
LOAD_JAVASCRIPT	JavaScript package load triggering message
SCRIPT	JavaScript execution message

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DEBUG

public static final MessageType DEBUG

Debug type message

The message will appear in the browser console log

SCRIPT

public static final MessageType SCRIPT

JavaScript execution message

The messages contain JavaScript. The server won't wait for reply from these.

FUNCTION

public static final MessageType FUNCTION

Function call type message

These messages contain an executable JavaScript block, or a JavaScript function that can be called. The server expects a response to the message. The response message contains the block or function's return value. Until the response arrives, or it times out, the server side execution is suspended.

LOAD_JAVASCRIPT

public static final MessageType LOAD_JAVASCRIPT

JavaScript package load triggering message

These messages must contain the JavaScript file's URL.

Method Details

values

public static MessageType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static MessageType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null