Package org.springframework.messaging.handler.invocation

Class ListenableFutureReturnValueHandler

java.lang.Object

org.springframework.messaging.handler.invocation.AbstractAsyncReturnValueHandler

org.springframework.messaging.handler.invocation.ListenableFutureReturnValueHandler

All Implemented Interfaces:

AsyncHandlerMethodReturnValueHandler, HandlerMethodReturnValueHandler

@Deprecated(since="6.0",
            forRemoval=true)
public class ListenableFutureReturnValueHandler
extends AbstractAsyncReturnValueHandler

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

as of 6.0, in favor of CompletableFutureReturnValueHandler

Support for ListenableFuture as a return value type.

Since:

4.2

Author:

Sebastien Deleuze

Constructor Summary

Constructors

Constructor	Description
ListenableFutureReturnValueHandler()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
boolean	supportsReturnType(MethodParameter returnType)	Deprecated, for removal: This API element is subject to removal in a future version. Whether the given method return type is supported by this handler.
CompletableFuture<?>	toCompletableFuture(Object returnValue, MethodParameter returnType)	Deprecated, for removal: This API element is subject to removal in a future version. Adapt the asynchronous return value to a CompletableFuture.
ListenableFuture<?>	toListenableFuture(Object returnValue, MethodParameter returnType)	Deprecated, for removal: This API element is subject to removal in a future version. Adapt the asynchronous return value to a ListenableFuture.

Methods inherited from class org.springframework.messaging.handler.invocation.AbstractAsyncReturnValueHandler

handleReturnValue, isAsyncReturnValue

Methods inherited from class java.lang.Object

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

Constructor Details

ListenableFutureReturnValueHandler

public ListenableFutureReturnValueHandler()

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

Method Details

supportsReturnType

public boolean supportsReturnType(MethodParameter returnType)

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

Description copied from interface: HandlerMethodReturnValueHandler

Whether the given method return type is supported by this handler.

Parameters:

returnType - the method return type to check

Returns:

true if this handler supports the supplied return type; false otherwise

toListenableFuture

public ListenableFuture<?> toListenableFuture(Object returnValue,
 MethodParameter returnType)

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

Description copied from interface: AsyncHandlerMethodReturnValueHandler

Adapt the asynchronous return value to a ListenableFuture.

Implementations should consider returning an instance of SettableListenableFuture. Return value handling will then continue when the ListenableFuture is completed with either success or error.

Note: this method will only be invoked after HandlerMethodReturnValueHandler.supportsReturnType(org.springframework.core.MethodParameter) is called and it returns true.

Parameters:

returnValue - the value returned from the handler method

returnType - the type of the return value

Returns:

the resulting ListenableFuture, or null in which case no further handling will be performed

toCompletableFuture

public CompletableFuture<?> toCompletableFuture(Object returnValue,
 MethodParameter returnType)

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

Description copied from interface: AsyncHandlerMethodReturnValueHandler

Adapt the asynchronous return value to a CompletableFuture.

Return value handling will then continue when the CompletableFuture is completed with either success or error.

Note: this method will only be invoked after HandlerMethodReturnValueHandler.supportsReturnType(org.springframework.core.MethodParameter) is called and it returns true.

Parameters:

returnValue - the value returned from the handler method

returnType - the type of the return value

Returns:

the resulting CompletableFuture, or null in which case no further handling will be performed