Skip to content

Commit 5cc487f

Browse files
committed
add async library documentation
1 parent 4f12582 commit 5cc487f

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

README.MD

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ The contents of the [util](src/main/java/com/falsepattern/lib/util) package so f
1515
| Class | Purpose |
1616
|---------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|
1717
| [ResourceUtil](src/main/java/com/falsepattern/lib/util/ResourceUtil.java) | Provides methods for efficiently retrieving resources from SPECIFIC jar files instead of the entire classpath |
18+
| [Async](src/main/java/com/falsepattern/lib/util/Async.java) | Provides asynchronous execution utilities. |
1819

1920

2021
Anything annotated with [@StableAPI](src/main/java/com/falsepattern/lib/StableAPI.java) is guaranteed to not change in patch versions.

src/main/java/com/falsepattern/lib/util/Async.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@
77
import java.util.concurrent.ExecutorService;
88
import java.util.concurrent.Executors;
99

10+
/**
11+
* Asynchronous utilities. Notice: you should not abuse this for anything performance-sensitive.
12+
* The asynchronous worker exists primarily to run code independently of the main thread during loading.
13+
* You must make sure to solve any potential deadlocks yourself!
14+
*/
1015
@StableAPI(since = "0.8.0")
1116
public class Async {
1217
public static final ExecutorService asyncWorker = Executors.newSingleThreadExecutor((runnable) -> {

0 commit comments

Comments
 (0)