Package org.jivesoftware.openfire.muc

Enum Class Role

java.lang.Object

java.lang.Enum<Role>

org.jivesoftware.openfire.muc.Role

All Implemented Interfaces:

Serializable, Comparable<Role>, Constable

public enum Role
extends Enum<Role>

A temporary position or privilege level within a room, distinct from a user's long-lived affiliation with the room. A role lasts only for the duration of an occupant's visit 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
moderator	Runs moderated discussions.
none	An occupant who does not permission to stay in the room (was banned)
participant	A normal occupant of the room.
visitor	An occupant who does not have voice (can't speak in the room)

Method Summary

Modifier and Type	Method	Description
int	getValue()	Returns the value for the role.
static Role	valueOf(int value)	Returns the affiliation associated with the specified value.
static Role	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Role[]	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

moderator

public static final Role moderator

Runs moderated discussions. Is allowed to kick users, grant and revoke voice, etc.

participant

public static final Role participant

A normal occupant of the room. An occupant who does not have administrative privileges; in a moderated room, a participant is further defined as having voice

visitor

public static final Role visitor

An occupant who does not have voice (can't speak in the room)

none

public static final Role none

An occupant who does not permission to stay in the room (was banned)

Method Details

values

public static Role[] 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 Role 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 role.

Returns:

the value.

valueOf

public static Role valueOf(int value)

Returns the affiliation associated with the specified value.

Parameters:

value - the value.

Returns:

the associated affiliation.