me.piggypiglet.framework.task

Class Task

java.lang.Object

me.piggypiglet.framework.task.Task

Direct Known Subclasses:

BukkitTask, BungeeTask, DefaultTask, NukkitTask, SpongeTaskManager, VelocityTask

public abstract class Task
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Task()

Method Summary

Modifier and Type	Method and Description
void	async(java.util.function.Consumer<GRunnable> task) Run a task async
void	async(java.util.function.Consumer<GRunnable> task, java.lang.String time, boolean repeat) Schedule a task to run after a specific amount of time, or every period of time.
protected abstract void	async(GRunnable task) Implementation of running a runnable async
protected abstract void	scheduleAsync(GRunnable task, sh.okx.timeapi.TimeAPI time, boolean repeat) Implementation of scheduling an async runnable
void	shutdown() Shutdown anything that needs to be shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

Task

public Task()

Method Detail

async

protected abstract void async(GRunnable task)

Implementation of running a runnable async

Parameters:

task - Runnable to run

async

public void async(java.util.function.Consumer<GRunnable> task)

Run a task async

Parameters:

task - Task to run

scheduleAsync

protected abstract void scheduleAsync(GRunnable task,
                                      sh.okx.timeapi.TimeAPI time,
                                      boolean repeat)

Implementation of scheduling an async runnable

Parameters:

task - Task to run

time - Time till it runs (or interval)

repeat - Whether the task should be on loop, or only run once.

async

public void async(java.util.function.Consumer<GRunnable> task,
                  java.lang.String time,
                  boolean repeat)

Schedule a task to run after a specific amount of time, or every period of time.

Parameters:

task - Task to run

time - Interval or initial delay the task will run at, uses human readable formatting. Available keys are as follows:

• Seconds:- s, sec, secs, second, seconds
• Minutes:- m, min, mins, minute, minutes
• Hours:- h, hr, hrs, hour, hours
• Days:- d, dy, dys, day, days
• Weeks:- w, week, weeks
• Months:- mo, mon, mnth, month, months
• Years:- y, yr, yrs, year, years

The following are examples of use:

• "10 secs 5 mins" - 10 seconds & 5 minutes
• "20m4w5hrs" - 20 minutes, 4 weeks & 5 hours

repeat - Whether to loop

shutdown

public void shutdown()

Shutdown anything that needs to be shutdown