From 16a7d7b1dbd2b84cee3cbb7253f1d96d6f7fe47f Mon Sep 17 00:00:00 2001
From: Jerry Lee <oldratlee@gmail.com>
Date: Mon, 22 Jul 2024 19:26:10 +0800
Subject: [PATCH] refactor: rename parameter; revise javadoc.

---
 .../foldright/cffu/ListenableFutureUtils.java | 34 ++++++++++++-------
 1 file changed, 21 insertions(+), 13 deletions(-)

diff --git a/cffu-core/src/main/java/io/foldright/cffu/ListenableFutureUtils.java b/cffu-core/src/main/java/io/foldright/cffu/ListenableFutureUtils.java
index 0d925713..698a12e9 100644
--- a/cffu-core/src/main/java/io/foldright/cffu/ListenableFutureUtils.java
+++ b/cffu-core/src/main/java/io/foldright/cffu/ListenableFutureUtils.java
@@ -30,24 +30,31 @@ public class ListenableFutureUtils {
      * Callback from ListenableFuture is executed using the given executor,
      * use {@link MoreExecutors#directExecutor()} if you need skip executor switch.
      * <p>
-     * Cancelling the result {@link CompletableFuture} will also cancel inner {@link ListenableFuture}.
-     * Use param {@code mayInterruptIfRunning} to control whether to interrupt the thread of {@link ListenableFuture}.
+     * Cancelling({@link Future#cancel(boolean)}) the returned CompletableFuture
+     * will also cancel underlying ListenableFuture.
      * <p>
-     * Note: CompletionException caused by this CancellationException is also considered cancellation.
+     * Use param {@code interruptLfWhenCancellationException} to control whether to cancel ListenableFuture with
+     * interruption when CancellationException occurred(including CompletionException with CancellationException cause).
      * <p>
-     * We encourage you to avoid using direct write methods in {@link CompletableFuture} so that the underlying
-     * {@link ListenableFuture} can benefit from cancel propagation.
+     * It's recommended to avoid using direct write methods(e.g. {@link CompletableFuture#complete(Object)},
+     * {@link CompletableFuture#completeExceptionally(Throwable)}) of the returned CompletableFuture:
+     * <ul>
+     * <li>the underlying ListenableFuture can benefit from cancel propagation.
+     * <li>the writing of the returned CompletableFuture won't affect the underlying ListenableFuture.
+     * </ul>
      *
-     * @param lf                    the wrapped ListenableFuture
-     * @param executor              the executor
-     * @param mayInterruptIfRunning {@code true} if the thread of {@link ListenableFuture} should be interrupted when
-     *                              {@link CompletableFuture} canceled (if the thread is known to the implementation).
+     * @param lf                                   the underlying ListenableFuture
+     * @param executor                             the executor to use for ListenableFuture callback execution
+     * @param interruptLfWhenCancellationException whether to cancel ListenableFuture with interruption when CancellationException
+     *                                             occurred (including CompletionException with CancellationException cause)
      * @return the completable future
      * @see CompletableFuture#cancel(boolean)
      */
     @Contract(pure = true)
-    public static <T> CompletableFuture<T> toCompletableFuture(ListenableFuture<T> lf, Executor executor, boolean mayInterruptIfRunning) {
+    public static <T> CompletableFuture<T> toCompletableFuture(
+            ListenableFuture<T> lf, Executor executor, boolean interruptLfWhenCancellationException) {
         requireNonNull(lf, "listenableFuture is null");
+        requireNonNull(executor, "executor is null");
 
         CompletableFuture<T> ret = new CompletableFuture<T>() {
             @Override
@@ -68,7 +75,7 @@ public String toString() {
         CompletableFutureUtils.peek(ret, (v, ex) -> {
             ex = CompletableFutureUtils.unwrapCfException(ex);
             if (ex instanceof CancellationException) {
-                lf.cancel(mayInterruptIfRunning);
+                lf.cancel(interruptLfWhenCancellationException);
             }
         });
 
@@ -92,8 +99,9 @@ public void onFailure(Throwable ex) {
      * Callback from ListenableFuture is executed using cffuFactory's default executor.
      */
     @Contract(pure = true)
-    public static <T> Cffu<T> toCffu(ListenableFuture<T> lf, CffuFactory cffuFactory, boolean mayInterruptIfRunning) {
-        return cffuFactory.toCffu(toCompletableFuture(lf, cffuFactory.defaultExecutor(), mayInterruptIfRunning));
+    public static <T> Cffu<T> toCffu(
+            ListenableFuture<T> lf, CffuFactory cffuFactory, boolean interruptLfWhenCancellationException) {
+        return cffuFactory.toCffu(toCompletableFuture(lf, cffuFactory.defaultExecutor(), interruptLfWhenCancellationException));
     }
 
     /**