Spring Framework 6.1.4 · org.springframework.web.reactive.HandlerResult

Modifier and Type	Field and Description
private final BindingContext	bindingContext
private DispatchExceptionHandler	exceptionHandler
private Function<Throwable, Mono<HandlerResult>>	exceptionHandlerFunction
private final Object	handler
private final ResolvableType	returnType
private final Object	returnValue

Constructor Summary

Access	Constructor and Description
public	HandlerResult(Object the handler that handled the request handler, Object the return value from the handler possibly `null` returnValue, MethodParameter the return value type returnType) Create a new `HandlerResult`.
public	HandlerResult(Object the handler that handled the request handler, Object the return value from the handler possibly `null` returnValue, MethodParameter the return value type returnType, BindingContext the binding context used for request handling context) Create a new `HandlerResult`.

Method Summary

Modifier and Type	Method and Description
public Mono<HandlerResult>	Returns: the new result or the same error if there is no exception handler applyExceptionHandler(Throwable the exception failure) Deprecated for removal since 6.0. without a replacement; for internal invocation only, not used as of 6.0 Apply the exception handler and return the alternative result.
public BindingContext	getBindingContext() Return the BindingContext used for request handling.
public DispatchExceptionHandler	getExceptionHandler() Return the `configured` exception handler.
public Object	getHandler() Return the handler that handled the request.
public Model	getModel() Return the model used for request handling.
public ResolvableType	getReturnType() Return the type of the value returned from the handler -- e.g. the return type declared on a controller method's signature.
public MethodParameter	getReturnTypeSource() Return the `MethodParameter` from which `returnType` was created.
public Object	getReturnValue() Return the value returned from the handler, if any.
public boolean	hasExceptionHandler() Deprecated for removal since 6.0. in favor of checking via `getExceptionHandler()` Whether there is an exception handler.
public HandlerResult	setExceptionHandler(DispatchExceptionHandler the exception handler to use exceptionHandler) `HandlerAdapter` classes can set this to have their exception handling mechanism applied to response rendering and to deferred exceptions when invoking a handler with an asynchronous return value.
public HandlerResult	Returns: the current instance setExceptionHandler(Function<Throwable, Mono<HandlerResult>> the error handler function) Deprecated for removal since 6.0. in favor of `setExceptionHandler(DispatchExceptionHandler)` `HandlerAdapter` classes can set this to have their exception handling mechanism applied to response rendering and to deferred exceptions when invoking a handler with an asynchronous return value.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

bindingContext	back to summary
private final BindingContext bindingContext

exceptionHandler	back to summary
private DispatchExceptionHandler exceptionHandler Annotations @Nullable

exceptionHandlerFunction	back to summary
private Function<Throwable, Mono<HandlerResult>> exceptionHandlerFunction Annotations @Nullable

handler	back to summary
private final Object handler

returnType	back to summary
private final ResolvableType returnType

returnValue	back to summary
private final Object returnValue Annotations @Nullable

Constructor Detail

HandlerResult back to summary

HandlerResult	back to summary
public HandlerResult(Object handler, Object returnValue, MethodParameter returnType) Create a new `HandlerResult`. Parameters handler:Object the handler that handled the request returnValue:Object the return value from the handler possibly `null` returnType:MethodParameter the return value type

public HandlerResult(Object handler, Object returnValue, MethodParameter returnType)

Create a new HandlerResult.

Parameters

handler:Object: the handler that handled the request
returnValue:Object: the return value from the handler possibly null
returnType:MethodParameter: the return value type

HandlerResult back to summary

HandlerResult	back to summary
public HandlerResult(Object handler, Object returnValue, MethodParameter returnType, BindingContext context) Create a new `HandlerResult`. Parameters handler:Object the handler that handled the request returnValue:Object the return value from the handler possibly `null` returnType:MethodParameter the return value type context:BindingContext the binding context used for request handling

public HandlerResult(Object handler, Object returnValue, MethodParameter returnType, BindingContext context)

Create a new HandlerResult.

Parameters

handler:Object: the handler that handled the request
returnValue:Object: the return value from the handler possibly null
returnType:MethodParameter: the return value type
context:BindingContext: the binding context used for request handling

Method Detail

