Package org.springframework.web.reactive

Class HandlerResult

java.lang.Object

org.springframework.web.reactive.HandlerResult

public class HandlerResult
extends Object

Represent the result of the invocation of a handler or a handler method.

Since:

5.0

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor	Description
HandlerResult(Object handler, Object returnValue, org.springframework.core.MethodParameter returnType)	Create a new HandlerResult.
HandlerResult(Object handler, Object returnValue, org.springframework.core.MethodParameter returnType, BindingContext context)	Create a new HandlerResult.

Method Summary

Modifier and Type	Method	Description
reactor.core.publisher.Mono<HandlerResult>	applyExceptionHandler(Throwable failure)	Deprecated, for removal: This API element is subject to removal in a future version. without a replacement; for internal invocation only, not used as of 6.0
BindingContext	getBindingContext()	Return the BindingContext used for request handling.
DispatchExceptionHandler	getExceptionHandler()	Return the configured exception handler.
Object	getHandler()	Return the handler that handled the request.
org.springframework.ui.Model	getModel()	Return the model used for request handling.
org.springframework.core.ResolvableType	getReturnType()	Return the type of the value returned from the handler -- e.g.
org.springframework.core.MethodParameter	getReturnTypeSource()	Return the MethodParameter from which returnType was created.
Object	getReturnValue()	Return the value returned from the handler, if any.
boolean	hasExceptionHandler()	Deprecated, for removal: This API element is subject to removal in a future version. in favor of checking via getExceptionHandler()
HandlerResult	setExceptionHandler(Function<Throwable,reactor.core.publisher.Mono<HandlerResult>> function)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of setExceptionHandler(DispatchExceptionHandler)
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HandlerResult

public HandlerResult(Object handler,
 @Nullable
 Object returnValue,
 org.springframework.core.MethodParameter returnType)

Create a new HandlerResult.

Parameters:

handler - the handler that handled the request

returnValue - the return value from the handler possibly null

returnType - the return value type

HandlerResult

public HandlerResult(Object handler,
 @Nullable
 Object returnValue,
 org.springframework.core.MethodParameter returnType,
 @Nullable
 BindingContext context)

Create a new HandlerResult.

Parameters:

handler - the handler that handled the request

returnValue - the return value from the handler possibly null

returnType - the return value type

context - the binding context used for request handling

Method Details

getHandler

public Object getHandler()

Return the handler that handled the request.

getReturnValue

@Nullable
public Object getReturnValue()

Return the value returned from the handler, if any.

getReturnType

public org.springframework.core.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

public org.springframework.core.MethodParameter getReturnTypeSource()

Return the MethodParameter from which returnType was created.

getBindingContext

public BindingContext getBindingContext()

Return the BindingContext used for request handling.

getModel

public org.springframework.ui.Model getModel()

Return the model used for request handling. This is a shortcut for getBindingContext().getModel().

setExceptionHandler

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 - the exception handler to use

Since:

6.0

getExceptionHandler

@Nullable
public DispatchExceptionHandler getExceptionHandler()

Return the configured exception handler.

Since:

6.0

setExceptionHandler

@Deprecated(since="6.0",
            forRemoval=true)
public HandlerResult setExceptionHandler(Function<Throwable,reactor.core.publisher.Mono<HandlerResult>> function)

Deprecated, for removal: This API element is subject to removal in a future version.

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 - the error handler

Returns:

the current instance

hasExceptionHandler

@Deprecated(since="6.0",
            forRemoval=true)
public boolean hasExceptionHandler()

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of checking via getExceptionHandler()

Whether there is an exception handler.

applyExceptionHandler

@Deprecated(since="6.0",
            forRemoval=true)
public reactor.core.publisher.Mono<HandlerResult> applyExceptionHandler(Throwable failure)

Deprecated, for removal: This API element is subject to removal in a future version.

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

Apply the exception handler and return the alternative result.

Parameters:

failure - the exception

Returns:

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