mirror of
https://github.com/tommyskeff/futur4j.git
synced 2026-01-18 07:16:45 +00:00
4236adbd9e
- added docs for `Promise` and `PromiseFactory` - removed outdated README docs - moved some common utilities to `PromiseUtil` - improved efficiency of result array resizing - added cancellation result to promise executors - changed visibility of `PromiseJoiner` to public, and made some method names more verbose - inlined `DeferredExecutionException` to inside `AbstractPromise` - inlined default promise implementation to inner class in the factory - removed necessity for base factories to provide a logger
55 lines
1.4 KiB
Markdown
55 lines
1.4 KiB
Markdown
# Futur4J
|
|
|
|
Futur4J is a powerful and intuitive open-source Java library that simplifies asynchronous task scheduling, inspired by the concept of JavaScript promises.
|
|
|
|
**This documentation is outdated. Please don't read it.**
|
|
|
|
## Dependency
|
|
The Futur4J project is composed of multiple modules. It is required to include the `futur-api` module, and the other modules depend on it at runtime, however the others are optional and dependent on your use case.
|
|
### Gradle
|
|
```gradle
|
|
repositories {
|
|
maven {
|
|
url 'https://repo.tommyjs.dev/repository/maven-releases/'
|
|
}
|
|
}
|
|
|
|
dependencies {
|
|
compile 'dev.tommyjs:futur-api:2.4.0'
|
|
compile 'dev.tommyjs:futur-lazy:2.4.0'
|
|
}
|
|
```
|
|
### Gradle DSL
|
|
```kotlin
|
|
repositories {
|
|
maven("https://repo.tommyjs.dev/repository/maven-releases/")
|
|
}
|
|
|
|
dependencies {
|
|
implementation("dev.tommyjs:futur-api:2.4.0")
|
|
implementation("dev.tommyjs:futur-lazy:2.4.0")
|
|
}
|
|
```
|
|
### Maven
|
|
```xml
|
|
<repositories>
|
|
<repository>
|
|
<id>tommyjs-repo</id>
|
|
<url>https://repo.tommyjs.dev/repository/maven-releases/</url>
|
|
</repository>
|
|
</repositories>
|
|
|
|
<dependencies>
|
|
<dependency>
|
|
<groupId>dev.tommyjs</groupId>
|
|
<artifactId>futur-api</artifactId>
|
|
<version>2.4.0</version>
|
|
</dependency>
|
|
<dependency>
|
|
<groupId>dev.tommyjs</groupId>
|
|
<artifactId>futur-lazy</artifactId>
|
|
<version>2.4.0</version>
|
|
</dependency>
|
|
</dependencies>
|
|
```
|