001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements.  See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership.  The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance
008     * with the License.  You may obtain a copy of the License at
009     *
010     *  http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing,
013     * software distributed under the License is distributed on an
014     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     * KIND, either express or implied.  See the License for the
016     * specific language governing permissions and limitations
017     * under the License.
018     */
019    
020    package javax.mail.event;
021    
022    import javax.mail.Store;
023    
024    /**
025     * Event representing motifications from the Store connection.
026     *
027     * @version $Rev: 467553 $ $Date: 2006-10-25 00:01:51 -0400 (Wed, 25 Oct 2006) $
028     */
029    public class StoreEvent extends MailEvent {
030        /**
031         * Indicates that this message is an alert.
032         */
033        public static final int ALERT = 1;
034    
035        /**
036         * Indicates that this message is a notice.
037         */
038        public static final int NOTICE = 2;
039    
040        /**
041         * The message type.
042         */
043        protected int type;
044    
045        /**
046         * The text to be presented to the user.
047         */
048        protected String message;
049    
050        /**
051         * Construct a new event.
052         *
053         * @param store   the Store that initiated the notification
054         * @param type    the message type
055         * @param message the text to be presented to the user
056         */
057        public StoreEvent(Store store, int type, String message) {
058            super(store);
059            this.type = type;
060            this.message = message;
061        }
062    
063        /**
064         * Return the message type.
065         *
066         * @return the message type
067         */
068        public int getMessageType() {
069            return type;
070        }
071    
072        /**
073         * Return the text to be displayed to the user.
074         *
075         * @return the text to be displayed to the user
076         */
077        public String getMessage() {
078            return message;
079        }
080    
081        public void dispatch(Object listener) {
082            ((StoreListener) listener).notification(this);
083        }
084    }