org.spongepowered.api.scheduler

Interface Task

All Superinterfaces:

Identifiable

public interface Task
extends Identifiable

Represents a task that has been scheduled.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Task.Builder Represents a builder to create a Task.

Method Summary

Modifier and Type	Method and Description
static Task.Builder	builder() Creates a new Task.Builder to build a Task.
boolean	cancel() Cancels the task.
Consumer<Task>	getConsumer() Gets the Consumer<Task> that this task is running.
long	getDelay() Gets the delay that the task was scheduled to run after.
long	getInterval() Gets the interval for repeating tasks.
String	getName() Gets the name of this task.
PluginContainer	getOwner() Returns the plugin that scheduled this task.
boolean	isAsynchronous() Gets whether this task is asynchronous.

Methods inherited from interface org.spongepowered.api.util.Identifiable

getUniqueId

Method Detail

builder

static Task.Builder builder()

Creates a new Task.Builder to build a Task.

Returns:

The new builder

getName

String getName()

Gets the name of this task.

Returns:

The name of the task

getOwner

PluginContainer getOwner()

Returns the plugin that scheduled this task.

Returns:

The plugin that scheduled the task

getDelay

long getDelay()

Gets the delay that the task was scheduled to run after. A delay of 0 represents that the task started immediately.

Returns:

The delay (offset) in either milliseconds or ticks (ticks are exclusive to synchronous tasks)

getInterval

long getInterval()

Gets the interval for repeating tasks. An interval of 0 represents that the task does not repeat.

Returns:

The interval (period) in either milliseconds or ticks (ticks are exclusive to synchronous tasks)

cancel

boolean cancel()

Cancels the task. Cancelling a repeating task will prevent any further repetitions of the task.

Returns:

If the task is not running and was cancelled

getConsumer

Consumer<Task> getConsumer()

Gets the Consumer<Task> that this task is running.

Returns:

The consumer

isAsynchronous

boolean isAsynchronous()

Gets whether this task is asynchronous.

Returns:

True if asynchronous, false if synchronous