org.jivesoftware.smackx.pubsub

Enum AccessModel

java.lang.Object

java.lang.Enum<AccessModel>

org.jivesoftware.smackx.pubsub.AccessModel

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AccessModel>

public enum AccessModel
extends java.lang.Enum<AccessModel>

This enumeration represents the access models for the PubSub node as defined in the PubSub specification section 16.4.3.

Enum Constant Summary

Enum Constants

Enum Constant and Description
authorize Subscription request must be approved and only subscribers may retrieve items.
open Anyone may subscribe and retrieve items.
presence Anyone with a presence subscription of both or from may subscribe and retrieve items.
roster Anyone in the specified roster group(s) may subscribe and retrieve items.
whitelist Only those on a whitelist may subscribe and retrieve items.

Method Summary

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

open

public static final AccessModel open

Anyone may subscribe and retrieve items.

authorize

public static final AccessModel authorize

Subscription request must be approved and only subscribers may retrieve items.

presence

public static final AccessModel presence

Anyone with a presence subscription of both or from may subscribe and retrieve items.

roster

public static final AccessModel roster

Anyone in the specified roster group(s) may subscribe and retrieve items.

whitelist

public static final AccessModel whitelist

Only those on a whitelist may subscribe and retrieve items.

Method Detail

values

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

Returns:

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

valueOf

public static AccessModel valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null