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