javax.mail.event: public class: FolderEvent

javax.mail.event
public class: FolderEvent [javadoc | source]

java.lang.Object
   java.util.EventObject
      javax.mail.event.MailEvent
         javax.mail.event.FolderEvent

All Implemented Interfaces:
Serializable

version: $ - Rev: 125583 $ $Date: 2005-01-18 19:44:27 -0800 (Tue, 18 Jan 2005) $

Field Summary
public static final int	CREATED
public static final int	DELETED
public static final int	RENAMED
protected transient Folder	folder
protected transient Folder	newFolder
protected int	type

Constructor:

Constructor:
public FolderEvent(Object source, Folder folder, int type) { this(source, folder, null, type); } Constructor other events. Parameters: `source` - the source of the event `folder` - the folder affected `type` - the event type
public FolderEvent(Object source, Folder oldFolder, Folder newFolder, int type) { super(source); folder = oldFolder; this.newFolder = newFolder; this.type = type; } Constructor used for RENAMED events. Parameters: `source` - the source of the event `oldFolder` - the folder that was renamed `newFolder` - the folder with the new name `type` - the event type

 public FolderEvent(Object source,
    Folder folder,
    int type) {
        this(source, folder, null, type);
}

Constructor other events.

Parameters:

source - the source of the event

folder - the folder affected

type - the event type

 public FolderEvent(Object source,
    Folder oldFolder,
    Folder newFolder,
    int type) {
                                         
        super(source);
        folder = oldFolder;
        this.newFolder = newFolder;
        this.type = type;
}

Constructor used for RENAMED events.

Parameters:

source - the source of the event

oldFolder - the folder that was renamed

newFolder - the folder with the new name

type - the event type

Method from javax.mail.event.FolderEvent Summary:
dispatch, getFolder, getNewFolder, getType

Methods from javax.mail.event.MailEvent:
dispatch

Methods from java.util.EventObject:
getSource, toString

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.mail.event.FolderEvent Detail:
public void dispatch(Object listener) { FolderListener l = (FolderListener) listener; switch (type) { case CREATED: l.folderCreated(this); break; case DELETED: l.folderDeleted(this); break; case RENAMED: l.folderRenamed(this); break; default: throw new IllegalArgumentException("Invalid type " + type); } }
public Folder getFolder() { return folder; } Return the affected folder.
public Folder getNewFolder() { return newFolder; } Return the new folder; only applicable to RENAMED events.
public int getType() { return type; } Return the event type.

Method from javax.mail.event.FolderEvent Detail:

 public  void dispatch(Object listener) {
        FolderListener l = (FolderListener) listener;
        switch (type) {
        case CREATED:
            l.folderCreated(this);
            break;
        case DELETED:
            l.folderDeleted(this);
            break;
        case RENAMED:
            l.folderRenamed(this);
            break;
        default:
            throw new IllegalArgumentException("Invalid type " + type);
        }
}

 public Folder getFolder() {
        return folder;
}

Return the affected folder.

 public Folder getNewFolder() {
        return newFolder;
}

Return the new folder; only applicable to RENAMED events.

 public int getType() {
        return type;
}

Return the event type.