Package rocks.xmpp.extensions.pubsub.model

Enum SubscriptionState

java.lang.Object

java.lang.Enum<SubscriptionState>

rocks.xmpp.extensions.pubsub.model.SubscriptionState

All Implemented Interfaces:

Serializable, Comparable<SubscriptionState>

public enum SubscriptionState
extends Enum<SubscriptionState>

Represents the subscription state to a node.

See Also:

4.2 Subscription States

Enum Constant Summary

Enum Constants

Enum Constant	Description
NONE	The node MUST NOT send event notifications or payloads to the Entity.
PENDING	An entity has requested to subscribe to a node and the request has not yet been approved by a node owner.
SUBSCRIBED	An entity is subscribed to a node.
UNCONFIGURED	An entity has subscribed but its subscription options have not yet been configured.

Method Summary

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

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final SubscriptionState NONE

The node MUST NOT send event notifications or payloads to the Entity.

PENDING

public static final SubscriptionState PENDING

An entity has requested to subscribe to a node and the request has not yet been approved by a node owner. The node MUST NOT send event notifications or payloads to the entity while it is in this state.

SUBSCRIBED

public static final SubscriptionState SUBSCRIBED

An entity is subscribed to a node. The node MUST send all event notifications (and, if configured, payloads) to the entity while it is in this state (subject to subscriber configuration and content filtering).

UNCONFIGURED

public static final SubscriptionState UNCONFIGURED

An entity has subscribed but its subscription options have not yet been configured. The node MAY send event notifications or payloads to the entity while it is in this state. The service MAY timeout unconfigured subscriptions.

Method Detail

values

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

Returns:

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

valueOf

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