Package org.jivesoftware.openfire.muc

Enum Class Affiliation

java.lang.Object

java.lang.Enum<Affiliation>

org.jivesoftware.openfire.muc.Affiliation

All Implemented Interfaces:

Serializable, Comparable<Affiliation>, Constable

public enum Affiliation
extends Enum<Affiliation>

A long-lived association or connection with a room. Affiliation is distinct from role. An affiliation lasts across a user's visits to a room.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
admin	Administrator of the room.
member	A user who is on the "whitelist" for a members-only room or who is registered with an open room.
none	A user who doesn't have an affiliation.
outcast	A user who has been banned from a room.
owner	Owner of the room.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Returns the value for the affiliation.
static Affiliation	valueOf(int value)	Returns the affiliation associated with the specified value.
static Affiliation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Affiliation[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

owner

public static final Affiliation owner

Owner of the room.

admin

public static final Affiliation admin

Administrator of the room.

member

public static final Affiliation member

A user who is on the "whitelist" for a members-only room or who is registered with an open room.

outcast

public static final Affiliation outcast

A user who has been banned from a room.

none

public static final Affiliation none

A user who doesn't have an affiliation. This kind of users can register with members-only rooms and may enter an open room.

Method Details

values

public static Affiliation[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Affiliation valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Returns the value for the affiliation.

Returns:

the value.

valueOf

public static Affiliation valueOf(int value)

Returns the affiliation associated with the specified value.

Parameters:

value - the value.

Returns:

the associated affiliation.