javax.mail.event
クラス FolderEvent

java.lang.Object
  上位を拡張 java.util.EventObject
      上位を拡張 javax.mail.event.MailEvent
          上位を拡張 javax.mail.event.FolderEvent
すべての実装されたインタフェース:
Serializable

public final class FolderEvent
extends MailEvent

このクラスは Folder 存在イベントをモデル化します。 FolderEvent は、影響を受ける Folder と包含する Store に登録 された FolderListeners に配信されます。

サービスプロバイダによって、これらのイベントをクライアントに通知する能力は様々です。 最低でもサービスプロバイダは、操作が発生する同じ Store 又は Folder に 登録されたリスナーに通知しなければなりません。 又、サービスプロバイダは、同じ仮想マシン内の他のオブジェクト上の操作か、 同一又はホスト内の他のクライアントにより変更が行われた場合、リスナーに通知可能です。 こうした通知は必須ではなく、通常メールプロトコル (IMAP を含む) によりサポートされません。

関連項目:
直列化された形式

フィールドの概要
static int CREATED
          フォルダが作成されました。
static int DELETED
          フォルダが削除されました。
protected  Folder folder
          イベントが発生したフォルダです。
protected  Folder newFolder
          RENAMED イベントの場合、新しい名前を表すフォルダです。
static int RENAMED
          フォルダの名前が変更されました。
protected  int type
          イベントの型です。
 
クラス java.util.EventObject から継承されたフィールド
source
 
コンストラクタの概要
FolderEvent(Object source, Folder oldFolder, Folder newFolder, int type)
          コンストラクタです。
FolderEvent(Object source, Folder folder, int type)
          コンストラクタです。
 
メソッドの概要
 void dispatch(Object listener)
          適切な FolderListener メソッドを呼び出します。
 Folder getFolder()
          影響を受けるフォルダを返します。
 Folder getNewFolder()
          このイベントがフォルダの名前変更を示す (つまり、イベントの型が RENAMED である) 場合、 このメソッドは新しい名前を表す Folder オブジェクトを返します。
 int getType()
          このイベントの型を返します。
 
クラス java.util.EventObject から継承されたメソッド
getSource, toString
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

フィールドの詳細

CREATED

public static final int CREATED
フォルダが作成されました。

関連項目:
定数フィールド値

DELETED

public static final int DELETED
フォルダが削除されました。

関連項目:
定数フィールド値

RENAMED

public static final int RENAMED
フォルダの名前が変更されました。

関連項目:
定数フィールド値

type

protected int type
イベントの型です。


folder

protected transient Folder folder
イベントが発生したフォルダです。


newFolder

protected transient Folder newFolder
RENAMED イベントの場合、新しい名前を表すフォルダです。

導入されたバージョン:
JavaMail 1.1
コンストラクタの詳細

FolderEvent

public FolderEvent(Object source,
                   Folder folder,
                   int type)
コンストラクタです。

パラメータ:
source - このイベントのソース
folder - 影響を受けるフォルダ
type - イベントの型

FolderEvent

public FolderEvent(Object source,
                   Folder oldFolder,
                   Folder newFolder,
                   int type)
コンストラクタです。RENAMED イベントに使用します。

パラメータ:
source - このイベントのソース
oldFolder - 名前を変更されるフォルダ
newFolder - 新しい名前を表すフォルダ
type - イベントの型
導入されたバージョン:
JavaMail 1.1
メソッドの詳細

getType

public int getType()
このイベントの型を返します。

戻り値:

getFolder

public Folder getFolder()
影響を受けるフォルダを返します。

戻り値:
影響を受けるフォルダ
関連項目:
getNewFolder()

getNewFolder

public Folder getNewFolder()
このイベントがフォルダの名前変更を示す (つまり、イベントの型が RENAMED である) 場合、 このメソッドは新しい名前を表す Folder オブジェクトを返します。

getFolder() メソッドは名前が変更されるフォルダを返します。

戻り値:
新しい名前を表すフォルダ
導入されたバージョン:
JavaMail 1.1
関連項目:
getFolder()

dispatch

public void dispatch(Object listener)
適切な FolderListener メソッドを呼び出します。

定義:
クラス MailEvent 内の dispatch