Package be.seeseemelk.mockbukkit.scheduler

Class ScheduledTask

java.lang.Object

be.seeseemelk.mockbukkit.scheduler.ScheduledTask

All Implemented Interfaces:

org.bukkit.scheduler.BukkitTask

Direct Known Subclasses:

RepeatingTask

public class ScheduledTask
extends Object
implements org.bukkit.scheduler.BukkitTask

Constructor Summary

Constructors

Constructor	Description
ScheduledTask(int id, org.bukkit.plugin.Plugin plugin, boolean isSync, long scheduledTick, @NotNull Runnable runnable)
ScheduledTask(int id, org.bukkit.plugin.Plugin plugin, boolean isSync, long scheduledTick, @NotNull Consumer<org.bukkit.scheduler.BukkitTask> consumer)

Method Summary

Modifier and Type	Method	Description
void	addOnCancelled(Runnable callback)	Adds a callback which is executed when the task is cancelled.
void	cancel()
Consumer<org.bukkit.scheduler.BukkitTask>	getConsumer()	Get the Consumer that will be run.
@NotNull org.bukkit.plugin.Plugin	getOwner()
Runnable	getRunnable()	Get the task itself that will be run.
long	getScheduledTick()	Get the tick at which the task is scheduled to run at.
int	getTaskId()
boolean	isCancelled()
boolean	isRunning()
boolean	isSync()
void	run()	Runs the task if it has not been cancelled.
void	setRunning(boolean running)
protected void	setScheduledTick(long scheduledTick)	Sets the tick at which the task is scheduled to run at.

Methods inherited from class java.lang.Object

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

Constructor Details

ScheduledTask

public ScheduledTask(int id,
 org.bukkit.plugin.Plugin plugin,
 boolean isSync,
 long scheduledTick,
 @NotNull
 @NotNull Runnable runnable)

ScheduledTask

public ScheduledTask(int id,
 org.bukkit.plugin.Plugin plugin,
 boolean isSync,
 long scheduledTick,
 @NotNull
 @NotNull Consumer<org.bukkit.scheduler.BukkitTask> consumer)

Method Details

isRunning

public boolean isRunning()

setRunning

public void setRunning(boolean running)

getScheduledTick

public long getScheduledTick()

Get the tick at which the task is scheduled to run at.

Returns:

The tick the task is scheduled to run at.

setScheduledTick

protected void setScheduledTick(long scheduledTick)

Sets the tick at which the task is scheduled to run at.

Parameters:

scheduledTick - The tick at which the task is scheduled to run at.

getRunnable

public Runnable getRunnable()

Get the task itself that will be run.

Returns:

The task that will be run.

getConsumer

public Consumer<org.bukkit.scheduler.BukkitTask> getConsumer()

Get the Consumer that will be run.

Returns:

The consumer that will be run.

run

public void run()

Runs the task if it has not been cancelled.

getTaskId

public int getTaskId()

Specified by:

getTaskId in interface org.bukkit.scheduler.BukkitTask

getOwner

@NotNull
public @NotNull org.bukkit.plugin.Plugin getOwner()

Specified by:

getOwner in interface org.bukkit.scheduler.BukkitTask

isSync

public boolean isSync()

Specified by:

isSync in interface org.bukkit.scheduler.BukkitTask

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface org.bukkit.scheduler.BukkitTask

cancel

public void cancel()

Specified by:

cancel in interface org.bukkit.scheduler.BukkitTask

addOnCancelled

public void addOnCancelled(Runnable callback)

Adds a callback which is executed when the task is cancelled.

Parameters:

callback - The callback which gets executed when the task is cancelled.