クラス ApplicationListenerMethodAdapter
java.lang.ObjectSE
org.springframework.context.event.ApplicationListenerMethodAdapter
- 実装されたすべてのインターフェース:
EventListenerSE
、ApplicationListener<ApplicationEvent>
、GenericApplicationListener
、SmartApplicationListener
、Ordered
public class ApplicationListenerMethodAdapter
extends ObjectSE
implements GenericApplicationListener
イベントの処理を
EventListener
アノテーション付きメソッドに委譲する GenericApplicationListener
アダプター。 サブクラスにデフォルトから逸脱する機会を与えるために processEvent(ApplicationEvent)
に委譲します。必要に応じて PayloadApplicationEvent
のコンテンツをアンラップして、メソッド宣言で任意のイベント型を定義できるようにします。条件が定義されている場合、基礎となるメソッドを呼び出す前に評価されます。
- 導入:
- 4.2
- 作成者:
- Stephane Nicoll, Juergen Hoeller, Sam Brannen, Sebastien Deleuze, Yanming Zhou
フィールドサマリー
フィールドインターフェース org.springframework.core.Ordered から継承されたフィールド
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
コンストラクターのサマリー
コンストラクターコンストラクター説明ApplicationListenerMethodAdapter
(StringSE beanName, ClassSE<?> targetClass, MethodSE method) 新しい ApplicationListenerMethodAdapter を作成します。方法の概要
修飾子と型メソッド説明protected ObjectSE
指定された引数値を使用してイベントリスナーメソッドを呼び出します。protected StringSE
使用する条件を返します。protected StringSE
annotation-specified id value
がない場合に適用される、ターゲットリスナーのデフォルト ID を決定します。protected StringSE
getDetailedErrorMessage
(ObjectSE bean, StringSE message) 指定されたエラーメッセージに、Bean 型やメソッドシグネチャーなどの詳細を追加します。リスナーのオプションの識別子を返します。int
getOrder()
同じイベントの一連のリスナーで、このリスナーの順序を決定します。protected ObjectSE
使用するターゲット Bean インスタンスを返します。protected MethodSE
ターゲットリスナーメソッドを返します。protected void
protected void
handleResult
(ObjectSE result) protected boolean
デフォルトの実行がターゲットリスナーに適用可能かどうかを返します。void
アプリケーションイベントを処理します。void
processEvent
(ApplicationEvent event) 指定されたApplicationEvent
を処理し、条件が一致するかどうかを確認し、null 以外の結果があればそれを処理します。protected ObjectSE[]
resolveArguments
(ApplicationEvent event) 指定されたApplicationEvent
に使用するメソッド引数を解決します。boolean
shouldHandle
(ApplicationEvent event) 条件が一致するかどうかを確認して、リスナーメソッドが指定されたイベントを実際に処理するかどうかを判断します。boolean
supportsEventType
(ResolvableType eventType) このリスナーが特定のイベント型を実際にサポートしているかどうかを判断します。boolean
supportsSourceType
(ClassSE<?> sourceType) このリスナーが特定のソース型を実際にサポートしているかどうかを判断します。toString()
クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, wait, waitSE, waitSE
インターフェース org.springframework.context.ApplicationListener から継承されたメソッド
supportsAsyncExecution
インターフェース org.springframework.context.event.GenericApplicationListener から継承されたメソッド
supportsEventType
フィールドの詳細
logger
コンストラクターの詳細
ApplicationListenerMethodAdapter
新しい ApplicationListenerMethodAdapter を作成します。- パラメーター:
beanName
- リスナーメソッドを呼び出す Bean の名前targetClass
- メソッドが宣言されているターゲットクラスmethod
- 呼び出すリスナーメソッド
メソッドの詳細
onApplicationEvent
インターフェースからコピーされた説明:ApplicationListener
アプリケーションイベントを処理します。- 次で指定:
- インターフェース
ApplicationListener<ApplicationEvent>
のonApplicationEvent
- パラメーター:
event
- 応答するイベント
supportsEventType
インターフェースからコピーされた説明:GenericApplicationListener
このリスナーが特定のイベント型を実際にサポートしているかどうかを判断します。- 次で指定:
- インターフェース
GenericApplicationListener
のsupportsEventType
- パラメーター:
eventType
- イベント型 (非null
)
supportsSourceType
インターフェースからコピーされた説明:SmartApplicationListener
このリスナーが特定のソース型を実際にサポートしているかどうかを判断します。デフォルトの実装は、常に
true
を返します。- 次で指定:
- インターフェース
SmartApplicationListener
のsupportsSourceType
- パラメーター:
sourceType
- ソース型、またはソースがない場合はnull
getOrder
public int getOrder()インターフェースからコピーされた説明:SmartApplicationListener
同じイベントの一連のリスナーで、このリスナーの順序を決定します。デフォルトの実装は
Ordered.LOWEST_PRECEDENCE
を返します。- 次で指定:
- インターフェース
Ordered
のgetOrder
- 次で指定:
- インターフェース
SmartApplicationListener
のgetOrder
- 戻り値:
- オーダー額
- 関連事項:
getListenerId
インターフェースからコピーされた説明:SmartApplicationListener
リスナーのオプションの識別子を返します。デフォルト値は空の文字列です。
getDefaultListenerId
annotation-specified id value
がない場合に適用される、ターゲットリスナーのデフォルト ID を決定します。デフォルトの実装では、パラメーター型を使用してメソッド名を作成します。
- 導入:
- 5.3.5
- 関連事項:
isDefaultExecution
protected boolean isDefaultExecution()デフォルトの実行がターゲットリスナーに適用可能かどうかを返します。processEvent
指定されたApplicationEvent
を処理し、条件が一致するかどうかを確認し、null 以外の結果があればそれを処理します。- パラメーター:
event
- リスナーメソッドを通じて処理するイベント
shouldHandle
条件が一致するかどうかを確認して、リスナーメソッドが指定されたイベントを実際に処理するかどうかを判断します。- パラメーター:
event
- リスナーメソッドを通じて処理するイベント- 導入:
- 6.1
resolveArguments
指定されたApplicationEvent
に使用するメソッド引数を解決します。これらの引数は、このインスタンスによって処理されるメソッドを呼び出すために使用されます。
null
を返して、適切な引数を解決できなかったことを示すことができます。指定されたイベントに対してメソッドをまったく呼び出さないでください。handleResult
handleAsyncError
doInvoke
指定された引数値を使用してイベントリスナーメソッドを呼び出します。getTargetBean
使用するターゲット Bean インスタンスを返します。getTargetMethod
ターゲットリスナーメソッドを返します。- 導入:
- 5.3
getCondition
使用する条件を返します。EventListener
アノテーションのcondition
属性、または@EventListener
でメタアノテーションが付けられた構成済みアノテーションの一致する属性に一致します。getDetailedErrorMessage
指定されたエラーメッセージに、Bean 型やメソッドシグネチャーなどの詳細を追加します。- パラメーター:
message
- HandlerMethod の詳細を追加するエラーメッセージ
toString