Package ca.spottedleaf.concurrentutil.executor.queue

Class PrioritisedTaskQueue

java.lang.Object

ca.spottedleaf.concurrentutil.executor.queue.PrioritisedTaskQueue

All Implemented Interfaces:

PrioritisedExecutor

public final class PrioritisedTaskQueue
extends Object
implements PrioritisedExecutor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	PrioritisedTaskQueue.PrioritySubOrderPair

Nested classes/interfaces inherited from interface ca.spottedleaf.concurrentutil.executor.PrioritisedExecutor

PrioritisedExecutor.PrioritisedTask

Constructor Summary

Constructors

Constructor	Description
PrioritisedTaskQueue()

Method Summary

Modifier and Type	Method	Description
PrioritisedExecutor.PrioritisedTask	createTask(Runnable task)	Creates, but does not queue or execute, a task at Priority.NORMAL priority.
PrioritisedExecutor.PrioritisedTask	createTask(Runnable task, Priority priority)	Creates, but does not queue or execute, a task at Priority.NORMAL priority.
PrioritisedExecutor.PrioritisedTask	createTask(Runnable task, Priority priority, long subOrder)	Creates, but does not queue or execute, a task at Priority.NORMAL priority.
boolean	executeTask()	Executes the next available task.
long	generateNextSubOrder()	Generates the next suborder id.
Priority	getHighestPriority()
PrioritisedTaskQueue.PrioritySubOrderPair	getHighestPrioritySubOrder()
long	getTotalTasksExecuted()	Returns the number of tasks that have been executed.
long	getTotalTasksScheduled()	Returns the number of tasks that have been scheduled are pending to be scheduled.
boolean	hasNoScheduledTasks()
boolean	isShutdown()	Returns whether this executor has shut down.
PrioritisedExecutor.PrioritisedTask	peekFirst()
Runnable	pollTask()
PrioritisedExecutor.PrioritisedTask	queueTask(Runnable task)	Queues or executes a task at Priority.NORMAL priority.
PrioritisedExecutor.PrioritisedTask	queueTask(Runnable task, Priority priority)	Queues or executes a task.
PrioritisedExecutor.PrioritisedTask	queueTask(Runnable task, Priority priority, long subOrder)	Queues or executes a task.
boolean	shutdown()	Prevent further additions to this executor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PrioritisedTaskQueue

public PrioritisedTaskQueue()

Method Details

getTotalTasksScheduled

public long getTotalTasksScheduled()

Description copied from interface: PrioritisedExecutor

Returns the number of tasks that have been scheduled are pending to be scheduled.

Specified by:

getTotalTasksScheduled in interface PrioritisedExecutor

getTotalTasksExecuted

public long getTotalTasksExecuted()

Description copied from interface: PrioritisedExecutor

Returns the number of tasks that have been executed.

Specified by:

getTotalTasksExecuted in interface PrioritisedExecutor

generateNextSubOrder

public long generateNextSubOrder()

Description copied from interface: PrioritisedExecutor

Generates the next suborder id.

Specified by:

generateNextSubOrder in interface PrioritisedExecutor

Returns:

The next suborder id.

shutdown

public boolean shutdown()

Description copied from interface: PrioritisedExecutor

Prevent further additions to this executor. Attempts to add after this call has completed (potentially during) will result in IllegalStateException being thrown.

This operation is atomic with respect to other shutdown calls

After this call has completed, regardless of return value, this executor will be shutdown.

Specified by:

shutdown in interface PrioritisedExecutor

Returns:

true if the executor was shutdown, false if it has shut down already

See Also:

• PrioritisedExecutor.isShutdown()

isShutdown

public boolean isShutdown()

Description copied from interface: PrioritisedExecutor

Returns whether this executor has shut down. Effectively, returns whether new tasks will be rejected. This method does not indicate whether all the tasks scheduled have been executed.

Specified by:

isShutdown in interface PrioritisedExecutor

Returns:

Returns whether this executor has shut down.

peekFirst

public PrioritisedExecutor.PrioritisedTask peekFirst()

getHighestPriority

public Priority getHighestPriority()

hasNoScheduledTasks

public boolean hasNoScheduledTasks()

getHighestPrioritySubOrder

public PrioritisedTaskQueue.PrioritySubOrderPair getHighestPrioritySubOrder()

pollTask

public Runnable pollTask()

executeTask

public boolean executeTask()

Description copied from interface: PrioritisedExecutor

Executes the next available task.

If there is a task with priority Priority.BLOCKING available, then that such task is executed.

If there is a task with priority Priority.IDLE available then that task is only executed when there are no other tasks available with a higher priority.

If there are no tasks that have priority Priority.BLOCKING or Priority.IDLE, then this function will be biased to execute tasks that have higher priorities.

Specified by:

executeTask in interface PrioritisedExecutor

Returns:

true if a task was executed, false otherwise

createTask

public PrioritisedExecutor.PrioritisedTask createTask(Runnable task)

Description copied from interface: PrioritisedExecutor

Creates, but does not queue or execute, a task at Priority.NORMAL priority.

Specified by:

createTask in interface PrioritisedExecutor

Parameters:

task - The task to run.

Returns:

null if the current thread immediately executed the task, else returns the prioritised task associated with the parameter

createTask

public PrioritisedExecutor.PrioritisedTask createTask(Runnable task,
 Priority priority)

Description copied from interface: PrioritisedExecutor

Creates, but does not queue or execute, a task at Priority.NORMAL priority.

Specified by:

createTask in interface PrioritisedExecutor

Parameters:

task - The task to run.

priority - The priority for the task.

Returns:

null if the current thread immediately executed the task, else returns the prioritised task associated with the parameter

createTask

public PrioritisedExecutor.PrioritisedTask createTask(Runnable task,
 Priority priority,
 long subOrder)

Description copied from interface: PrioritisedExecutor

Creates, but does not queue or execute, a task at Priority.NORMAL priority.

Specified by:

createTask in interface PrioritisedExecutor

Parameters:

task - The task to run.

priority - The priority for the task.

subOrder - The task's suborder.

Returns:

null if the current thread immediately executed the task, else returns the prioritised task associated with the parameter

queueTask

public PrioritisedExecutor.PrioritisedTask queueTask(Runnable task)

Description copied from interface: PrioritisedExecutor

Queues or executes a task at Priority.NORMAL priority.

Specified by:

queueTask in interface PrioritisedExecutor

Parameters:

task - The task to run.

Returns:

null if the current thread immediately executed the task, else returns the prioritised task associated with the parameter

queueTask

public PrioritisedExecutor.PrioritisedTask queueTask(Runnable task,
 Priority priority)

Description copied from interface: PrioritisedExecutor

Queues or executes a task.

Specified by:

queueTask in interface PrioritisedExecutor

Parameters:

task - The task to run.

priority - The priority for the task.

Returns:

null if the current thread immediately executed the task, else returns the prioritised task associated with the parameter

queueTask

public PrioritisedExecutor.PrioritisedTask queueTask(Runnable task,
 Priority priority,
 long subOrder)

Description copied from interface: PrioritisedExecutor

Queues or executes a task.

Specified by:

queueTask in interface PrioritisedExecutor

Parameters:

task - The task to run.

priority - The priority for the task.

subOrder - The task's suborder.

Returns:

null if the current thread immediately executed the task, else returns the prioritised task associated with the parameter