javax.mail.event
クラス MessageCountEvent

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

public final class MessageCountEvent
extends MailEvent

このクラスはフォルダ内のメッセージ数の変更を通知します。

フォルダタイプによっては、特定の時間又は特定の操作後 の MessageCountEvents の配信しかできない物がある事に注意して下さい。 特に IMAP は、クライアントが新しいコマンドを発行した 時に MessageCountEvents をクライアントに通知するだけです。 詳細については、RFC 2060 を参照して下さい。 クライアントは、必要に応じて getMessageCount 又は isConnected メソッドを呼び出す事により、 フォルダを "ポーリング" して、そうした通知を要求できます。

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

フィールドの概要
static int ADDED
          メッセージがフォルダに追加されました。
protected  Message[] msgs
          メッセージです。
protected  boolean removed
          true の場合、このイベントはこのクライアントにより明示的に削除された結果であり、 このフォルダ内のメッセージの番号は再度割り当てられています。
static int REMOVED
          メッセージがフォルダから削除されました。
protected  int type
          イベントの型です。
 
クラス java.util.EventObject から継承されたフィールド
source
 
コンストラクタの概要
MessageCountEvent(Folder folder, int type, boolean removed, Message[] msgs)
          コンストラクタです。
 
メソッドの概要
 void dispatch(Object listener)
          適切な MessageCountListener メソッドを呼び出します。
 Message[] getMessages()
          追加又は削除されたメッセージの配列を返します。
 int getType()
          このイベントの型を返します。
 boolean isRemoved()
          このイベントが、このクライアントによる明示的な削除の結果なのか、 外部ソースによる削除の結果なのかを示します。
 
クラス java.util.EventObject から継承されたメソッド
getSource, toString
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

フィールドの詳細

ADDED

public static final int ADDED
メッセージがフォルダに追加されました。

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

REMOVED

public static final int REMOVED
メッセージがフォルダから削除されました。

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

type

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


removed

protected boolean removed
true の場合、このイベントはこのクライアントにより明示的に削除された結果であり、 このフォルダ内のメッセージの番号は再度割り当てられています。 false の場合、このイベントは外部ソースによる削除の結果です。


msgs

protected transient Message[] msgs
メッセージです。

コンストラクタの詳細

MessageCountEvent

public MessageCountEvent(Folder folder,
                         int type,
                         boolean removed,
                         Message[] msgs)
コンストラクタです。

パラメータ:
folder - 包含するフォルダ
type - イベントの型
removed - true の場合、このイベントはこのクライアントにより明示的に 削除された結果であり、このフォルダ内のメッセージの番号は再度割り当てられています。 false の場合、このイベントは外部ソースによる削除の結果です。
msgs - 追加/削除されたメッセージ
メソッドの詳細

getType

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

戻り値:

isRemoved

public boolean isRemoved()
このイベントが、このクライアントによる明示的な削除の結果なのか、 外部ソースによる削除の結果なのかを示します。 true の場合、このイベントは明示的な削除の結果であり、 フォルダ内に残っている全てのメッセージの番号は再度割り当てられています。 false の場合、このイベントは外部の削除による結果です。

このメソッドは、このイベントの型が REMOVED の場合にのみ有効である事に注意して下さい。


getMessages

public Message[] getMessages()
追加又は削除されたメッセージの配列を返します。

戻り値:
メッセージの配列

dispatch

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

定義:
クラス MailEvent 内の dispatch