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
|
/*
* MessageCountEvent.java
* Copyright (C) 2002 The Free Software Foundation
*
* This file is part of GNU JavaMail, a library.
*
* GNU JavaMail is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* GNU JavaMail is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* As a special exception, if you link this library with other files to
* produce an executable, this library does not by itself cause the
* resulting executable to be covered by the GNU General Public License.
* This exception does not however invalidate any other reasons why the
* executable file might be covered by the GNU General Public License.
*/
package javax.mail.event;
import javax.mail.Folder;
import javax.mail.Message;
/**
* This class notifies changes in the number of messages in a folder.
* <p>
* Note that some folder types may only deliver MessageCountEvents at certain
* times or after certain operations. IMAP in particular will only notify the
* client of MessageCountEvents when a client issues a new command. Refer to
* RFC 2060 http://www.ietf.org/rfc/rfc2060.txt for details.
* A client may want "poll" the folder by occasionally calling the
* <code>getMessageCount</code> or <code>isConnected</code> methods
* to solicit any such notifications.
*
* @author <a href="mailto:dog@gnu.org">Chris Burdess</a>
* @version 1.3
*/
public class MessageCountEvent
extends MailEvent
{
/**
* The messages were added to their folder
*/
public static final int ADDED = 1;
/**
* The messages were removed from their folder
*/
public static final int REMOVED = 2;
/**
* The event type.
*/
protected int type;
/**
* If true, this event is the result of an explicit expunge by this client,
* and the messages in this folder have been renumbered to account for this.
* If false, this event is the result of an expunge by external sources.
*/
protected boolean removed;
/**
* The messages.
*/
protected transient Message[] msgs;
/**
* Constructor.
* @param source The containing folder
* @param type The event type
* @param removed If true, this event is the result of an explicit expunge by
* this client, and the messages in this folder have been renumbered to
* account for this. If false, this event is the result of an expunge by
* external sources.
* @param msgs The messages added/removed
*/
public MessageCountEvent(Folder source, int type, boolean removed,
Message[] msgs)
{
super(source);
this.type = type;
this.removed = removed;
this.msgs = msgs;
}
/**
* Return the type of this event.
*/
public int getType()
{
return type;
}
/**
* Indicates whether this event is the result of an explicit expunge by this
* client, or due to an expunge from external sources. If true, this event is
* due to an explicit expunge and hence all remaining messages in this folder
* have been renumbered. If false, this event is due to an external expunge.
* <p>
* Note that this method is valid only if the type of this event is REMOVED
*/
public boolean isRemoved()
{
return removed;
}
/**
* Return the array of messages added or removed.
*/
public Message[] getMessages()
{
return msgs;
}
/**
* Invokes the appropriate MessageCountListener method.
*/
public void dispatch(Object listener)
{
MessageCountListener l = (MessageCountListener)listener;
switch (type)
{
case ADDED:
l.messagesAdded(this);
break;
case REMOVED:
l.messagesRemoved(this);
break;
}
}
}
|
