クラス HandlerMethodReturnValueHandlerComposite
java.lang.ObjectSE
org.springframework.messaging.handler.invocation.HandlerMethodReturnValueHandlerComposite
- 実装されたすべてのインターフェース:
AsyncHandlerMethodReturnValueHandler
,HandlerMethodReturnValueHandler
public class HandlerMethodReturnValueHandlerComposite
extends ObjectSE
implements AsyncHandlerMethodReturnValueHandler
ラップして他に委譲する HandlerMethodReturnValueHandler。
- 導入:
- 4.0
- 作成者:
- Rossen Stoyanchev
フィールドサマリー
コンストラクターのサマリー
メソッドのサマリー
修飾子と型メソッド説明addHandler
(HandlerMethodReturnValueHandler returnValueHandler) 指定されたHandlerMethodReturnValueHandler
を追加します。addHandlers
(ListSE<? extends HandlerMethodReturnValueHandler> handlers) 指定されたHandlerMethodReturnValueHandlers
を追加します。void
clear()
構成済みハンドラーのリストをクリアします。現在設定されているロガーを返します。ハンドラーが構成された読み取り専用リストを返します。void
handleReturnValue
(ObjectSE returnValue, MethodParameter returnType, Message<?> message) 指定された戻り値を処理します。boolean
isAsyncReturnValue
(ObjectSE returnValue, MethodParameter returnType) 戻り値が成功とエラーのコールバックを持つ非同期の Future のような型を表すかどうか。void
クラス名に基づいたロガーよりも使用する代替ロガーを設定します。boolean
supportsReturnType
(MethodParameter returnType) 指定されたメソッドの戻り型がこのハンドラーでサポートされているかどうか。toCompletableFuture
(ObjectSE returnValue, MethodParameter returnType) 非同期の戻り値をCompletableFuture
SE に適合させます。クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.messaging.handler.invocation.AsyncHandlerMethodReturnValueHandler から継承されたメソッド
toListenableFuture
フィールドの詳細
defaultLogger
フォールバックロガーでラップするためのパブリック。
コンストラクターの詳細
HandlerMethodReturnValueHandlerComposite
public HandlerMethodReturnValueHandlerComposite()
メソッドの詳細
setLogger
クラス名に基づいたロガーよりも使用する代替ロガーを設定します。- パラメーター:
logger
- 使用するロガー- 導入:
- 5.1
getLogger
現在設定されているロガーを返します。- 導入:
- 5.1
getReturnValueHandlers
ハンドラーが構成された読み取り専用リストを返します。clear
public void clear()構成済みハンドラーのリストをクリアします。addHandler
public HandlerMethodReturnValueHandlerComposite addHandler(HandlerMethodReturnValueHandler returnValueHandler) 指定されたHandlerMethodReturnValueHandler
を追加します。addHandlers
public HandlerMethodReturnValueHandlerComposite addHandlers(@Nullable ListSE<? extends HandlerMethodReturnValueHandler> handlers) 指定されたHandlerMethodReturnValueHandlers
を追加します。supportsReturnType
インターフェースからコピーされた説明:HandlerMethodReturnValueHandler
指定されたメソッドの戻り型がこのハンドラーでサポートされているかどうか。- 次で指定:
- インターフェース
HandlerMethodReturnValueHandler
のsupportsReturnType
- パラメーター:
returnType
- チェックするメソッドの戻り値の型- 戻り値:
- このハンドラーが提供された戻り値の型をサポートする場合、
true
。それ以外の場合はfalse
handleReturnValue
public void handleReturnValue(@Nullable ObjectSE returnValue, MethodParameter returnType, Message<?> message) throws ExceptionSE インターフェースからコピーされた説明:HandlerMethodReturnValueHandler
指定された戻り値を処理します。- 次で指定:
- インターフェース
HandlerMethodReturnValueHandler
のhandleReturnValue
- パラメーター:
returnValue
- ハンドラーメソッドから返された値returnType
- 戻り値の型。この型は以前にHandlerMethodReturnValueHandler.supportsReturnType(org.springframework.core.MethodParameter)
に渡されていて、true
を返している必要があります。message
- このメソッドが呼び出される原因となったメッセージ- 例外:
ExceptionSE
- 戻り値の処理がエラーになる場合
isAsyncReturnValue
インターフェースからコピーされた説明:AsyncHandlerMethodReturnValueHandler
戻り値が成功とエラーのコールバックを持つ非同期の Future のような型を表すかどうか。このメソッドがtrue
を返す場合、次にAsyncHandlerMethodReturnValueHandler.toCompletableFuture(java.lang.Object, org.springframework.core.MethodParameter)
が呼び出されます。false
を返す場合、HandlerMethodReturnValueHandler.handleReturnValue(java.lang.Object, org.springframework.core.MethodParameter, org.springframework.messaging.Message<?>)
が呼び出されます。注意 : このメソッドは、
HandlerMethodReturnValueHandler.supportsReturnType(org.springframework.core.MethodParameter)
が呼び出され、true
が返された後にのみ呼び出されます。- 次で指定:
- インターフェース
AsyncHandlerMethodReturnValueHandler
のisAsyncReturnValue
- パラメーター:
returnValue
- ハンドラーメソッドから返された値returnType
- 戻り値の型- 戻り値:
- 戻り値の型が非同期値を表す場合は
true
toCompletableFuture
@Nullable public CompletableFutureSE<?> toCompletableFuture(ObjectSE returnValue, MethodParameter returnType) インターフェースからコピーされた説明:AsyncHandlerMethodReturnValueHandler
非同期の戻り値をCompletableFuture
SE に適合させます。CompletableFuture が成功またはエラーで完了すると、戻り値の処理が続行されます。
注意 : このメソッドは、
HandlerMethodReturnValueHandler.supportsReturnType(org.springframework.core.MethodParameter)
が呼び出され、true
が返された後にのみ呼び出されます。- 次で指定:
- インターフェース
AsyncHandlerMethodReturnValueHandler
のtoCompletableFuture
- パラメーター:
returnValue
- ハンドラーメソッドから返された値returnType
- 戻り値の型- 戻り値:
- 結果の CompletableFuture、または
null
。この場合、それ以上の処理は実行されません。