FolderEventpublic class FolderEvent extends MailEvent | 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). |
| Fields Summary |
|---|
| public static final int | CREATEDThe folder was created. | | public static final int | DELETEDThe folder was deleted. | | public static final int | RENAMEDThe folder was renamed. | | protected int | typeThe event type. | | protected transient Folder | folderThe folder the event occurred on. | | protected transient Folder | newFolderThe folder that represents the new name, in case of a RENAMED event. | | private static final long | serialVersionUID |
| Constructors Summary |
|---|
public FolderEvent(Object source, Folder folder, int type)Constructor.
this(source, folder, folder, type);
| public FolderEvent(Object source, Folder oldFolder, Folder newFolder, int type)Constructor. Use for RENAMED events.
super(source);
this.folder = oldFolder;
this.newFolder = newFolder;
this.type = type;
|
| Methods Summary |
|---|
| public void | dispatch(java.lang.Object listener)Invokes the appropriate FolderListener method
if (type == CREATED)
((FolderListener)listener).folderCreated(this);
else if (type == DELETED)
((FolderListener)listener).folderDeleted(this);
else if (type == RENAMED)
((FolderListener)listener).folderRenamed(this);
| | public javax.mail.Folder | getFolder()Return the affected folder.
return folder;
| | public javax.mail.Folder | getNewFolder()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 newFolder;
| | public int | getType()Return the type of this event.
return type;
|
|
