v1.0 project management

[oldratlee]

📚 Documentation

🦮 CompletableFuture Guide

• design patterns of biz usage
• best practice and traps
• write English doc, and English first

see README.md

🎪 CompletableFuture Usage Showcase

• timeout control showcase(6386d9b)
• delay execution showcase(6386d9b)

see CompletableFutureUsageShowcaseTest.kt

🇨🇳 Translations

• translate javadoc of
  • CompletableFuture
  • CompletionStage

📦 Library

see

• CffuFactory.java
• Cffu.java

✨ Support the missing convenient new methods

• new methods CffuFactory.cffuAllOf(...)(7acfa4d)
  with results version of CompletableFuture.allof
• new methods CffuFactory.cffuAnyOf(...)(d9df93f)
  type safe version of CompletableFuture.anyOf Method
• new methods Cffu.cffuCombine(...)
  same as CffuFactory.cffuAllOf(...), providing this method is convenient for method chaining.
• new method Cffu.cffuJoin support timeout join ⏳ (323e14a)

🚗 Customizable CF

• sticky default executor for *Async methods

🔮 backport CF methods from high java versions to Java 8

• Cffu.java
  • timeout control methods orTimeout(...)/completeOnTimeout(...)
  • exceptionallyAsync()
  • exceptionallyCompose(...)/exceptionallyComposeAsync(...)
  • resultNow()/exceptionNow()
  • backport Future#state()
    • and add a new method cffuState() to works on Java 8
  • completeAsync(...)
  • minimalCompletionStage()
  • copy()
  • newIncompleteFuture()
• CffuFactory.java
  • delay execution methods defaultExecutor(...)
  • completedStage(...)/failedStage(...)
  • failedFuture(...)

🍩 Kotlin support

• extension methods of java implemented methods

🙌 Mics

• make lib 0-dependence(optional Kotlin runtime is ok)
  implement tuple instead of common-lang3 dependency

☔️ Testing

• API compatibility test with CompletableFuture
  • see CompletableFutureApiCompatibilityTest.java and CffuApiCompatibilityTest.java
• benchmark building chain performance by Cffu vs CompletableFuture
• benchmark execution chain performance by Cffu vs CompletableFuture

👷 Chore

• CI build/Github Action
  • support build by Java 19 and test by low version java(e.g. Java 8) (3a0c8e3)
    because the implementation used high java version api of CF
  • release maven SNAPSHOT to repo when main branch integration_test pass

[oldratlee]

cancelled/holden actions

• ✋ improve the Exception message, for example TimeoutException of orTimeout
  because only take effect for Cffu compatibility logic but add complex codes, low ROI
• ⏸️ excluding empty arguments overloaded methods(allof/cffuAnyOf/...) from generated javadoc
  • it seems impossible for official javadoc!
  • https://www.oracle.com/java/technologies/javase/javadoc-faq.html#exclude
  • https://stackoverflow.com/questions/1120455/how-do-i-exclude-a-specific-method-constructor-from-the-results-of-the-javadoc-a

[oldratlee]

Image Gallery

(images are generated from docs file)