net.minecraftforge.fml

Class DeferredWorkQueue

java.lang.Object

net.minecraftforge.fml.DeferredWorkQueue

public class DeferredWorkQueue
extends java.lang.Object

Utility for running code on the main launch thread at the next available opportunity. There is no guaranteed order that work from various mods will be run, but your own work will be run sequentially.

Use of this class after startup is not possible. At that point, IThreadListener should be used instead.

Exceptions from tasks will be handled gracefully, causing a mod loading error. Tasks that take egregiously long times to run will be logged.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DeferredWorkQueue.CheckedRunnable Runnable except it allows throwing checked exceptions.

Constructor Summary

Constructors

Constructor and Description
DeferredWorkQueue()

Method Summary

Modifier and Type	Method and Description
static <T> java.util.concurrent.CompletableFuture<T>	getLater(java.util.function.Supplier<T> workToEnqueue) Run a task computing a result on the loading thread at the next available opportunity, i.e.
static <T> java.util.concurrent.CompletableFuture<T>	getLaterChecked(java.util.concurrent.Callable<T> workToEnqueue) Run a task computing a result on the loading thread at the next available opportunity, i.e.
static java.util.concurrent.CompletableFuture<java.lang.Void>	runLater(java.lang.Runnable workToEnqueue) Run a task on the loading thread at the next available opportunity, i.e.
static java.util.concurrent.CompletableFuture<java.lang.Void>	runLaterChecked(DeferredWorkQueue.CheckedRunnable workToEnqueue) Run a task on the loading thread at the next available opportunity, i.e.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeferredWorkQueue

public DeferredWorkQueue()

Method Detail

runLater

public static java.util.concurrent.CompletableFuture<java.lang.Void> runLater(java.lang.Runnable workToEnqueue)

Run a task on the loading thread at the next available opportunity, i.e. after the current lifecycle event has completed.

If the task must throw a checked exception, use runLaterChecked(CheckedRunnable).

If the task has a result, use getLater(Supplier) or getLaterChecked(Callable).

Parameters:

workToEnqueue - A Runnable to execute later, on the loading thread

Returns:

A CompletableFuture that completes at said time

runLaterChecked

public static java.util.concurrent.CompletableFuture<java.lang.Void> runLaterChecked(DeferredWorkQueue.CheckedRunnable workToEnqueue)

Run a task on the loading thread at the next available opportunity, i.e. after the current lifecycle event has completed. This variant allows the task to throw a checked exception.

If the task does not throw a checked exception, use runLater(Runnable).

If the task has a result, use getLater(Supplier) or getLaterChecked(Callable).

Parameters:

workToEnqueue - A DeferredWorkQueue.CheckedRunnable to execute later, on the loading thread

Returns:

A CompletableFuture that completes at said time

getLater

public static <T> java.util.concurrent.CompletableFuture<T> getLater(java.util.function.Supplier<T> workToEnqueue)

Run a task computing a result on the loading thread at the next available opportunity, i.e. after the current lifecycle event has completed.

If the task throws a checked exception, use getLaterChecked(Callable).

If the task does not have a result, use runLater(Runnable) or runLaterChecked(CheckedRunnable).

Type Parameters:

T - The result type of the task

Parameters:

workToEnqueue - A Supplier to execute later, on the loading thread

Returns:

A CompletableFuture that completes at said time

getLaterChecked

public static <T> java.util.concurrent.CompletableFuture<T> getLaterChecked(java.util.concurrent.Callable<T> workToEnqueue)

Run a task computing a result on the loading thread at the next available opportunity, i.e. after the current lifecycle event has completed. This variant allows the task to throw a checked exception.

If the task does not throw a checked exception, use #getLater(Callable).

If the task does not have a result, use runLater(Runnable) or runLaterChecked(CheckedRunnable).

Type Parameters:

T - The result type of the task

Parameters:

workToEnqueue - A Supplier to execute later, on the loading thread

Returns:

A CompletableFuture that completes at said time