Enum Class SocketMessageType

java.lang.Object

java.lang.Enum<SocketMessageType>

me.lucko.luckperms.common.webeditor.socket.SocketMessageType

All Implemented Interfaces:

Serializable, Comparable<SocketMessageType>, Constable

public enum SocketMessageType
extends Enum<SocketMessageType>

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHANGE_REQUEST	Sent by the editor to request that the plugin applies a change.
CHANGE_RESPONSE	Sent by the plugin to confirm that the changes sent by the editor have been accepted or applied.
CONNECTED	Sent by the editor to confirm that a connection has been established.
HELLO	Sent when the editor first says "hello" over the channel.
HELLO_REPLY	Sent when the plugin replies to the editors "hello" message.
PING	Ping message to keep the socket alive.
PONG	Ping response.

Field Summary

Fields

Modifier and Type	Field	Description
final String	id

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

HELLO

public static final SocketMessageType HELLO

Sent when the editor first says "hello" over the channel. (editor -> plugin)

HELLO_REPLY

public static final SocketMessageType HELLO_REPLY

Sent when the plugin replies to the editors "hello" message. (plugin -> editor)

CONNECTED

public static final SocketMessageType CONNECTED

Sent by the editor to confirm that a connection has been established. (editor -> plugin)

CHANGE_REQUEST

public static final SocketMessageType CHANGE_REQUEST

Sent by the editor to request that the plugin applies a change. (editor -> plugin)

CHANGE_RESPONSE

public static final SocketMessageType CHANGE_RESPONSE

Sent by the plugin to confirm that the changes sent by the editor have been accepted or applied. (plugin -> editor)

PING

public static final SocketMessageType PING

Ping message to keep the socket alive. (editor -> plugin)

PONG

public static final SocketMessageType PONG

Ping response. (plugin -> editor)

Field Details

id

public final String id

Method Details

values

public static SocketMessageType[] 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 SocketMessageType 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

builder

public JObject builder()

getById

public static SocketMessageType getById(String id)