From 3f441c414709c904202442fe5a578b906e3975a0 Mon Sep 17 00:00:00 2001 From: Jerry Lee Date: Sat, 27 Apr 2024 23:17:04 +0800 Subject: [PATCH] refactor: rename method `asCffu` to `toCffu`, consistant with `CompletionStage#toCompletableFuture` --- .../src/main/java/io/foldright/cffu/Cffu.java | 6 ++-- .../java/io/foldright/cffu/CffuFactory.java | 20 +++++------ .../io/foldright/cffu/CffuFactoryTest.java | 31 ++++++++--------- .../test/java/io/foldright/cffu/CffuTest.java | 7 ++-- .../foldright/cffu/kotlin/CffuExtensions.kt | 34 ++++++++++--------- .../foldright/cffu/test/CffuExtensionsTest.kt | 28 +++++++-------- 6 files changed, 63 insertions(+), 63 deletions(-) diff --git a/cffu-core/src/main/java/io/foldright/cffu/Cffu.java b/cffu-core/src/main/java/io/foldright/cffu/Cffu.java index f82b3d6c..5b9791b2 100644 --- a/cffu-core/src/main/java/io/foldright/cffu/Cffu.java +++ b/cffu-core/src/main/java/io/foldright/cffu/Cffu.java @@ -1966,7 +1966,7 @@ public boolean forbidObtrudeMethods() { *
  • {@link CffuFactory#completedStage(Object)} *
  • {@link CffuFactory#failedStage(Throwable)} *
  • {@link #minimalCompletionStage()} - *
  • {@link CffuFactory#asCffu(CompletionStage)}, this method return a {@code minimal stage} + *
  • {@link CffuFactory#toCffu(CompletionStage)}, this method return a {@code minimal stage} * when input a{@code minimal stage}, otherwise return a normal stage. * */ @@ -1985,11 +1985,11 @@ public boolean isMinimalStage() { /** * Returns the underlying CompletableFuture. *

    - * {@link CffuFactory#asCffu(CompletionStage)} is inverse operation to this method. + * {@link CffuFactory#toCffu(CompletionStage)} is inverse operation to this method. * {@link CffuFactory#cffuArrayUnwrap(Cffu[])} is the batch operation to this method. * * @return the underlying CompletableFuture - * @see CffuFactory#asCffu(CompletionStage) + * @see CffuFactory#toCffu(CompletionStage) * @see CffuFactory#cffuArrayUnwrap(Cffu[]) * @see #toCompletableFuture() */ diff --git a/cffu-core/src/main/java/io/foldright/cffu/CffuFactory.java b/cffu-core/src/main/java/io/foldright/cffu/CffuFactory.java index 5bd725c0..d6ea3d4a 100644 --- a/cffu-core/src/main/java/io/foldright/cffu/CffuFactory.java +++ b/cffu-core/src/main/java/io/foldright/cffu/CffuFactory.java @@ -217,8 +217,8 @@ public Cffu supplyAsync(Supplier supplier, Executor executor) { // // - newIncompleteCffu: equivalent to CompletableFuture constructor // - // - asCffu: CF/CompletionStage -> Cffu - // - asCffuArray: CF/CompletionStage[] -> Cffu[] + // - toCffu: CF/CompletionStage -> Cffu + // - toCffuArray: CF/CompletionStage[] -> Cffu[] //////////////////////////////////////////////////////////////////////////////// /** @@ -255,13 +255,13 @@ public Cffu newIncompleteCffu() { *

  • otherwise use input {@code stage.toCompletableFuture} as the underlying cf of returned cffu. * * + * @see #toCffuArray(CompletionStage[]) + * @see CompletionStage#toCompletableFuture() * @see Cffu#cffuUnwrap() * @see Cffu#resetCffuFactory(CffuFactory) - * @see #asCffuArray(CompletionStage[]) - * @see CompletionStage#toCompletableFuture() */ @Contract(pure = true) - public Cffu asCffu(CompletionStage stage) { + public Cffu toCffu(CompletionStage stage) { requireNonNull(stage, "stage is null"); if ("java.util.concurrent.CompletableFuture$MinimalStage".equals(stage.getClass().getName())) { @@ -276,17 +276,17 @@ public Cffu asCffu(CompletionStage stage) { /** * A convenient util method for wrap input {@link CompletableFuture} / {@link CompletionStage} / {@link Cffu} - * array element by {@link #asCffu(CompletionStage)}. + * array element by {@link #toCffu(CompletionStage)}. * - * @see #asCffu(CompletionStage) + * @see #toCffu(CompletionStage) */ @Contract(pure = true) @SafeVarargs - public final Cffu[] asCffuArray(CompletionStage... stages) { + public final Cffu[] toCffuArray(CompletionStage... stages) { @SuppressWarnings("unchecked") Cffu[] ret = new Cffu[stages.length]; for (int i = 0; i < stages.length; i++) { - ret[i] = asCffu(requireNonNull(stages[i], "stage" + (i + 1) + " is null")); + ret[i] = toCffu(requireNonNull(stages[i], "stage" + (i + 1) + " is null")); } return ret; } @@ -636,7 +636,7 @@ public Executor delayedExecutor(long delay, TimeUnit unit, Executor executor) { * @see Cffu#toCompletableFuture() * @see CompletableFuture#toCompletableFuture() * @see CompletionStage#toCompletableFuture() - * @see #asCffuArray(CompletionStage[]) + * @see #toCffuArray(CompletionStage[]) */ @Contract(pure = true) @SafeVarargs diff --git a/cffu-core/src/test/java/io/foldright/cffu/CffuFactoryTest.java b/cffu-core/src/test/java/io/foldright/cffu/CffuFactoryTest.java index f47ee250..10da42e3 100644 --- a/cffu-core/src/test/java/io/foldright/cffu/CffuFactoryTest.java +++ b/cffu-core/src/test/java/io/foldright/cffu/CffuFactoryTest.java @@ -14,7 +14,6 @@ import java.util.Arrays; import java.util.Collections; import java.util.concurrent.*; -import java.util.function.Function; import static io.foldright.cffu.CffuFactoryBuilder.newCffuFactoryBuilder; import static io.foldright.cffu.CompletableFutureUtils.failedFuture; @@ -106,8 +105,8 @@ void test_failedStage() throws Exception { // // - newIncompleteCffu: equivalent to CompletableFuture constructor // - // - asCffu: CF/CompletionStage -> Cffu - // - asCffuArray: CF/CompletionStage[] -> Cffu[] + // - toCffu: CF/CompletionStage -> Cffu + // - toCffuArray: CF/CompletionStage[] -> Cffu[] //////////////////////////////////////////////////////////////////////////////// @Test @@ -117,14 +116,14 @@ void test_newIncompleteCffu() { } @Test - void test_asCffu() throws Exception { - Cffu cf = cffuFactory.asCffu(completedFuture(n)); + void test_toCffu() throws Exception { + Cffu cf = cffuFactory.toCffu(completedFuture(n)); assertEquals(n, cf.get()); shouldNotBeMinimalStage(cf); CffuFactory fac = newCffuFactoryBuilder(anotherExecutorService).forbidObtrudeMethods(true).build(); - Cffu cffu = fac.asCffu(cffuFactory.completedFuture(42)); + Cffu cffu = fac.toCffu(cffuFactory.completedFuture(42)); assertSame(anotherExecutorService, cffu.defaultExecutor()); assertSame(fac, cffu.cffuFactory()); @@ -138,24 +137,24 @@ void test_asCffu() throws Exception { @Test @EnabledForJreRange(min = JRE.JAVA_9) - void test_asCffu__for_factoryMethods_of_Java9() { + void test_toCffu__for_factoryMethods_of_Java9() { CompletableFuture cf1 = CompletableFuture.failedFuture(rte); - assertFalse(cffuFactory.asCffu(cf1).isMinimalStage()); + assertFalse(cffuFactory.toCffu(cf1).isMinimalStage()); shouldNotBeMinimalStage(cf1); - Cffu cf2 = cffuFactory.asCffu(CompletableFuture.completedStage(n)); + Cffu cf2 = cffuFactory.toCffu(CompletableFuture.completedStage(n)); assertTrue(cf2.isMinimalStage()); shouldBeMinimalStage(cf2); - Cffu cf3 = cffuFactory.asCffu(CompletableFuture.failedStage(rte)); + Cffu cf3 = cffuFactory.toCffu(CompletableFuture.failedStage(rte)); assertTrue(cf3.isMinimalStage()); shouldBeMinimalStage(cf3); } @Test @EnabledForJreRange(min = JRE.JAVA_9) - void test_asCffuArray() throws Exception { - Cffu[] cffus = cffuFactory.asCffuArray(CompletableFuture.completedStage(n), completedFuture(n)); + void test_toCffuArray() throws Exception { + Cffu[] cffus = cffuFactory.toCffuArray(CompletableFuture.completedStage(n), completedFuture(n)); assertEquals(n, cffus[1].get()); shouldBeMinimalStage(cffus[0]); @@ -734,8 +733,8 @@ void test_toCompletableFutureArray() { }; @SuppressWarnings("unchecked") Cffu[] cffuArray = new Cffu[]{ - cffuFactory.asCffu(cfArray[0]), - cffuFactory.asCffu(cfArray[1]), + cffuFactory.toCffu(cfArray[0]), + cffuFactory.toCffu(cfArray[1]), }; assertArrayEquals(cfArray, CffuFactory.toCompletableFutureArray(cfArray)); @@ -752,8 +751,8 @@ void test_cffuArrayUnwrap() { }; @SuppressWarnings("unchecked") Cffu[] input = new Cffu[]{ - cffuFactory.asCffu(cfArray[0]), - cffuFactory.asCffu(cfArray[1]), + cffuFactory.toCffu(cfArray[0]), + cffuFactory.toCffu(cfArray[1]), }; assertArrayEquals(cfArray, CffuFactory.cffuArrayUnwrap(input)); } diff --git a/cffu-core/src/test/java/io/foldright/cffu/CffuTest.java b/cffu-core/src/test/java/io/foldright/cffu/CffuTest.java index 56c093c5..9caeb511 100644 --- a/cffu-core/src/test/java/io/foldright/cffu/CffuTest.java +++ b/cffu-core/src/test/java/io/foldright/cffu/CffuTest.java @@ -10,7 +10,6 @@ import java.util.concurrent.*; import java.util.function.BiConsumer; import java.util.function.Consumer; -import java.util.function.Function; import static io.foldright.cffu.CffuFactoryBuilder.newCffuFactoryBuilder; import static io.foldright.test_utils.TestUtils.*; @@ -278,7 +277,7 @@ void test_isMinimalStage() { @Test void test_cffuUnwrap() { CompletableFuture cf = CompletableFuture.completedFuture(n); - Cffu cffu = cffuFactory.asCffu(cf); + Cffu cffu = cffuFactory.toCffu(cf); assertSame(cf, cffu.cffuUnwrap()); } @@ -287,7 +286,7 @@ void test_cffuUnwrap() { @EnabledForJreRange(min = JRE.JAVA_9) void test_cffuUnwrap_9_completedStage() { CompletionStage stage = CompletableFuture.completedStage(n); - Cffu cffu = cffuFactory.asCffu(stage); + Cffu cffu = cffuFactory.toCffu(stage); assertSame(stage, cffu.cffuUnwrap()); } @@ -295,7 +294,7 @@ void test_cffuUnwrap_9_completedStage() { @Test void test_toString() { CompletableFuture cf = CompletableFuture.completedFuture(42); - Cffu cffu = cffuFactory.asCffu(cf); + Cffu cffu = cffuFactory.toCffu(cf); assertTrue(cffu.toString().contains(cf.toString())); assertTrue(cffu.toString().startsWith("Cffu@")); diff --git a/cffu-kotlin/src/main/java/io/foldright/cffu/kotlin/CffuExtensions.kt b/cffu-kotlin/src/main/java/io/foldright/cffu/kotlin/CffuExtensions.kt index f3d079e2..6af0b40b 100644 --- a/cffu-kotlin/src/main/java/io/foldright/cffu/kotlin/CffuExtensions.kt +++ b/cffu-kotlin/src/main/java/io/foldright/cffu/kotlin/CffuExtensions.kt @@ -13,39 +13,41 @@ import java.util.concurrent.CompletionStage //////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////// -// asCffu methods +// toCffu methods //////////////////////////////////////// /** * Wrap an existed [CompletableFuture]/[CompletionStage] to [Cffu]. * - * This method is the same as [CffuFactory.asCffu], providing this method is convenient for method chaining. + * This method is the same as [CffuFactory.toCffu], providing this method is convenient for method chaining. * - * @see CffuFactory.asCffu + * @see CffuFactory.toCffu + * @see CompletionStage.toCompletableFuture */ -fun CompletionStage.asCffu(cffuFactory: CffuFactory): Cffu = - cffuFactory.asCffu(this) +fun CompletionStage.toCffu(cffuFactory: CffuFactory): Cffu = + cffuFactory.toCffu(this) /** - * Wrap input [CompletableFuture]/[CompletionStage] collection elements to [Cffu] by [CffuFactory.asCffu]. + * Wrap input [CompletableFuture]/[CompletionStage] collection elements to [Cffu] by [CffuFactory.toCffu]. * - * This method is the same as [CffuFactory.asCffuArray], providing this method is convenient for method chaining. + * This method is the same as [CffuFactory.toCffuArray], providing this method is convenient for method chaining. * - * @see CffuFactory.asCffu + * @see CffuFactory.toCffuArray + * @see CffuFactory.toCffu */ -fun Collection>.asCffu(cffuFactory: CffuFactory): List> = - map { it.asCffu(cffuFactory) } +fun Collection>.toCffu(cffuFactory: CffuFactory): List> = + map { it.toCffu(cffuFactory) } /** - * Wrap input [CompletableFuture]/[CompletionStage] array elements to [Cffu] by [CffuFactory.asCffu]. + * Wrap input [CompletableFuture]/[CompletionStage] array elements to [Cffu] by [CffuFactory.toCffu]. * - * This method is the same as [CffuFactory.asCffuArray], providing this method is convenient for method chaining. + * This method is the same as [CffuFactory.toCffuArray], providing this method is convenient for method chaining. * - * @see CffuFactory.asCffuArray - * @see CffuFactory.asCffu + * @see CffuFactory.toCffuArray + * @see CffuFactory.toCffu */ -fun Array>.asCffu(cffuFactory: CffuFactory): Array> = - cffuFactory.asCffuArray(*this) +fun Array>.toCffu(cffuFactory: CffuFactory): Array> = + cffuFactory.toCffuArray(*this) //////////////////////////////////////// // allOf* methods diff --git a/cffu-kotlin/src/test/java/io/foldright/cffu/test/CffuExtensionsTest.kt b/cffu-kotlin/src/test/java/io/foldright/cffu/test/CffuExtensionsTest.kt index 5e32aed4..0e5e6036 100644 --- a/cffu-kotlin/src/test/java/io/foldright/cffu/test/CffuExtensionsTest.kt +++ b/cffu-kotlin/src/test/java/io/foldright/cffu/test/CffuExtensionsTest.kt @@ -29,10 +29,10 @@ val rte = RuntimeException("Bang") class CffuExtensionsTest : FunSpec({ //////////////////////////////////////// - // asCffu + // toCffu //////////////////////////////////////// - suspend fun checkAsCffu(cffu: Cffu, n: Int) { + suspend fun checkToCffu(cffu: Cffu, n: Int) { cffu.await() shouldBe n cffu.defaultExecutor() shouldBeSameInstanceAs testThreadPoolExecutor @@ -45,31 +45,31 @@ class CffuExtensionsTest : FunSpec({ } } - test("asCffu for CompletableFuture") { + test("toCffu for CompletableFuture") { val cf = CompletableFuture.completedFuture(n) - checkAsCffu(cf.asCffu(testCffuFactory), n) + checkToCffu(cf.toCffu(testCffuFactory), n) } - test("asCffu for CompletableFuture collection") { + test("toCffu for CompletableFuture collection") { val range = 0 until 10 val cfs: List> = range.map { CompletableFuture.completedFuture(it) } - cfs.asCffu(testCffuFactory).forEachIndexed { index, cffu -> - checkAsCffu(cffu, index) + cfs.toCffu(testCffuFactory).forEachIndexed { index, cffu -> + checkToCffu(cffu, index) } - cfs.toSet().asCffu(testCffuFactory).forEachIndexed { index, cffu -> - checkAsCffu(cffu, index) + cfs.toSet().toCffu(testCffuFactory).forEachIndexed { index, cffu -> + checkToCffu(cffu, index) } } - test("asCffu for CompletableFuture array") { + test("toCffu for CompletableFuture array") { val cfArray: Array> = Array(10) { CompletableFuture.completedFuture(it) } - cfArray.asCffu(testCffuFactory).forEachIndexed { index, cffu -> checkAsCffu(cffu, index) } + cfArray.toCffu(testCffuFactory).forEachIndexed { index, cffu -> checkToCffu(cffu, index) } val csArray: Array> = Array(10) { CompletableFuture.completedFuture(it) } - csArray.asCffu(testCffuFactory).forEachIndexed { index, cffu -> checkAsCffu(cffu, index) } + csArray.toCffu(testCffuFactory).forEachIndexed { index, cffu -> checkToCffu(cffu, index) } } test("allOf*") { @@ -460,7 +460,7 @@ class CffuExtensionsTest : FunSpec({ cfArray::class shouldNotBe csArray::class cfArray shouldBe csArray // shouldBe ignore the array type! - val cffus: List> = cfs.asCffu(testCffuFactory) + val cffus: List> = cfs.toCffu(testCffuFactory) cffus.toCompletableFuture() shouldBe cfs cffus.toSet().toCompletableFuture() shouldBe cfs @@ -493,7 +493,7 @@ class CffuExtensionsTest : FunSpec({ } val cfArray = cfs.toTypedArray() - val cffus: List> = cfs.asCffu(testCffuFactory) + val cffus: List> = cfs.toCffu(testCffuFactory) cffus.cffuUnwrap() shouldBe cfs cffus.toSet().cffuUnwrap() shouldBe cfs