Enum TaskStatus
- java.lang.Object
-
- java.lang.Enum<TaskStatus>
-
- com.velocitypowered.api.scheduler.TaskStatus
-
- All Implemented Interfaces:
Serializable
,Comparable<TaskStatus>
public enum TaskStatus extends Enum<TaskStatus>
Enumerates all possible task statuses.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CANCELLED
The task was cancelled withScheduledTask.cancel()
.FINISHED
The task has run to completion.SCHEDULED
The task is scheduled and is currently running.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static TaskStatus
valueOf(String name)
Returns the enum constant of this type with the specified name.static TaskStatus[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
SCHEDULED
public static final TaskStatus SCHEDULED
The task is scheduled and is currently running.
-
CANCELLED
public static final TaskStatus CANCELLED
The task was cancelled withScheduledTask.cancel()
.
-
FINISHED
public static final TaskStatus FINISHED
The task has run to completion. This is applicable only for tasks without a repeat.
-
-
Method Detail
-
values
public static TaskStatus[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (TaskStatus c : TaskStatus.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static TaskStatus valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified nameNullPointerException
- if the argument is null
-
-