Package de.eldoria.eldoutilities.threading.futures

Class BukkitFutureResult<T>

java.lang.Object

de.eldoria.eldoutilities.threading.futures.BukkitFutureResult<T>

All Implemented Interfaces:

FutureResult<T>

public class BukkitFutureResult<T>
extends Object
implements FutureResult<T>

Method Summary

Modifier and Type	Method	Description
@NotNull CompletableFuture<T>	asFuture()	Encapsulates this FutureResult as a CompletableFuture.
T	join()	Blocks the current thread until the action has completed.
static <T> BukkitFutureResult<T>	of(CompletableFuture<T> future)
void	whenComplete(@NotNull Consumer<? super T> callback)	Attaches a completion callback to this FutureResult.
void	whenComplete(@NotNull Consumer<? super T> callback, Consumer<Throwable> throwable)
void	whenComplete(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull Consumer<? super T> callback)	Attaches a completion callback to this FutureResult.
void	whenComplete(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull Consumer<? super T> callback, Consumer<Throwable> throwableConsumer)

Methods inherited from class java.lang.Object

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

Method Details

of

public static <T> BukkitFutureResult<T> of(CompletableFuture<T> future)

whenComplete

public void whenComplete(@NotNull
 @NotNull Consumer<? super T> callback)

Description copied from interface: FutureResult

Attaches a completion callback to this FutureResult.

If the action is already complete, the runnable will be called immediately.

If it is not complete, the consumer will be called synchronously using the Bukkit scheduler when the action is completed.

Specified by:

whenComplete in interface FutureResult<T>

Parameters:

callback - the callback

whenComplete

public void whenComplete(@NotNull
 @NotNull Consumer<? super T> callback,
 Consumer<Throwable> throwable)

Specified by:

whenComplete in interface FutureResult<T>

whenComplete

public void whenComplete(@NotNull
 @NotNull org.bukkit.plugin.Plugin plugin,
 @NotNull
 @NotNull Consumer<? super T> callback,
 Consumer<Throwable> throwableConsumer)

Specified by:

whenComplete in interface FutureResult<T>

whenComplete

public void whenComplete(@NotNull
 @NotNull org.bukkit.plugin.Plugin plugin,
 @NotNull
 @NotNull Consumer<? super T> callback)

Description copied from interface: FutureResult

Attaches a completion callback to this FutureResult.

If the action is already complete, the runnable will be called immediately.

If it is not complete, the consumer will be called synchronously using the Bukkit scheduler when the action is completed.

Specified by:

whenComplete in interface FutureResult<T>

Parameters:

plugin - used for callback.

callback - the callback

join

@Nullable
public T join()

Description copied from interface: FutureResult

Blocks the current thread until the action has completed.

This method should only be called from an async task!

Specified by:

join in interface FutureResult<T>

Returns:

the result

asFuture

@NotNull
public @NotNull CompletableFuture<T> asFuture()

Description copied from interface: FutureResult

Encapsulates this FutureResult as a CompletableFuture.

Specified by:

asFuture in interface FutureResult<T>

Returns:

a future