pexa.client.std.notification.base

クラス AreaNotification

java.lang.Object

java.util.EventObject

pexa.client.std.event.ClientEvent

pexa.client.std.notification.base.AreaNotification

すべての実装されたインタフェース:

java.io.Serializable, Notification, ReferenceSource

public final class AreaNotification
extends ClientEvent
implements Notification

EventManagerに登録されているリスナーに対して配信される Client内の「通知」を表すイベントオブジェクト。 この実装はAreaが送信元となる場合を想定している。

バージョン:

$Revision: 6425 $ $Date:: 2011-05-18 21:13:30 #$

作成者:

morishita

関連項目:

直列化された形式

フィールドのサマリー

クラスから継承されたフィールド java.util.EventObject

source

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
AreaNotification(ClientSession session, java.lang.Object source, NotificationDefinition def, java.util.Map items) コンストラクタ

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	destory() 通知オブジェクトを破棄する
ClientSession	getClientSession() 通知オブジェクトが紐尽く実行セッションを取得する
NotificationDefinition	getDefinition() 通知定義情報を取得する
Reference	getReference(java.lang.String ref) 通知オブジェクトを起点とした参照オブジェクトを取得する
java.lang.Object	getValue(java.lang.String id) イベントパラメータを取得する
boolean	scope(NotificationListener listener) 引数で指定されたリスナがこの通知の届く範囲内であるかを返す
void	setValue(java.lang.String id, java.lang.Object value) 通知パラメータを設定する
ClientEvent	toClientEvent() 通知オブジェクトをClientEventに変換する

クラスから継承されたメソッド pexa.client.std.event.ClientEvent

getCauseEvent, getEventName

クラスから継承されたメソッド java.util.EventObject

getSource, toString

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

AreaNotification

public AreaNotification(ClientSession session,
                        java.lang.Object source,
                        NotificationDefinition def,
                        java.util.Map items)

コンストラクタ

パラメータ:

session - 実行セッション

source - イベントの発生元

eventName - イベント名

params - イベントパラメータ格納マップ

メソッドの詳細

getDefinition

public NotificationDefinition getDefinition()

通知定義情報を取得する

定義:

getDefinition インタフェース内 Notification

戻り値:

通知定義

getValue

public java.lang.Object getValue(java.lang.String id)

イベントパラメータを取得する

定義:

getValue インタフェース内 Notification

パラメータ:

id - 取得したいイベントパラメータ名

戻り値:

パラメータ値

setValue

public void setValue(java.lang.String id,
                     java.lang.Object value)

通知パラメータを設定する

定義:

setValue インタフェース内 Notification

パラメータ:

id - 設定したい通知パラメータ名

value - パラメータ値

toClientEvent

public ClientEvent toClientEvent()

通知オブジェクトをClientEventに変換する

定義:

toClientEvent インタフェース内 Notification

戻り値:

ClientEventに変換されたNotification

destory

public void destory()

通知オブジェクトを破棄する

定義:

destory インタフェース内 Notification

getReference

public Reference getReference(java.lang.String ref)

通知オブジェクトを起点とした参照オブジェクトを取得する

定義:

getReference インタフェース内 ReferenceSource

パラメータ:

ref - 参照記法文字列

戻り値:

参照オブジェクト

getClientSession

public ClientSession getClientSession()

通知オブジェクトが紐尽く実行セッションを取得する

定義:

getClientSession インタフェース内 Notification

戻り値:

実行セッション

scope

public boolean scope(NotificationListener listener)

引数で指定されたリスナがこの通知の届く範囲内であるかを返す

定義:

scope インタフェース内 Notification

パラメータ:

listener - チェック対象のリスナ

戻り値:

リスナが通知範囲内ならtrue