All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.mail.event.FolderEvent Maven / Gradle / Ivy

There is a newer version: 1.6.2
Show newest version
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package javax.mail.event;

import java.util.*;
import javax.mail.*;

/**
 * This class models Folder existence events. FolderEvents are
 * delivered to FolderListeners registered on the affected Folder as
 * well as the containing Store. 

* * Service providers vary widely in their ability to notify clients of * these events. At a minimum, service providers must notify listeners * registered on the same Store or Folder object on which the operation * occurs. Service providers may also notify listeners when changes * are made through operations on other objects in the same virtual * machine, or by other clients in the same or other hosts. Such * notifications are not required and are typically not supported * by mail protocols (including IMAP). * * @author John Mani * @author Bill Shannon */ public class FolderEvent extends MailEvent { /** The folder was created. */ public static final int CREATED = 1; /** The folder was deleted. */ public static final int DELETED = 2; /** The folder was renamed. */ public static final int RENAMED = 3; /** * The event type. * * @serial */ protected int type; /** * The folder the event occurred on. */ transient protected Folder folder; /** * The folder that represents the new name, in case of a RENAMED event. * * @since JavaMail 1.1 */ transient protected Folder newFolder; private static final long serialVersionUID = 5278131310563694307L; /** * Constructor.

* * @param source The source of the event * @param folder The affected folder * @param type The event type */ public FolderEvent(Object source, Folder folder, int type) { this(source, folder, folder, type); } /** * Constructor. Use for RENAMED events. * * @param source The source of the event * @param oldFolder The folder that is renamed * @param newFolder The folder that represents the new name * @param type The event type * @since JavaMail 1.1 */ public FolderEvent(Object source, Folder oldFolder, Folder newFolder, int type) { super(source); this.folder = oldFolder; this.newFolder = newFolder; this.type = type; } /** * Return the type of this event. * * @return type */ public int getType() { return type; } /** * Return the affected folder. * * @return the affected folder * @see #getNewFolder */ public Folder getFolder() { return folder; } /** * If this event indicates that a folder is renamed, (i.e, the event type * is RENAMED), then this method returns the Folder object representing the * new name.

* * The getFolder() method returns the folder that is renamed. * * @return Folder representing the new name. * @see #getFolder * @since JavaMail 1.1 */ public Folder getNewFolder() { return newFolder; } /** * Invokes the appropriate FolderListener method */ public void dispatch(Object listener) { if (type == CREATED) ((FolderListener)listener).folderCreated(this); else if (type == DELETED) ((FolderListener)listener).folderDeleted(this); else if (type == RENAMED) ((FolderListener)listener).folderRenamed(this); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy