1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
/*
* Jitsi, the OpenSource Java VoIP and Instant Messaging client.
*
* Distributable under LGPL license.
* See terms of license at gnu.org.
*/
package net.java.sip.communicator.service.protocol;
/**
* Indicates roles that a chat room member detains in its containing chat room.
*
* @author Emil Ivov
* @author Valentin Martinet
* @author Yana Stamcheva
*/
public enum ChatRoomMemberRole
implements Comparable<ChatRoomMemberRole>
{
/**
* A role implying the full set of chat room permissions
*/
OWNER("Owner", "service.gui.chat.role.OWNER", 70),
/**
* A role implying administrative permissions.
*/
ADMINISTRATOR("Administrator", "service.gui.chat.role.ADMINISTRATOR", 60),
/**
* A role implying moderator permissions.
*/
MODERATOR("Moderator", "service.gui.chat.role.MODERATOR", 50),
/**
* A role implying standard participant permissions.
*/
MEMBER("Member", "service.gui.chat.role.MEMBER", 40),
/**
* A role implying standard participant permissions.
*/
GUEST("Guest", "service.gui.chat.role.GUEST", 30),
/**
* A role implying standard participant permissions without the right to
* send messages/speak.
*/
SILENT_MEMBER("SilentMember", "service.gui.chat.role.SILENT_MEMBER", 20),
/**
* A role implying an explicit ban for the user to join the room.
*/
OUTCAST("Outcast", "service.gui.chat.role.OUTCAST", 10);
/**
* the name of this role.
*/
private final String roleName;
/**
* The index of a role is 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.
*/
private final int roleIndex;
/**
* Resource name for localization.
*/
private final String resourceName;
/**
* Creates a role with the specified <tt>roleName</tt>. The constructor
* is protected in case protocol implementations need to add extra roles
* (this should only be done when absolutely necessary in order to assert
* smooth interoperability with the user interface).
*
* @param roleName the name of this role.
* @param resource the resource name to localize the enum.
* @param roleIndex an int that would allow to compare this role to others
* according to the set of permissions that it implies.
*
* @throws java.lang.NullPointerException if roleName is null.
*/
private ChatRoomMemberRole(String roleName, String resource, int roleIndex)
throws NullPointerException
{
if(roleName == null)
throw new NullPointerException("Role Name can't be null.");
this.roleName = roleName;
this.resourceName = resource;
this.roleIndex = roleIndex;
}
/**
* Returns the name of this role.
*
* @return the name of this role.
*/
public String getRoleName()
{
return this.roleName;
}
/**
* Returns a localized (i18n) name role name.
*
* @return a i18n version of this role name.
*/
public String getLocalizedRoleName()
{
return this.resourceName;
}
/**
* 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.
*
* @return an <tt>int</tt> that when compared to role indexes of other
* roles can provide an ordering for the different role instances.
*/
public int getRoleIndex()
{
return roleIndex;
}
}
|
