パッケージ jakarta.enterprise.inject.spi

インターフェース ObserverMethod<T>

型パラメーター:
T - イベント型
すべてのスーパーインターフェース:
Prioritized
public interface ObserverMethod<T> extends Prioritized

有効な Bean の オブザーバーメソッドを表します。コンテナーがオブザーバーメソッドについて知る必要があるすべてを定義します。

このインターフェースのカスタム実装が notify(Object) または notify(EventContext) のいずれもオーバーライドしない場合、コンテナーは問題を自動的に検出し、それを定義エラーとして扱います。

作成者:
Gavin King, David Allen, Mark Paluch, Antoine Sabot-Durand

  • フィールドの詳細

    • DEFAULT_PRIORITY

      static final int DEFAULT_PRIORITY
      デフォルトのオブザーバー優先度
      関連事項:

  • メソッドの詳細

    • getBeanClass

      ClassSE<?> getBeanClass()

      オブザーバーメソッドを宣言する型のクラスSEを取得します。

      戻り値:
      定義するクラスSE

    • getDeclaringBean

      default Bean<?> getDeclaringBean()

      オブザーバーメソッドを宣言する Bean を取得します。合成オブザーバーの場合、戻り値は未定義です。

      既存のカスタム ObserverMethod 実装との互換性のために、このメソッドはデフォルトで null を返します。

      戻り値:
      Bean の宣言
      導入:
      4.0

    • getObservedType

      TypeSE getObservedType()
      観測されたイベントの型を取得します。
      戻り値:
      観測されたイベント型SE

    • getObservedQualifiers

      SetSE<AnnotationSE> getObservedQualifiers()
      観測されたイベント修飾子のセットを取得します。
      戻り値:
      観測されたイベント修飾子

    • getReception

      Reception getReception()
      オブザーバーメソッドに指定された Reception を取得します。これは、オブザーバーが条件付きであるかどうかを示します。
      戻り値:
      Reception

    • getTransactionPhase

      TransactionPhase getTransactionPhase()
      オブザーバーメソッドに指定された TransactionPhase を取得します。
      戻り値:
      TransactionPhase

    • getPriority

      default int getPriority()
      イベントオブザーバーメソッドが呼び出される通知順序を決定するためにコンテナーによって使用される優先度。
      次で指定:
      インターフェース Prioritized の getPriority 
      戻り値:
      イベントオブザーバーメソッドが呼び出される通知順序を決定するためにコンテナーによって使用される優先度。
      導入:
      2.0

    • notify

      default void notify(T event)

      指定されたイベントオブジェクトを渡して、オブザーバーメソッドを呼び出します。

      カスタムオブザーバーメソッドに対するこのメソッドの実装は、getReception() が Reception.IF_EXISTS を返す場合にメソッドを呼び出すかどうかを決定する責任があります。

      パラメーター:
      event - イベントオブジェクト

    • notify

      default void notify(EventContext<T> eventContext)
      指定されたイベントコンテキストを渡して、オブザーバーメソッドを呼び出します。

      コンテナーは常にこのメソッドを呼び出す必要がありますが、デフォルトの実装は notify(Object) に委譲します。

      カスタムオブザーバーメソッドに対するこのメソッドの実装は、getReception() が Reception.IF_EXISTS を返す場合にメソッドを呼び出すかどうかを決定する責任があります。

      パラメーター:
      eventContext - オブザーバーに通知するために使用される EventContext

    • isAsync

      default boolean isAsync()

      このオブザーバーメソッドが非同期かどうかを判別します

      戻り値:
      メソッドが非同期オブザーバーメソッドである場合（つまり、ObservesAsync で定義されている場合）は true を返し、それ以外の場合は false を返します。