Package de.eldoria.eldoutilities.scheduling

Class DelayedActions

java.lang.Object

de.eldoria.eldoutilities.threading.ReschedulingTask

de.eldoria.eldoutilities.scheduling.QueuingSelfSchedulingTask<DelayedActions.DelayedTask>

de.eldoria.eldoutilities.scheduling.DelayedActions

public final class DelayedActions
extends QueuingSelfSchedulingTask<DelayedActions.DelayedTask>

Scheduler service to schedule actions with only one scheduler and preserving the main thread from overloading.

Since:

1.2.3

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	DelayedActions.DelayedTask

Field Summary

Fields inherited from class de.eldoria.eldoutilities.scheduling.QueuingSelfSchedulingTask

DEFAULT_MAX_DURATION_TARGET, DEFAULT_MAX_IDLE_TICKS

Method Summary

Modifier and Type	Method	Description
void	execute(DelayedActions.DelayedTask object)	handle one object which was polled from the queue
protected Queue<DelayedActions.DelayedTask>	getQueueImplementation()
protected boolean	proceed(DelayedActions.DelayedTask object)	Define if this object should be polled from queue or if the scheduler should proceed to the next tick.
void	schedule(Runnable runnable, int delay)	Delays an action by a specific amount of ticks
static DelayedActions	start(Plugin plugin)	Start a delayed action scheduler for a plugin.
void	tick()	Tick is executed once per tick.

Methods inherited from class de.eldoria.eldoutilities.scheduling.QueuingSelfSchedulingTask

clear, remove, removeIf, run, schedule, shutdown

Methods inherited from class de.eldoria.eldoutilities.threading.ReschedulingTask

cancel, getPlugin, isActive, isRunning, schedule

Methods inherited from class java.lang.Object

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

Method Details

start

public static DelayedActions start(Plugin plugin)

Start a delayed action scheduler for a plugin.

This scheduler allows to schedule multiple task without starting a new scheduler for each task.

The scheduler will also ensure that the main thread is not abused by overloading operations per tick.

Parameters:

plugin - plugin which owns the instance

Returns:

new delayed action instance

execute

public void execute(DelayedActions.DelayedTask object)

Description copied from class: QueuingSelfSchedulingTask

handle one object which was polled from the queue

Specified by:

execute in class QueuingSelfSchedulingTask<DelayedActions.DelayedTask>

Parameters:

object - object from queue

tick

public void tick()

Description copied from class: QueuingSelfSchedulingTask

Tick is executed once per tick.

Overrides:

tick in class QueuingSelfSchedulingTask<DelayedActions.DelayedTask>

getQueueImplementation

protected Queue<DelayedActions.DelayedTask> getQueueImplementation()

Overrides:

getQueueImplementation in class QueuingSelfSchedulingTask<DelayedActions.DelayedTask>

schedule

public void schedule(Runnable runnable,
 int delay)

Delays an action by a specific amount of ticks

Parameters:

runnable - runnable to execute

delay - delay for execution.

proceed

protected boolean proceed(DelayedActions.DelayedTask object)

Description copied from class: QueuingSelfSchedulingTask

Define if this object should be polled from queue or if the scheduler should proceed to the next tick.

Overrides:

proceed in class QueuingSelfSchedulingTask<DelayedActions.DelayedTask>

Parameters:

object - object to check

Returns:

true if the object should be handeld. false if the task should wait.