Package com.velocitypowered.api.scheduler

Enum Class TaskStatus

java.lang.Object

java.lang.Enum<TaskStatus>

com.velocitypowered.api.scheduler.TaskStatus

All Implemented Interfaces:

Serializable, Comparable<TaskStatus>, Constable

public enum TaskStatus
extends Enum<TaskStatus>

Enumerates all possible task statuses.

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
CANCELLED	The task was cancelled with ScheduledTask.cancel().
FINISHED	The task has run to completion.
SCHEDULED	The task is scheduled and is currently running.

Method Summary

Modifier and Type	Method	Description
static TaskStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TaskStatus[]	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

SCHEDULED

public static final TaskStatus SCHEDULED

The task is scheduled and is currently running.

CANCELLED

public static final TaskStatus CANCELLED

The task was cancelled with ScheduledTask.cancel().

FINISHED

public static final TaskStatus FINISHED

The task has run to completion. This is applicable only for tasks without a repeat.

Method Details

values

public static TaskStatus[] 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 TaskStatus 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