パッケージ jakarta.enterprise.event
インターフェース Event<T>
- 型パラメーター:
T
- イベントオブジェクトの型
public interface Event<T>
特定の型のイベントを起動することをアプリケーションに許可します。
Bean は、
Event
インターフェースのインスタンスを介してイベントを発生させます。@Inject @Any Event<LoggedInEvent> loggedInEvent;
fire()
メソッドは、イベントオブジェクトを受け入れます。public void login() { ... loggedInEvent.fire( new LoggedInEvent(user) ); }
修飾子の任意の組み合わせをインジェクションポイントで指定できます。
@Inject @Admin Event<LoggedInEvent> adminLoggedInEvent;
または、
@Any
修飾子を使用して、アプリケーションで修飾子を動的に指定できます。@Inject @Any Event<LoggedInEvent> loggedInEvent;
注入された
Event
の場合:- 指定された型は、インジェクションポイントで指定された型パラメーター
- 指定された修飾子は、インジェクションポイントで指定された修飾子です。
fireAsync(Object)
およびfireAsync(Object, NotificationOptions)
メソッドを使用して、イベントを非同期に発生させることもできます- 作成者:
- Gavin King, Pete Muir, David Allen, Antoine Sabot-Durand
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 修飾子と型 メソッド 説明 void
fire(T event)
指定された修飾子でイベントを発生させ、オブザーバーに通知します。<U extends T>
CompletionStageSE<U>fireAsync(U event)
指定された修飾子を使用してイベントを非同期に発生させ、非同期オブザーバーに通知します。<U extends T>
CompletionStageSE<U>fireAsync(U event, NotificationOptions options)
指定された修飾子を使用してイベントを非同期に発生させ、非同期オブザーバーに通知します。<U extends T>
Event<U>select(TypeLiteral<U> subtype, AnnotationSE... qualifiers)
指定された必須型および追加の必須修飾子の子Event
を取得します。Event<T>
select(AnnotationSE... qualifiers)
指定された追加の必須修飾子の子Event
を取得します。<U extends T>
Event<U>select(ClassSE<U> subtype, AnnotationSE... qualifiers)
指定された必須型および追加の必須修飾子の子Event
を取得します。
メソッドの詳細
fire
void fire(T event)
指定された修飾子でイベントを発生させ、オブザーバーに通知します。
- パラメーター:
event
- イベントオブジェクト- 例外:
IllegalArgumentExceptionSE
- イベントオブジェクトの実行時型に型変数が含まれる場合ObserverException
- 通知されたオブザーバがチェックされた例外をスローすると、ラップされ、(チェックされていない)ObserverException
として再スローされます
fireAsync
<U extends T> CompletionStageSE<U> fireAsync(U event)
指定された修飾子を使用してイベントを非同期に発生させ、非同期オブザーバーに通知します。
- 型パラメーター:
U
- イベントの型- パラメーター:
event
- イベントオブジェクト- 戻り値:
- 非同期操作でさらにパイプラインを構成できる
CompletionStage
SE。デフォルトの非同期実行機能はコンテナー固有です。このイベントによって通知されたオブザーバーが例外をスローした場合、オブザーバーによって発生したすべての例外を抑制された例外としてラップするCompletionException
SE を使用して、結果の CompletionStage が例外的に完了します。オブザーバーによって例外がスローされない場合、結果の CompletionStage は通常、イベントペイロードで完了します。 - 例外:
IllegalArgumentExceptionSE
- イベントオブジェクトの実行時型に型変数が含まれる場合- 導入:
- 2.0
fireAsync
<U extends T> CompletionStageSE<U> fireAsync(U event, NotificationOptions options)
指定された修飾子を使用してイベントを非同期に発生させ、非同期オブザーバーに通知します。カスタム
Executor
SE を使用して非同期呼び出しを行います- 型パラメーター:
U
- イベントの型- パラメーター:
event
- イベントオブジェクトoptions
- 通知オプション- 戻り値:
- 非同期操作でさらにパイプラインを構成できる
CompletionStage
SE。デフォルトの非同期実行機能はコンテナー固有です。このイベントによって通知されたオブザーバーが例外をスローした場合、オブザーバーによって発生したすべての例外を抑制された例外としてラップするCompletionException
SE を使用して、結果の CompletionStage が例外的に完了します。オブザーバーによって例外がスローされない場合、結果の CompletionStage は通常、イベントペイロードで完了します。 - 例外:
IllegalArgumentExceptionSE
- イベントオブジェクトの実行時型に型変数が含まれる場合- 導入:
- 2.0
select
Event<T> select(AnnotationSE... qualifiers)
指定された追加の必須修飾子の子
Event
を取得します。- パラメーター:
qualifiers
- 追加で指定された修飾子- 戻り値:
- 子
Event
- 例外:
IllegalArgumentExceptionSE
- 同じ非反復修飾子型の 2 つのインスタンス、または修飾子型ではないアノテーションのインスタンスが渡された場合
select
<U extends T> Event<U> select(ClassSE<U> subtype, AnnotationSE... qualifiers)
指定された必須型および追加の必須修飾子の子
Event
を取得します。- 型パラメーター:
U
- 指定された型- パラメーター:
subtype
- 指定された型を表すClass
SEqualifiers
- 追加で指定された修飾子- 戻り値:
- 子
Event
- 例外:
IllegalArgumentExceptionSE
- 同じ非反復修飾子型の 2 つのインスタンス、または修飾子型ではないアノテーションのインスタンスが渡された場合
select
<U extends T> Event<U> select(TypeLiteral<U> subtype, AnnotationSE... qualifiers)
指定された必須型および追加の必須修飾子の子
Event
を取得します。- 型パラメーター:
U
- 指定された型- パラメーター:
subtype
- 指定された型を表すTypeLiteral
qualifiers
- 追加で指定された修飾子- 戻り値:
- 子
Event
- 例外:
IllegalArgumentExceptionSE
- 同じ非反復修飾子型の 2 つのインスタンス、または修飾子型ではないアノテーションのインスタンスが渡された場合