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: 920714 $ $Date: 2010-03-09 01:55:49 -0500 (Tue, 09 Mar 2010) $
028     */
029    public class StoreEvent extends MailEvent {
030            
031            private static final long serialVersionUID = 1938704919992515330L;
032            
033        /**
034         * Indicates that this message is an alert.
035         */
036        public static final int ALERT = 1;
037    
038        /**
039         * Indicates that this message is a notice.
040         */
041        public static final int NOTICE = 2;
042    
043        /**
044         * The message type.
045         */
046        protected int type;
047    
048        /**
049         * The text to be presented to the user.
050         */
051        protected String message;
052    
053        /**
054         * Construct a new event.
055         *
056         * @param store   the Store that initiated the notification
057         * @param type    the message type
058         * @param message the text to be presented to the user
059         */
060        public StoreEvent(Store store, int type, String message) {
061            super(store);
062            this.type = type;
063            this.message = message;
064        }
065    
066        /**
067         * Return the message type.
068         *
069         * @return the message type
070         */
071        public int getMessageType() {
072            return type;
073        }
074    
075        /**
076         * Return the text to be displayed to the user.
077         *
078         * @return the text to be displayed to the user
079         */
080        public String getMessage() {
081            return message;
082        }
083    
084        public void dispatch(Object listener) {
085            ((StoreListener) listener).notification(this);
086        }
087    }