1 /**
2 *
3 * Copyright 2003-2006 The Apache Software Foundation
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package javax.mail.event;
19
20 import javax.mail.Store;
21
22 /**
23 * Event representing motifications from the Store connection.
24 *
25 * @version $Rev: 421852 $ $Date: 2006-07-14 03:02:19 -0700 (Fri, 14 Jul 2006) $
26 */
27 public class StoreEvent extends MailEvent {
28 /**
29 * Indicates that this message is an alert.
30 */
31 public static final int ALERT = 1;
32
33 /**
34 * Indicates that this message is a notice.
35 */
36 public static final int NOTICE = 2;
37
38 /**
39 * The message type.
40 */
41 protected int type;
42
43 /**
44 * The text to be presented to the user.
45 */
46 protected String message;
47
48 /**
49 * Construct a new event.
50 *
51 * @param store the Store that initiated the notification
52 * @param type the message type
53 * @param message the text to be presented to the user
54 */
55 public StoreEvent(Store store, int type, String message) {
56 super(store);
57 this.type = type;
58 this.message = message;
59 }
60
61 /**
62 * Return the message type.
63 *
64 * @return the message type
65 */
66 public int getMessageType() {
67 return type;
68 }
69
70 /**
71 * Return the text to be displayed to the user.
72 *
73 * @return the text to be displayed to the user
74 */
75 public String getMessage() {
76 return message;
77 }
78
79 public void dispatch(Object listener) {
80 ((StoreListener) listener).notification(this);
81 }
82 }