001/*
002 * Copyright 2002-2017 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.messaging.handler.invocation;
018
019import java.util.concurrent.CompletableFuture;
020import java.util.concurrent.CompletionStage;
021
022import org.springframework.core.MethodParameter;
023import org.springframework.util.concurrent.CompletableToListenableFutureAdapter;
024import org.springframework.util.concurrent.ListenableFuture;
025
026/**
027 * Support for {@link CompletableFuture} (and as of 4.3.7 also {@link CompletionStage})
028 * as a return value type.
029 *
030 * @author Sebastien Deleuze
031 * @author Juergen Hoeller
032 * @since 4.2
033 */
034public class CompletableFutureReturnValueHandler extends AbstractAsyncReturnValueHandler {
035
036        @Override
037        public boolean supportsReturnType(MethodParameter returnType) {
038                return CompletionStage.class.isAssignableFrom(returnType.getParameterType());
039        }
040
041        @Override
042        @SuppressWarnings("unchecked")
043        public ListenableFuture<?> toListenableFuture(Object returnValue, MethodParameter returnType) {
044                return new CompletableToListenableFutureAdapter<>((CompletionStage<Object>) returnValue);
045        }
046
047}