org.atmosphere.stomp.protocol

Enum Action

java.lang.Object

java.lang.Enum<Action>

org.atmosphere.stomp.protocol.Action

All Implemented Interfaces:

Serializable, Comparable<Action>

public enum Action
extends Enum<Action>

This enumeration defines all the action that could performed in STOMP protocol.

Since:

0.1

Version:

1.0

Author:

Guillaume DROUET

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORT Aborts a transaction/
ACK Acknowledgement sent to the server.
BEGIN Begins a transaction.
COMMIT Commits a transaction.
CONNECT When client connects.
CONNECTED Connection notification from server.
DISCONNECT When client disconnects.
ERROR Error pushed by the server.
MESSAGE Message pushed by the server.
NACK Negative acknowledgement sent to the server.
RECEIPT Receipt pushed by the server.
SEND Client data push for a subscription.
STOMP Legacy connection frame.
SUBSCRIBE When client subscribes to a destination.
UNSUBSCRIBE When client stop its subscription to a destination.

Method Summary

Methods

Modifier and Type	Method and Description
static Action	parse(String str) Gets an Action from its String representation.
static Action	valueOf(String name) Returns the enum constant of this type with the specified name.
static Action[]	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

CONNECT

public static final Action CONNECT

When client connects.

DISCONNECT

public static final Action DISCONNECT

When client disconnects.

STOMP

public static final Action STOMP

Legacy connection frame.

CONNECTED

public static final Action CONNECTED

Connection notification from server.

SEND

public static final Action SEND

Client data push for a subscription.

BEGIN

public static final Action BEGIN

Begins a transaction.

COMMIT

public static final Action COMMIT

Commits a transaction.

ABORT

public static final Action ABORT

Aborts a transaction/

SUBSCRIBE

public static final Action SUBSCRIBE

When client subscribes to a destination.

UNSUBSCRIBE

public static final Action UNSUBSCRIBE

When client stop its subscription to a destination.

ACK

public static final Action ACK

Acknowledgement sent to the server.

NACK

public static final Action NACK

Negative acknowledgement sent to the server.

MESSAGE

public static final Action MESSAGE

Message pushed by the server.

RECEIPT

public static final Action RECEIPT

Receipt pushed by the server.

ERROR

public static final Action ERROR

Error pushed by the server.

Method Detail

values

public static Action[] 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 (Action c : Action.values())
    System.out.println(c);

Returns:

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

valueOf

public static Action 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

parse

public static Action parse(String str)
                    throws IllegalActionException

Gets an Action from its String representation.

Parameters:

str - the string representation

Returns:

the corresponding Action

Throws:

IllegalActionException - if the no action match the string representation