Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.mail.event

Class FolderEvent

public 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).

Field Summary

static int
CREATED
The folder was created.
static int
DELETED
The folder was deleted.
static int
RENAMED
The folder was renamed.
protected Folder
folder
The folder the event occurred on.
protected Folder
newFolder
The folder that represents the new name, in case of a RENAMED event.
protected int
type
The event type.

Constructor Summary

FolderEvent(Object source, Folder folder, int type)
Constructor.
FolderEvent(Object source, Folder oldFolder, Folder newFolder, int type)
Constructor.

Method Summary

void
dispatch(Object listener)
Invokes the appropriate FolderListener method.
Folder
getFolder()
Return the affected folder.
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.
int
getType()
Return the type of this event.

Methods inherited from class javax.mail.event.MailEvent

dispatch

Field Details

CREATED

public static final int CREATED
The folder was created.

Field Value:
1

DELETED

public static final int DELETED
The folder was deleted.

Field Value:
2

RENAMED

public static final int RENAMED
The folder was renamed.

Field Value:
3

folder

protected Folder folder
The folder the event occurred on.

newFolder

protected Folder newFolder
The folder that represents the new name, in case of a RENAMED event.

type

protected int type
The event type.

Constructor Details

FolderEvent

public FolderEvent(Object source,
                   Folder folder,
                   int type)
Constructor.

Parameters:
source - The source of the event
folder - The affected folder
type - The event type

FolderEvent

public FolderEvent(Object source,
                   Folder oldFolder,
                   Folder newFolder,
                   int type)
Constructor. Use for RENAMED events.

Parameters:
source - The source of the event
oldFolder - The folder that is renamed
newFolder - The folder that represents the new name
type - The event type

Method Details

dispatch

public void dispatch(Object listener)
Invokes the appropriate FolderListener method.
Overrides:
dispatch in interface MailEvent

getFolder

public Folder getFolder()
Return the affected folder.

See Also:
getNewFolder()

getNewFolder

public 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.

See Also:
getFolder()

getType

public int getType()
Return the type of this event.

Overview Package Tree Index Deprecated About