org.glassfish.cafe.api
Enum UserProcedure.State

java.lang.Object
  java.lang.Enum<UserProcedure.State>
      org.glassfish.cafe.api.UserProcedure.State

All Implemented Interfaces:

Serializable, Comparable<UserProcedure.State>

Enclosing interface:

UserProcedure

public static enum UserProcedure.State
extends Enum<UserProcedure.State>

Enum Constant Summary

ACTIVE
The procedure is established, at least an acknowledgment for the first message sent has been received.

ENDED
The user procedure has been terminated by the local side or by the remote side.

INITIATED
The user procedure is created but no message has been sent.

REFRESHING
After invoking the update() method in state ACTIVE, before an acknowledgment for the resulting sent message has been received.

STARTING
The update() method has been invoked, the resulting first message of the procedure has been sent, but no acknowledgment has been received.

Method Summary

static UserProcedure.State	valueOf(String name) Returns the enum constant of this type with the specified name.
static UserProcedure.State[]	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

INITIATED

public static final UserProcedure.State INITIATED

The user procedure is created but no message has been sent.

STARTING

public static final UserProcedure.State STARTING

The update() method has been invoked, the resulting first message of the procedure has been sent, but no acknowledgment has been received.

ACTIVE

public static final UserProcedure.State ACTIVE

The procedure is established, at least an acknowledgment for the first message sent has been received.

REFRESHING

public static final UserProcedure.State REFRESHING

After invoking the update() method in state ACTIVE, before an acknowledgment for the resulting sent message has been received.

ENDED

public static final UserProcedure.State ENDED

The user procedure has been terminated by the local side or by the remote side.

Method Detail

values

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

Returns:

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

valueOf

public static UserProcedure.State 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