Package rocks.xmpp.extensions.pubsub.model

Enum AffiliationState

java.lang.Object

java.lang.Enum<AffiliationState>

rocks.xmpp.extensions.pubsub.model.AffiliationState

All Implemented Interfaces:

Serializable, Comparable<AffiliationState>

public enum AffiliationState
extends Enum<AffiliationState>

Represents the affiliations which allow to manage permissions.

See Also:

4.1 Affiliations

Enum Constant Summary

Enum Constants

Enum Constant	Description
MEMBER	A member, which is allowed to subscribe to and retrieve items from a node.
NONE	No affiliation.
OUTCAST	An entity that is disallowed from subscribing or publishing to a node.
OWNER	The manager of a node, of which there may be more than one; often but not necessarily the node creator.
PUBLISH_ONLY	An entity that is allowed to publish items to a node but that is not allowed to receive notifications.
PUBLISHER	An entity that is allowed to publish items to a node and that is automatically subscribed to the node.

Method Summary

Modifier and Type	Method	Description
static AffiliationState	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AffiliationState[]	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

OWNER

public static final AffiliationState OWNER

The manager of a node, of which there may be more than one; often but not necessarily the node creator.

PUBLISHER

public static final AffiliationState PUBLISHER

An entity that is allowed to publish items to a node and that is automatically subscribed to the node.

PUBLISH_ONLY

public static final AffiliationState PUBLISH_ONLY

An entity that is allowed to publish items to a node but that is not allowed to receive notifications. (This affiliation is useful in the context of nodes that do not have an open access model when automated entities need to generate notifications on behalf of the owner.)

MEMBER

public static final AffiliationState MEMBER

A member, which is allowed to subscribe to and retrieve items from a node.

NONE

public static final AffiliationState NONE

No affiliation.

OUTCAST

public static final AffiliationState OUTCAST

An entity that is disallowed from subscribing or publishing to a node.

Method Detail

values

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

Returns:

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

valueOf

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