applyExceptionHandler	back to summary
public Mono<HandlerResult> applyExceptionHandler(Throwable failure) Deprecated for removal since 6.0. without a replacement; for internal invocation only, not used as of 6.0 Apply the exception handler and return the alternative result. Parameters failure:Throwable the exception Returns:Mono<HandlerResult> the new result or the same error if there is no exception handler Annotations @Deprecated since:6.0 forRemoval:true

applyExceptionHandler

back to summary

public Mono<HandlerResult> applyExceptionHandler(Throwable failure)

Deprecated

for removal since 6.0.

without a replacement; for internal invocation only, not used as of 6.0

Apply the exception handler and return the alternative result.

Parameters

failure:Throwable: the exception

Returns:Mono<HandlerResult>

the new result or the same error if there is no exception handler

Annotations

@Deprecated
since:6.0
forRemoval:true

getBindingContext	back to summary
public BindingContext getBindingContext() Return the BindingContext used for request handling.

getExceptionHandler back to summary

getExceptionHandler	back to summary
public DispatchExceptionHandler getExceptionHandler() Return the `configured` exception handler. Annotations @Nullable Since 6.0

public DispatchExceptionHandler getExceptionHandler()

Return the configured exception handler.

Annotations

@Nullable

Since

6.0

getHandler	back to summary
public Object getHandler() Return the handler that handled the request.

getModel	back to summary
public Model getModel() Return the model used for request handling. This is a shortcut for `getBindingContext().getModel()`.

getReturnType	back to summary
public ResolvableType getReturnType() Return the type of the value returned from the handler -- e.g. the return type declared on a controller method's signature. Also see `getReturnTypeSource()` to obtain the underlying `MethodParameter` for the return type.

getReturnTypeSource	back to summary
public MethodParameter getReturnTypeSource() Return the `MethodParameter` from which `returnType` was created.

getReturnValue	back to summary
public Object getReturnValue() Return the value returned from the handler, if any. Annotations @Nullable

getReturnValue

back to summary

public Object getReturnValue()

Return the value returned from the handler, if any.

Annotations

@Nullable

hasExceptionHandler back to summary

hasExceptionHandler	back to summary
public boolean hasExceptionHandler() Deprecated for removal since 6.0. in favor of checking via `getExceptionHandler()` Whether there is an exception handler. Annotations @Deprecated since:6.0 forRemoval:true

public boolean hasExceptionHandler()

Deprecated

for removal since 6.0.

in favor of checking via getExceptionHandler()

Whether there is an exception handler.

Annotations

@Deprecated
since:6.0
forRemoval:true

setExceptionHandler back to summary

setExceptionHandler	back to summary
public HandlerResult setExceptionHandler(DispatchExceptionHandler exceptionHandler) `HandlerAdapter` classes can set this to have their exception handling mechanism applied to response rendering and to deferred exceptions when invoking a handler with an asynchronous return value. Parameters exceptionHandler:DispatchExceptionHandler the exception handler to use Since 6.0

public HandlerResult setExceptionHandler(DispatchExceptionHandler exceptionHandler)

HandlerAdapter classes can set this to have their exception handling mechanism applied to response rendering and to deferred exceptions when invoking a handler with an asynchronous return value.

Parameters

exceptionHandler:DispatchExceptionHandler: the exception handler to use

Since

6.0

setExceptionHandler back to summary

setExceptionHandler	back to summary
public HandlerResult setExceptionHandler(Function<Throwable, Mono<HandlerResult>> function) Deprecated for removal since 6.0. in favor of `setExceptionHandler(DispatchExceptionHandler)` `HandlerAdapter` classes can set this to have their exception handling mechanism applied to response rendering and to deferred exceptions when invoking a handler with an asynchronous return value. Parameters function:Function<Throwable, Mono<HandlerResult>> the error handler Returns:HandlerResult the current instance Annotations @Deprecated since:6.0 forRemoval:true

public HandlerResult setExceptionHandler(Function<Throwable, Mono<HandlerResult>> function)

Deprecated

for removal since 6.0.

in favor of setExceptionHandler(DispatchExceptionHandler)

HandlerAdapter classes can set this to have their exception handling mechanism applied to response rendering and to deferred exceptions when invoking a handler with an asynchronous return value.

Parameters

function:Function<Throwable, Mono<HandlerResult>>: the error handler

Returns:HandlerResult

the current instance

Annotations

@Deprecated
since:6.0
forRemoval:true

public Class HandlerResult

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail