javax.mail.event

Class FolderEvent


public class FolderEvent
extends MailEvent

A folder event.
Version:
1.4
Author:
Chris Burdess

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 representing the new name, in the 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 for RENAMED events.

Method Summary

void
dispatch(Object listener)
Invokes the appropriate listener method.
Folder
getFolder()
Returns the affected folder.
Folder
getNewFolder()
Returns the folder representing the new name, in the case of a RENAMED event.
int
getType()
Returns 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 representing the new name, in the 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
folder - the affected folder
type - the event type (CREATED or DELETED)

FolderEvent

public FolderEvent(Object source,
                   Folder oldFolder,
                   Folder newFolder,
                   int type)
Constructor for RENAMED events.
Parameters:
source - the source
oldFolder - the folder that is renamed
newFolder - the folder that represents the new name
type - the event type (RENAMED)

Method Details

dispatch

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

getFolder

public Folder getFolder()
Returns the affected folder.

getNewFolder

public Folder getNewFolder()
Returns the folder representing the new name, in the case of a RENAMED event.
See Also:
getFolder()

getType

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

© Copyright 2003, 2004 The Free Software Foundation, All rights reserved