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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
/*
* Jitsi, the OpenSource Java VoIP and Instant Messaging client.
*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.java.sip.communicator.service.protocol.event;
import java.util.*;
import net.java.sip.communicator.service.protocol.*;
/**
* Dispatched to notify interested parties that a change in the presence of an
* ad-hoc chat room participant has occurred. Changes may include the
* participant being join, left...
*
* @author Valentin Martinet
*/
@SuppressWarnings("serial")
public class AdHocChatRoomParticipantPresenceChangeEvent
extends EventObject
{
/**
* Indicates that this event was triggered as a result of the participant
* joining the source ad-hoc chat room.
*/
public static final String CONTACT_JOINED = "ContactJoined";
/**
* Indicates that this event was triggered as a result of the participant
* leaving the source ad-hoc chat room.
*/
public static final String CONTACT_LEFT = "ContactLeft";
/**
* Indicates that this event was triggered as a result of the participant
* being disconnected from the server brutally, or due to a ping timeout.
*/
public static final String CONTACT_QUIT = "ContactQuit";
/**
* The well-known reason for a
* <code>AdHocChatRoomParticipantPresenceChangeEvent</code> to occur as part
* of an operation which lists all users in an <code>AdHocChatRoom</code>.
*/
public static final String REASON_USER_LIST = "ReasonUserList";
/**
* The ad-hoc chat room participant that the event relates to.
*/
private final Contact sourceParticipant;
/**
* The type of this event. Values can be any of the CONTACT_XXX fields.
*/
private final String eventType;
/**
* An optional String indicating a possible reason as to why the event
* might have occurred.
*/
private final String reason;
/**
* Creates an <tt>AdHocChatRoomParticipantPresenceChangeEvent</tt>
* representing that a change in the presence of an <tt>Contact</tt>
* has occurred. Changes may include the participant being join, left, etc.
*
* @param sourceAdHocRoom the <tt>AdHocChatRoom</tt> that produced this
* event
* @param sourceParticipant the <tt>Contact</tt> that this event is about
* @param eventType the event type; one of the CONTACT_XXX constants
* @param reason the reason explaining why this event might have occurred
*/
public AdHocChatRoomParticipantPresenceChangeEvent(
AdHocChatRoom sourceAdHocRoom,
Contact sourceParticipant,
String eventType,
String reason )
{
super(sourceAdHocRoom);
this.sourceParticipant = sourceParticipant;
this.eventType = eventType;
this.reason = reason;
}
/**
* Returns the ad-hoc chat room that produced this event.
*
* @return the <tt>AdHocChatRoom</tt> that produced this event
*/
public AdHocChatRoom getAdHocChatRoom()
{
return (AdHocChatRoom)getSource();
}
/**
* Returns the participant that this event is about.
*
* @return the <tt>Contact</tt> that this event is about.
*/
public Contact getParticipant()
{
return this.sourceParticipant;
}
/**
* A reason String indicating a human readable reason for this event.
*
* @return a human readable String containing the reason for this event,
* or null if no particular reason was specified.
*/
public String getReason()
{
return this.reason;
}
/**
* Gets the indicator which determines whether this event has occurred with
* the well-known reason of listing all users in a <code>ChatRoom</code>.
*
* @return <tt>true</tt> if this event has occurred with the well-known
* reason of listing all users in a <code>ChatRoom</code> i.e.
* {@link #getReason()} returns a value of {@link #REASON_USER_LIST};
* otherwise, <tt>false</tt>
*/
public boolean isReasonUserList()
{
return REASON_USER_LIST.equals(getReason());
}
/**
* Returns the type of this event which could be one of the MEMBER_XXX
* member field values.
*
* @return one of the MEMBER_XXX member field values indicating the type
* of this event.
*/
public String getEventType()
{
return eventType;
}
/**
* Returns a String representation of this event.
*
* @return string representation of this event
*/
@Override
public String toString()
{
return "AdHocChatRoomParticipantPresenceChangeEvent[type="
+ getEventType()
+ " sourceAdHocRoom="
+ getAdHocChatRoom().toString()
+ " member="
+ getParticipant().toString()
+ "]";
}
}
|
