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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
|
/*
* 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.event;
import java.util.*;
import net.java.sip.communicator.service.protocol.*;
/**
* <tt>MessageReceivedEvent</tt>s indicate reception of an instant message.
*
* @author Emil Ivov
*/
public class MessageReceivedEvent
extends EventObject
{
/**
* Serial version UID.
*/
private static final long serialVersionUID = 0L;
/**
* An event type indicating that the message being received is a standard
* conversation message sent by another contact.
*/
public static final int CONVERSATION_MESSAGE_RECEIVED = 1;
/**
* An event type indicating that the message being received is a system
* message being sent by the server or a system administrator.
*/
public static final int SYSTEM_MESSAGE_RECEIVED = 2;
/**
* an event type indicating that the message being received is an SMS
* message.
*/
public static final int SMS_MESSAGE_RECEIVED = 3;
/**
* The contact that has sent this message.
*/
private Contact from = null;
/**
* The <tt>ContactResource</tt>, from which the message was sent.
*/
private ContactResource fromResource = null;
/**
* A timestamp indicating the exact date when the event occurred.
*/
private final Date timestamp;
/**
* The type of message event that this instance represents.
*/
private int eventType = -1;
/**
* The ID of the message being corrected, or null if this is a new message
* and not a correction.
*/
private String correctedMessageUID = null;
/**
* Indicates whether this is private messaging event or not.
*/
private boolean isPrivateMessaging = false;
/**
* The room associated with the contact which sent the message.
*/
private ChatRoom privateMessagingContactRoom = null;
/**
* Creates a <tt>MessageReceivedEvent</tt> representing reception of the
* <tt>source</tt> message received from the specified <tt>from</tt>
* contact.
*
* @param source the <tt>Message</tt> whose reception this event represents.
* @param from the <tt>Contact</tt> that has sent this message.
* @param timestamp the exact date when the event ocurred.
*/
public MessageReceivedEvent(Message source,
Contact from,
Date timestamp)
{
this(source, from, timestamp, CONVERSATION_MESSAGE_RECEIVED);
}
/**
* Creates a <tt>MessageReceivedEvent</tt> representing reception of the
* <tt>source</tt> message received from the specified <tt>from</tt>
* contact.
*
* @param source the <tt>Message</tt> whose reception this event represents.
* @param from the <tt>Contact</tt> that has sent this message.
* @param correctedMessageUID The ID of the message being corrected, or null
* if this is a new message
* and not a correction.
*/
public MessageReceivedEvent(Message source,
Contact from,
String correctedMessageUID)
{
this(source, from, new Date(),
CONVERSATION_MESSAGE_RECEIVED);
this.correctedMessageUID = correctedMessageUID;
}
/**
* Creates a <tt>MessageReceivedEvent</tt> representing reception of the
* <tt>source</tt> message received from the specified <tt>from</tt>
* contact.
*
* @param source the <tt>Message</tt> whose reception this event represents.
* @param from the <tt>Contact</tt> that has sent this message.
* @param timestamp the exact date when the event occurred.
* @param correctedMessageUID The ID of the message being corrected, or null
* if this is a new message
* and not a correction.
*/
public MessageReceivedEvent(Message source,
Contact from,
Date timestamp,
String correctedMessageUID)
{
this( source,
from,
null,
timestamp,
correctedMessageUID);
}
/**
* Creates a <tt>MessageReceivedEvent</tt> representing reception of the
* <tt>source</tt> message received from the specified <tt>from</tt>
* contact.
*
* @param source the <tt>Message</tt> whose reception this event represents.
* @param from the <tt>Contact</tt> that has sent this message.
* @param fromResource the <tt>ContactResource</tt>, from which this message
* was sent
* @param timestamp the exact date when the event occurred.
* @param correctedMessageUID The ID of the message being corrected, or null
* if this is a new message
* and not a correction.
*/
public MessageReceivedEvent(Message source,
Contact from,
ContactResource fromResource,
Date timestamp,
String correctedMessageUID)
{
this( source,
from,
fromResource,
timestamp,
CONVERSATION_MESSAGE_RECEIVED);
this.correctedMessageUID = correctedMessageUID;
}
/**
* Creates a <tt>MessageReceivedEvent</tt> representing reception of the
* <tt>source</tt> message received from the specified <tt>from</tt>
* contact.
*
* @param source the <tt>Message</tt> whose reception this event represents.
* @param from the <tt>Contact</tt> that has sent this message.
* @param fromResource the <tt>ContactResource</tt>, from which this message
* was sent
* @param timestamp the exact date when the event occurred.
* @param correctedMessageUID The ID of the message being corrected, or null
* if this is a new message and not a correction.
* @param isPrivateMessaging indicates whether the this is private messaging
* event or not.
* @param privateContactRoom the chat room associated with the contact.
*/
public MessageReceivedEvent(Message source,
Contact from,
ContactResource fromResource,
Date timestamp,
String correctedMessageUID,
boolean isPrivateMessaging,
ChatRoom privateContactRoom)
{
this( source,
from,
fromResource,
timestamp,
CONVERSATION_MESSAGE_RECEIVED,
isPrivateMessaging,
privateContactRoom);
this.correctedMessageUID = correctedMessageUID;
}
/**
* Creates a <tt>MessageReceivedEvent</tt> representing reception of the
* <tt>source</tt> message received from the specified <tt>from</tt>
* contact.
*
* @param source the <tt>Message</tt> whose reception this event represents.
* @param from the <tt>Contact</tt> that has sent this message.
* @param timestamp the exact date when the event occurred.
* @param eventType the type of message event that this instance represents
* (one of the XXX_MESSAGE_RECEIVED static fields).
*/
public MessageReceivedEvent(Message source,
Contact from,
Date timestamp,
int eventType)
{
this(source, from, null, timestamp, eventType);
}
/**
* Creates a <tt>MessageReceivedEvent</tt> representing reception of the
* <tt>source</tt> message received from the specified <tt>from</tt>
* contact.
*
* @param source the <tt>Message</tt> whose reception this event represents.
* @param from the <tt>Contact</tt> that has sent this message.
* @param fromResource the <tt>ContactResource</tt>, from which this message
* was sent
* @param timestamp the exact date when the event occurred.
* @param eventType the type of message event that this instance represents
* (one of the XXX_MESSAGE_RECEIVED static fields).
*/
public MessageReceivedEvent(Message source,
Contact from,
ContactResource fromResource,
Date timestamp,
int eventType)
{
this(source, from, fromResource, timestamp, eventType, false, null);
}
/**
* Creates a <tt>MessageReceivedEvent</tt> representing reception of the
* <tt>source</tt> message received from the specified <tt>from</tt>
* contact.
*
* @param source the <tt>Message</tt> whose reception this event represents.
* @param from the <tt>Contact</tt> that has sent this message.
* @param fromResource the <tt>ContactResource</tt>, from which this message
* was sent
* @param timestamp the exact date when the event occurred.
* @param eventType the type of message event that this instance represents
* (one of the XXX_MESSAGE_RECEIVED static fields).
* @param isPrivateMessaging indicates whether the this is private messaging
* event or not.
* @param privateContactRoom the chat room associated with the contact.
*/
public MessageReceivedEvent(Message source,
Contact from,
ContactResource fromResource,
Date timestamp,
int eventType,
boolean isPrivateMessaging,
ChatRoom privateContactRoom)
{
super(source);
this.from = from;
this.fromResource = fromResource;
this.timestamp = timestamp;
this.eventType = eventType;
this.isPrivateMessaging = isPrivateMessaging;
this.privateMessagingContactRoom = privateContactRoom;
}
/**
* Returns a reference to the <tt>Contact</tt> that has sent the
* <tt>Message</tt> whose reception this event represents.
*
* @return a reference to the <tt>Contact</tt> that has sent the
* <tt>Message</tt> whose reception this event represents.
*/
public Contact getSourceContact()
{
return from;
}
/**
* Returns a reference to the <tt>ContactResource</tt> that has sent the
* <tt>Message</tt> whose reception this event represents.
*
* @return a reference to the <tt>ContactResource</tt> that has sent the
* <tt>Message</tt> whose reception this event represents.
*/
public ContactResource getContactResource()
{
return fromResource;
}
/**
* Returns the message that triggered this event
*
* @return the <tt>Message</tt> that triggered this event.
*/
public Message getSourceMessage()
{
return (Message)getSource();
}
/**
* A timestamp indicating the exact date when the event occurred.
*
* @return a Date indicating when the event occurred.
*/
public Date getTimestamp()
{
return timestamp;
}
/**
* Returns the type of message event represented by this event instance.
* Message event type is one of the XXX_MESSAGE_RECEIVED fields of this
* class.
*
* @return one of the XXX_MESSAGE_RECEIVED fields of this class indicating
* the type of this event.
*/
public int getEventType()
{
return eventType;
}
/**
* Returns the correctedMessageUID The ID of the message being corrected,
* or null if this is a new message and not a correction.
*
* @return the correctedMessageUID The ID of the message being corrected,
* or null if this is a new message and not a correction.
*/
public String getCorrectedMessageUID()
{
return correctedMessageUID;
}
/**
* Returns the chat room of the private messaging contact associated with
* the event and null if the contact is not private messaging contact.
*
* @return the chat room associated with the contact or null if no chat room
* is associated with the contact.
*/
public ChatRoom getPrivateMessagingContactRoom()
{
return privateMessagingContactRoom;
}
/**
* Returns <tt>true</true> if this is private messaging event and
* <tt>false</tt> if not.
*
* @return <tt>true</true> if this is private messaging event and
* <tt>false</tt> if not.
*/
public boolean isPrivateMessaging()
{
return isPrivateMessaging;
}
}
|
