Package io.papermc.paper.threadedregions.scheduler

Enum Class ScheduledTask.CancelledState

java.lang.Object

java.lang.Enum<ScheduledTask.CancelledState>

io.papermc.paper.threadedregions.scheduler.ScheduledTask.CancelledState

All Implemented Interfaces:

Serializable, Comparable<ScheduledTask.CancelledState>, Constable

Enclosing interface:

ScheduledTask

public static enum ScheduledTask.CancelledState
extends Enum<ScheduledTask.CancelledState>

Represents the result of attempting to cancel a task.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALREADY_EXECUTED	The task is not a repeating task, and could not be cancelled because the task has already finished execution.
CANCELLED_ALREADY	The task (repeating or not) is already cancelled.
CANCELLED_BY_CALLER	The task (repeating or not) has been successfully cancelled by the caller thread.
NEXT_RUNS_CANCELLED	The caller thread successfully stopped future executions of a repeating task, but the task is currently being executed.
NEXT_RUNS_CANCELLED_ALREADY	The repeating task's future executions are cancelled already, but the task is currently being executed.
RUNNING	The task is not a repeating task, and could not be cancelled because the task is being executed.

Method Summary

Modifier and Type	Method	Description
static ScheduledTask.CancelledState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ScheduledTask.CancelledState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CANCELLED_BY_CALLER

public static final ScheduledTask.CancelledState CANCELLED_BY_CALLER

The task (repeating or not) has been successfully cancelled by the caller thread. The task is not executing currently, and it will not begin execution in the future.

CANCELLED_ALREADY

public static final ScheduledTask.CancelledState CANCELLED_ALREADY

The task (repeating or not) is already cancelled. The task is not executing currently, and it will not begin execution in the future.

RUNNING

public static final ScheduledTask.CancelledState RUNNING

The task is not a repeating task, and could not be cancelled because the task is being executed.

ALREADY_EXECUTED

public static final ScheduledTask.CancelledState ALREADY_EXECUTED

The task is not a repeating task, and could not be cancelled because the task has already finished execution.

NEXT_RUNS_CANCELLED

public static final ScheduledTask.CancelledState NEXT_RUNS_CANCELLED

The caller thread successfully stopped future executions of a repeating task, but the task is currently being executed.

NEXT_RUNS_CANCELLED_ALREADY

public static final ScheduledTask.CancelledState NEXT_RUNS_CANCELLED_ALREADY

The repeating task's future executions are cancelled already, but the task is currently being executed.

Method Details

values

public static ScheduledTask.CancelledState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ScheduledTask.CancelledState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null