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 Details

    • HandlerResult

      public HandlerResult(Object handler, @Nullable Object returnValue, 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, 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 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 MethodParameter getReturnTypeSource()
      Return the MethodParameter from which returnType was created.

    • getBindingContext

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

    • getModel

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

    • setExceptionHandler

      public HandlerResult setExceptionHandler(DispatchExceptionHandler exceptionHandler)
      A HandlerAdapter may use this to provide an exception handler to use to map exceptions from handling this result into an alternative one. Especially when the return value is asynchronous, an exception is not be produced at the point of handler invocation, but rather later when result handling causes the actual value or an exception to be produced.
      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)
      Configure an exception handler that may be used to produce an alternative result when result handling fails. Especially for an async return value errors may occur after the invocation of the handler.
      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