Package dev.engine_room.flywheel.impl.task

Class SerialTaskExecutor

java.lang.Object

dev.engine_room.flywheel.impl.task.SerialTaskExecutor

All Implemented Interfaces:

dev.engine_room.flywheel.api.task.TaskExecutor, TaskExecutorImpl, Executor

public class SerialTaskExecutor
extends Object
implements TaskExecutorImpl

Field Summary

Fields

Modifier and Type	Field	Description
static final SerialTaskExecutor	INSTANCE

Method Summary

Modifier and Type	Method	Description
void	execute(Runnable runnable)
void	syncPoint()	Wait for all running tasks to finish.
boolean	syncUntil(BooleanSupplier cond)	Wait for running tasks, until the given condition is met (BooleanSupplier.getAsBoolean() returns true).
boolean	syncWhile(BooleanSupplier cond)	Wait for running tasks, so long as the given condition is met (BooleanSupplier.getAsBoolean() returns true).
int	threadCount()

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE

public static final SerialTaskExecutor INSTANCE

Method Details

execute

public void execute(Runnable runnable)

Specified by:

execute in interface Executor

threadCount

public int threadCount()

Specified by:

threadCount in interface dev.engine_room.flywheel.api.task.TaskExecutor

syncUntil

public boolean syncUntil(BooleanSupplier cond)

Description copied from interface: TaskExecutorImpl

Wait for running tasks, until the given condition is met (BooleanSupplier.getAsBoolean() returns true).
This method is equivalent to syncWhile(() -> !cond.getAsBoolean()).

Specified by:

syncUntil in interface TaskExecutorImpl

Parameters:

cond - The condition to wait for.

Returns:

true if the condition is met. false if this executor runs out of tasks before the condition is met.

syncWhile

public boolean syncWhile(BooleanSupplier cond)

Description copied from interface: TaskExecutorImpl

Wait for running tasks, so long as the given condition is met (BooleanSupplier.getAsBoolean() returns true).
If this method is called on the
This method is equivalent to syncUntil(() -> !cond.getAsBoolean()).

Specified by:

syncWhile in interface TaskExecutorImpl

Parameters:

cond - The condition sync on.

Returns:

true if the condition is no longer met. false if this executor runs out of tasks while the condition is still met.

syncPoint

public void syncPoint()

Description copied from interface: TaskExecutorImpl

Wait for all running tasks to finish.
This is useful as a nuclear option, but most of the time you should try to use syncUntil.

Specified by:

syncPoint in interface TaskExecutorImpl