Interface ScheduledTask

public interface ScheduledTask

Represents a task scheduled to a scheduler.

Since:

1.20.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ScheduledTask.CancelledState	Represents the result of attempting to cancel a task.
static enum	ScheduledTask.ExecutionState	Represents the current execution state of the task.

Method Summary

Modifier and Type	Method	Description
@NotNull ScheduledTask.CancelledState	cancel()	Attempts to cancel this task, returning the result of the attempt.
@NotNull ScheduledTask.ExecutionState	getExecutionState()	Returns the current execution state of this task.
@NotNull Plugin	getOwningPlugin()	Returns the plugin that scheduled this task.
default boolean	isCancelled()	Returns whether the current execution state is ScheduledTask.ExecutionState.CANCELLED or ScheduledTask.ExecutionState.CANCELLED_RUNNING.
boolean	isRepeatingTask()	Returns whether this task executes on a fixed period, as opposed to executing only once.

Method Details

getOwningPlugin

@NotNull
@NotNull Plugin getOwningPlugin()

Returns the plugin that scheduled this task.

Returns:

the plugin that scheduled this task.

Since:

1.20.1

isRepeatingTask

boolean isRepeatingTask()

Returns whether this task executes on a fixed period, as opposed to executing only once.

Returns:

whether this task executes on a fixed period, as opposed to executing only once.

Since:

1.20.1

cancel

@NotNull
@NotNull ScheduledTask.CancelledState cancel()

Attempts to cancel this task, returning the result of the attempt. In all cases, if the task is currently being executed no attempt is made to halt the task, however any executions in the future are halted.

Returns:

the result of the cancellation attempt.

Since:

1.20.1

getExecutionState

@NotNull
@NotNull ScheduledTask.ExecutionState getExecutionState()

Returns the current execution state of this task.

Returns:

the current execution state of this task.

Since:

1.20.1

isCancelled

default boolean isCancelled()

Returns whether the current execution state is ScheduledTask.ExecutionState.CANCELLED or ScheduledTask.ExecutionState.CANCELLED_RUNNING.

Returns:

whether the current execution state is ScheduledTask.ExecutionState.CANCELLED or ScheduledTask.ExecutionState.CANCELLED_RUNNING.

Since:

1.20.1