net.java.sip.communicator.service.protocol
Enum ChatRoomMemberRole

java.lang.Object
  java.lang.Enum<ChatRoomMemberRole>
      net.java.sip.communicator.service.protocol.ChatRoomMemberRole

All Implemented Interfaces:

Serializable, Comparable<ChatRoomMemberRole>

public enum ChatRoomMemberRole
extends Enum<ChatRoomMemberRole>
implements Comparable<ChatRoomMemberRole>

Indicates roles that a chat room member detains in its containing chat room.

Author:

Emil Ivov, Valentin Martinet, Yana Stamcheva

Enum Constant Summary

ADMINISTRATOR
A role implying administrative permissions.

GUEST
A role implying standard participant permissions.

MEMBER
A role implying standard participant permissions.

MODERATOR
A role implying moderator permissions.

OUTCAST
A role implying an explicit ban for the user to join the room.

OWNER
A role implying the full set of chat room permissions

SILENT_MEMBER
A role implying standard participant permissions without the right to send messages/speak.

Method Summary

String	getLocalizedRoleName() Returns a localized (i18n) name role name.
int	getRoleIndex() Returns a role index that can be used to allow ordering of roles by other modules (like the UI) that would not necessarily "know" all possible roles.
String	getRoleName() Returns the name of this role.
static ChatRoomMemberRole	valueOf(String name) Returns the enum constant of this type with the specified name.
static ChatRoomMemberRole[]	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

Methods inherited from interface java.lang.Comparable

compareTo

Enum Constant Detail

OWNER

public static final ChatRoomMemberRole OWNER

A role implying the full set of chat room permissions

ADMINISTRATOR

public static final ChatRoomMemberRole ADMINISTRATOR

A role implying administrative permissions.

MODERATOR

public static final ChatRoomMemberRole MODERATOR

A role implying moderator permissions.

MEMBER

public static final ChatRoomMemberRole MEMBER

A role implying standard participant permissions.

GUEST

public static final ChatRoomMemberRole GUEST

A role implying standard participant permissions.

SILENT_MEMBER

public static final ChatRoomMemberRole SILENT_MEMBER

A role implying standard participant permissions without the right to send messages/speak.

OUTCAST

public static final ChatRoomMemberRole OUTCAST

A role implying an explicit ban for the user to join the room.

Method Detail

values

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

Returns:

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

valueOf

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

getRoleName

public String getRoleName()

Returns the name of this role.

Returns:

the name of this role.

getLocalizedRoleName

public String getLocalizedRoleName()

Returns a localized (i18n) name role name.

Returns:

a i18n version of this role name.

getRoleIndex

public int getRoleIndex()

Returns a role index that can be used to allow ordering of roles by other modules (like the UI) that would not necessarily "know" all possible roles. Higher values of the role index indicate roles with more permissions and lower values pertain to more restrictive roles.

Returns:

an int that when compared to role indexes of other roles can provide an ordering for the different role instances.