Skip to content

Commit 94d46eb

Browse files
committed
Exclusively mention CompletableFuture instead of ListenableFuture
Closes gh-33805
1 parent e340e45 commit 94d46eb

File tree

2 files changed

+16
-15
lines changed

2 files changed

+16
-15
lines changed

Diff for: spring-aspects/src/main/java/org/springframework/scheduling/aspectj/AnnotationAsyncExecutionAspect.aj

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2016 the original author or authors.
2+
* Copyright 2002-2024 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -28,10 +28,10 @@ import org.springframework.scheduling.annotation.Async;
2828
* <p>This aspect routes methods marked with the {@link Async} annotation as well as methods
2929
* in classes marked with the same. Any method expected to be routed asynchronously must
3030
* return either {@code void}, {@link Future}, or a subtype of {@link Future} (in particular,
31-
* Spring's {@link org.springframework.util.concurrent.ListenableFuture}). This aspect,
32-
* therefore, will produce a compile-time error for methods that violate this constraint
33-
* on the return type. If, however, a class marked with {@code @Async} contains a method
34-
* that violates this constraint, it produces only a warning.
31+
* {@link java.util.concurrent.CompletableFuture}). This aspect, therefore, will produce a
32+
* compile-time error for methods that violate this constraint on the return type. If,
33+
* however, a class marked with {@code @Async} contains a method that violates this
34+
* constraint, it produces only a warning.
3535
*
3636
* <p>This aspect needs to be injected with an implementation of a task-oriented
3737
* {@link java.util.concurrent.Executor} to activate it for a specific thread pool,

Diff for: spring-context/src/main/java/org/springframework/scheduling/annotation/Async.java

+11-10
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2022 the original author or authors.
2+
* Copyright 2002-2024 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -35,17 +35,18 @@
3535
* <p>In terms of target method signatures, any parameter types are supported.
3636
* However, the return type is constrained to either {@code void} or
3737
* {@link java.util.concurrent.Future}. In the latter case, you may declare the
38-
* more specific {@link org.springframework.util.concurrent.ListenableFuture} or
39-
* {@link java.util.concurrent.CompletableFuture} types which allow for richer
40-
* interaction with the asynchronous task and for immediate composition with
41-
* further processing steps.
38+
* more specific {@link java.util.concurrent.CompletableFuture} type which allows
39+
* for richer interaction with the asynchronous task and for immediate composition
40+
* with further processing steps.
4241
*
4342
* <p>A {@code Future} handle returned from the proxy will be an actual asynchronous
44-
* {@code Future} that can be used to track the result of the asynchronous method
45-
* execution. However, since the target method needs to implement the same signature,
46-
* it will have to return a temporary {@code Future} handle that just passes a value
47-
* through: for example, Spring's {@link AsyncResult}, EJB 3.1's {@link jakarta.ejb.AsyncResult},
48-
* or {@link java.util.concurrent.CompletableFuture#completedFuture(Object)}.
43+
* {@code (Completable)Future} that can be used to track the result of the
44+
* asynchronous method execution. However, since the target method needs to implement
45+
* the same signature, it will have to return a temporary {@code Future} handle that
46+
* just passes a value after computation in the execution thread: typically through
47+
* {@link java.util.concurrent.CompletableFuture#completedFuture(Object)}. The
48+
* provided value will be exposed to the caller through the actual asynchronous
49+
* {@code Future} handle at runtime.
4950
*
5051
* @author Juergen Hoeller
5152
* @author Chris Beams

0 commit comments

Comments
 (0)