tigase.muc
Enum Role

java.lang.Object
  java.lang.Enum<Role>
      tigase.muc.Role

All Implemented Interfaces:

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

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

A temporary position or privilege level within a room, distinct from a user's long-lived affiliation with the room; the possible roles are "moderator", "participant", and "visitor" (it is also possible to have no defined role). A role lasts only for the duration of an occupant's visit to a room.

Created: 2007-01-26 16:29:36

Version:

$Rev: 81 $

Author:

bmalkow

Enum Constant Summary

MODERATOR
A room role that is usually associated with room admins but that may be granted to non-admins; is allowed to kick users, grant and revoke voice, etc.

NONE
Internal usage only.

PARTICIPANT
An occupant who does not have administrative privileges; in a moderated room, a participant is further defined as having voice (in contrast to a visitor).

VISITOR
In a moderated room, an occupant who does not have voice (in contrast to a participant).

Method Summary

int	getWeight()
static Role	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Role[]	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

MODERATOR

public static final Role MODERATOR

A room role that is usually associated with room admins but that may be granted to non-admins; is allowed to kick users, grant and revoke voice, etc.

PARTICIPANT

public static final Role PARTICIPANT

An occupant who does not have administrative privileges; in a moderated room, a participant is further defined as having voice (in contrast to a visitor).

VISITOR

public static final Role VISITOR

In a moderated room, an occupant who does not have voice (in contrast to a participant).

NONE

public static final Role NONE

Internal usage only.

Method Detail

values

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

Returns:

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

valueOf

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

getWeight

public int getWeight()

Returns:

Returns the weight.