001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036:
037: /*
038: * @(#)FolderEvent.java 1.13 07/05/04
039: */
040:
041: package javax.mail.event;
042:
043: import java.util.*;
044: import javax.mail.*;
045:
046: /**
047: * This class models Folder <em>existence</em> events. FolderEvents are
048: * delivered to FolderListeners registered on the affected Folder as
049: * well as the containing Store. <p>
050: *
051: * Service providers vary widely in their ability to notify clients of
052: * these events. At a minimum, service providers must notify listeners
053: * registered on the same Store or Folder object on which the operation
054: * occurs. Service providers may also notify listeners when changes
055: * are made through operations on other objects in the same virtual
056: * machine, or by other clients in the same or other hosts. Such
057: * notifications are not required and are typically not supported
058: * by mail protocols (including IMAP).
059: *
060: * @author John Mani
061: * @author Bill Shannon
062: */
063:
064: public class FolderEvent extends MailEvent {
065:
066: /** The folder was created. */
067: public static final int CREATED = 1;
068: /** The folder was deleted. */
069: public static final int DELETED = 2;
070: /** The folder was renamed. */
071: public static final int RENAMED = 3;
072:
073: /**
074: * The event type.
075: *
076: * @serial
077: */
078: protected int type;
079:
080: /**
081: * The folder the event occurred on.
082: */
083: transient protected Folder folder;
084:
085: /**
086: * The folder that represents the new name, in case of a RENAMED event.
087: *
088: * @since JavaMail 1.1
089: */
090: transient protected Folder newFolder;
091:
092: private static final long serialVersionUID = 5278131310563694307L;
093:
094: /**
095: * Constructor. <p>
096: *
097: * @param source The source of the event
098: * @param folder The affected folder
099: * @param type The event type
100: */
101: public FolderEvent(Object source, Folder folder, int type) {
102: this (source, folder, folder, type);
103: }
104:
105: /**
106: * Constructor. Use for RENAMED events.
107: *
108: * @param source The source of the event
109: * @param oldFolder The folder that is renamed
110: * @param newFolder The folder that represents the new name
111: * @param type The event type
112: * @since JavaMail 1.1
113: */
114: public FolderEvent(Object source, Folder oldFolder,
115: Folder newFolder, int type) {
116: super (source);
117: this .folder = oldFolder;
118: this .newFolder = newFolder;
119: this .type = type;
120: }
121:
122: /**
123: * Return the type of this event.
124: *
125: * @return type
126: */
127: public int getType() {
128: return type;
129: }
130:
131: /**
132: * Return the affected folder.
133: *
134: * @return the affected folder
135: * @see #getNewFolder
136: */
137: public Folder getFolder() {
138: return folder;
139: }
140:
141: /**
142: * If this event indicates that a folder is renamed, (i.e, the event type
143: * is RENAMED), then this method returns the Folder object representing the
144: * new name. <p>
145: *
146: * The <code>getFolder()</code> method returns the folder that is renamed.
147: *
148: * @return Folder representing the new name.
149: * @see #getFolder
150: * @since JavaMail 1.1
151: */
152: public Folder getNewFolder() {
153: return newFolder;
154: }
155:
156: /**
157: * Invokes the appropriate FolderListener method
158: */
159: public void dispatch(Object listener) {
160: if (type == CREATED)
161: ((FolderListener) listener).folderCreated(this );
162: else if (type == DELETED)
163: ((FolderListener) listener).folderDeleted(this );
164: else if (type == RENAMED)
165: ((FolderListener) listener).folderRenamed(this);
166: }
167: }
|