org.threadly.concurrent

Enum TaskPriority

java.lang.Object

java.lang.Enum<TaskPriority>

org.threadly.concurrent.TaskPriority

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TaskPriority>

public enum TaskPriority
extends java.lang.Enum<TaskPriority>

Priority to go with tasks when being submitted into implementations of PrioritySchedulerService.

This priority has nothing to do with the system level thread priority. Instead this only represents a priority within the thread pool start a task.

Since:

1.0.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
High High priority tasks should be executed as soon as possible within the thread pool.
Low Low priority tasks are as the name indicates lower priority compared to high priority task.
Starvable This priority is never guaranteed to run.

Method Summary

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

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

High

public static final TaskPriority High

High priority tasks should be executed as soon as possible within the thread pool.

Low

public static final TaskPriority Low

Low priority tasks are as the name indicates lower priority compared to high priority task. It is up to the implementer of the PrioritySchedulerService as to how this priority is enforced.

A generalization for low priority tasks is that they should not be dependent on an accurate execution time.

Starvable

public static final TaskPriority Starvable

This priority is never guaranteed to run. It will only run if there is no High or Low available to run. If there is another task ready to be ran, this task will be infinitely delayed until there is truly nothing left to run.

Method Detail

values

public static TaskPriority[] 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 (TaskPriority c : TaskPriority.values())
    System.out.println(c);

Returns:

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

valueOf

public static TaskPriority valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null