Package de.linusdev.lutils.async

Interface PTask<R,S>

All Superinterfaces:

HasAsyncManager, Task<R,S>

All Known Implementing Classes:

CompletableTask, ExecutableTaskBase, QueueableBase

public interface PTask<R,S>
extends Task<R,S>

Task with some methods, that should not be visible to the end user.

See Also:

• Task

Method Summary

Modifier and Type	Method	Description
@NotNull Future<R,S>	consumeAndQueue(@Nullable Consumer<Future<R,S>> consumer)
default @NotNull Future<R,S>	queue()	Queues the Task for future asynchronous execution.
default @NotNull Future<R,S>	queue(@NotNull ResultAndErrorConsumer<R,S> consumer)
default @NotNull Future<R,S>	queue(@NotNull ResultConsumer<R,S> consumer)
default @NotNull Future<R,S>	queue(@NotNull SingleResultConsumer<R,S> consumer)
default @NotNull Future<R,S>	queueAndSetBeforeExecutionListener(@NotNull Consumer<Future<R,S>> consumer)
default R	queueAndWait()	Waits the current Thread until the Future of this queued Task has been executed.
default @NotNull Future<R,S>	queueAndWriteToFile(@NotNull Path file, boolean overwriteIfExists, @Nullable ResultAndErrorConsumer<R,S> after)	What exactly will be written to the file, depends on the implementation.

Methods inherited from interface de.linusdev.lutils.async.manager.HasAsyncManager

getAsyncManager

Methods inherited from interface de.linusdev.lutils.async.Task

executeHere, getName

Method Details

consumeAndQueue

@NotNull
@NotNull Future<R,S> consumeAndQueue(@Nullable
 @Nullable Consumer<Future<R,S>> consumer)
                              throws CannotQueueTaskException

Parameters:

consumer - Consumer to set listeners before the Future is queued.

Returns:

Future

Throws:

CannotQueueTaskException

queue

@NotNull
default @NotNull Future<R,S> queue()

Description copied from interface: Task

Queues the Task for future asynchronous execution. That does not mean, that the Task actually ends up in a queue, but that the Task will be executed at any point in time in the future.

Specified by:

queue in interface Task<R,S>

Returns:

Future

See Also:

• Task.queue(SingleResultConsumer)
• Task.queue(ResultConsumer)
• Task.queue(ResultAndErrorConsumer)
• Task.queueAndWait()
• Task.queueAndWriteToFile(Path, boolean, ResultAndErrorConsumer)
• Task.queueAndSetBeforeExecutionListener(Consumer)

queueAndSetBeforeExecutionListener

@NotNull
default @NotNull Future<R,S> queueAndSetBeforeExecutionListener(@NotNull
 @NotNull Consumer<Future<R,S>> consumer)

Specified by:

queueAndSetBeforeExecutionListener in interface Task<R,S>

Parameters:

consumer - Consumer listener to be called before execution starts.

Returns:

Future

See Also:

• Task.queue()

queue

@NotNull
default @NotNull Future<R,S> queue(@NotNull
 @NotNull ResultConsumer<R,S> consumer)

Specified by:

queue in interface Task<R,S>

Parameters:

consumer - ResultConsumer listener to be called when the result is ready.

Returns:

Future

See Also:

• Task.queue()

queue

@NotNull
default @NotNull Future<R,S> queue(@NotNull
 @NotNull SingleResultConsumer<R,S> consumer)

Specified by:

queue in interface Task<R,S>

Parameters:

consumer - SingleResultConsumer listener to be called when the result is ready.

Returns:

Future

See Also:

• Task.queue()

queue

@NotNull
default @NotNull Future<R,S> queue(@NotNull
 @NotNull ResultAndErrorConsumer<R,S> consumer)

Specified by:

queue in interface Task<R,S>

Parameters:

consumer - ResultAndErrorConsumer listener to be called when the result is ready.

Returns:

Future

See Also:

• Task.queue()

queueAndWait

@NotNull
default R queueAndWait()
                throws InterruptedException,
ErrorException

Description copied from interface: Task

Waits the current Thread until the Future of this queued Task has been executed.

Specified by:

queueAndWait in interface Task<R,S>

Returns:

Task result

Throws:

InterruptedException - if interrupted while waiting

ErrorException - if the Future returned with an error.

queueAndWriteToFile

@NotNull
default @NotNull Future<R,S> queueAndWriteToFile(@NotNull
 @NotNull Path file,
 boolean overwriteIfExists,
 @Nullable
 @Nullable ResultAndErrorConsumer<R,S> after)

Description copied from interface: Task

What exactly will be written to the file, depends on the implementation.

Specified by:

queueAndWriteToFile in interface Task<R,S>

Parameters:

file - Path of the file to write to.

overwriteIfExists - if the file should be overwritten if it already exists.

after - ResultAndErrorConsumer to consume the result after it has been written to the file.

Returns:

Future