📖 English Documentation | 📖 中文文档

---

👉 Java CompletableFuture-Fu ("CF-Fu", pronounced "Shifu" 🦝) is a tiny library that improves the CompletableFuture(CF) usage experience and reduces misuse, enabling more convenient, efficient, and safe use of CF in your application. 😋🚀🦺

Welcome 👏💖

• For suggestions and questions, submit an Issue
• For contributions and improvements, play fork and pull request dance

---

• 🔧 Features
  • About CompletableFuture
• 👥 User Guide
  • 1. cffu usage modes
    • 1.1 recommended Cffu class usage 🌟
    • 1.2 migrating code from using CompletableFuture class to using Cffu class
    • 1.3 dependencies (including CompletableFutureUtils utility class)
  • 2. cffu feature introduction
    • 2.1 support for returning overall results of multiple input CFs
    • 2.2 retrieve all results of multiple CFs with fail-fast support, instead of futile waiting that reduces business responsiveness
    • 2.3 retrieve the first successful result from multiple CFs, instead of the first completed but exceptional CF
    • 2.4 support for setting the default business thread pool
    • 2.5 efficient and flexible concurrent execution strategies (AllFailFast / AnySuccess / AllSuccess / MostSuccess)
    • 2.6 support for directly running multiple actions instead of wrapping them into Completablefutures first
    • 2.7 Support for async parallel processing of collection data, instead of wrapping data and into s first
• 🔌 API Docs
• 🍪 Dependencies
• 📚 More Resources
• 👋 About the Library Name

---

🔧 Features

☘️ Completing missing functionality in business development

• 🏪 More convenient features, such as:
  • Support for returning overall results of multiple input CFs instead of returning CF<Void> without input CF results (CompletableFuture#allOf)
    • Such as methods allResultsFailFastOf / mSupplyFailFastAsync / thenMApplyMostSuccessAsync
  • Support for directly running multiple Actions instead of wrapping them into CompletableFutures first
    • Such as methods mSupplyAsync / mRunFailFastAsync / thenMApplyAllSuccessAsync
    • i.e. multiple instruction, single data (MISD) style processing
  • Support for async parallel processing of collection data, instead of wrapping data with actions into CompletableFutures first
    • Such as methods CfParallelUtils#parApplyFailFastAsync / CfParallelUtils#thenParAcceptAnySuccessAsync
    • i.e. single instruction, multiple data (SIMD) style processing
  • Support for inputting collections of CFs / Actions instead of converting them to array first
    • Such as methods CfIterableUtils#allResultsFailFastOf / CfIterableUtils#mSupplyFailFastAsync / CfIterableUtils#thenMApplyMostSuccessAsync
  • Support for setting a default business thread pool via CffuFactory#builder(executor) method, instead of repeatedly passing business thread pool parameters during async execution
  • Support for handling specific exception types via catching methods instead of handling all Throwable exceptions (CompletableFuture#exceptionally)
• 🚦 More efficient and flexible concurrent execution strategies, such as:
  • AllFailFast strategy: fail fast when any of the multiple input CFs complete exceptionally instead of futilely waiting for all CFs to complete (CompletableFuture#allOf)
  • AnySuccess strategy: Return the first successful CF result instead of the first completed but possibly exceptional CF (CompletableFuture#anyOf)
  • AllSuccess strategy: Return successful results from multiple CFs, returning specified default values for exceptional s

⏳ Backport support for Java 8, all new CF methods from Java 9+ versions are directly available in Java 8 version, such as:

• Timeout control: orTimeout / completeOnTimeout
• Delayed execution: delayedExecutor
• Factory methods: failedFuture / completedStage / failedStage
• Processing operations: completeAsync / exceptionallyAsync / exceptionallyCompose / copy
• Non-blocking reads: resultNow / exceptionNow / state

💪 Enhancement of existing features, such as:

• anyOf method: Returns specific type T (type-safe) instead of returning Object (CompletableFuture#anyOf)
• allOf / anyOf methods: Accept broader CompletionStage parameter type