Package org.jolokia.server.core.request.notification

Enum Class NotificationCommandType

java.lang.Object

java.lang.Enum<NotificationCommandType>

org.jolokia.server.core.request.notification.NotificationCommandType

All Implemented Interfaces:

Serializable, Comparable<NotificationCommandType>, java.lang.constant.Constable

public enum NotificationCommandType
extends Enum<NotificationCommandType>

Enum specifying the possible notification command types

Since:

19.03.13

Author:

roland

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
ADD	Add a new listener for a certain client
LIST	List all notifications for a client
OPEN	Open a channel which can be used to transmit notifications
PING	Ping to update the freshness of a client
REGISTER	Register a new client
REMOVE	Remove a listener for a certain client
UNREGISTER	Unregister a client and remove all listeners

Method Summary

Modifier and Type	Method	Description
String	getType()	Return the name of the type
static NotificationCommandType	getTypeByName(String pName)	Case insensitive lookup by name
static NotificationCommandType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static NotificationCommandType[]	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

REGISTER

public static final NotificationCommandType REGISTER

Register a new client

UNREGISTER

public static final NotificationCommandType UNREGISTER

Unregister a client and remove all listeners

ADD

public static final NotificationCommandType ADD

Add a new listener for a certain client

REMOVE

public static final NotificationCommandType REMOVE

Remove a listener for a certain client

PING

public static final NotificationCommandType PING

Ping to update the freshness of a client

OPEN

public static final NotificationCommandType OPEN

Open a channel which can be used to transmit notifications

LIST

public static final NotificationCommandType LIST

List all notifications for a client

Method Details

values

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

getType

public String getType()

Return the name of the type

Returns:

name of type

getTypeByName

public static NotificationCommandType getTypeByName(String pName)

Case insensitive lookup by name

Parameters:

pName - name of the command (lower- or upper case)

Returns:

command looked up

Throws:

IllegalArgumentException - if the argument is either null or does not map to a type.