Package com.inductiveautomation.perspective.gateway.threading

Enum Class BlockingTaskQueue.ShutdownBehavior

java.lang.Object

java.lang.Enum<BlockingTaskQueue.ShutdownBehavior>

com.inductiveautomation.perspective.gateway.threading.BlockingTaskQueue.ShutdownBehavior

All Implemented Interfaces:

Serializable, Comparable<BlockingTaskQueue.ShutdownBehavior>, Constable

Enclosing class:

BlockingTaskQueue

public static enum BlockingTaskQueue.ShutdownBehavior
extends Enum<BlockingTaskQueue.ShutdownBehavior>

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
CANCEL_PENDING	On shutdown, all pending but not-yet-executing tasks will be cancelled, their futures completing exceptionally with a QueueShutdownException
CANCEL_RUNNING	On shutdown, all pending and executing tasks will be cancelled, their futures completing exceptionally with a QueueShutdownException
FLUSH_PENDING	On shutdown, all currently executing/pending tasks will run to completion, but no new tasks may be submitted.

Method Summary

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

FLUSH_PENDING

public static final BlockingTaskQueue.ShutdownBehavior FLUSH_PENDING

On shutdown, all currently executing/pending tasks will run to completion, but no new tasks may be submitted.

CANCEL_PENDING

public static final BlockingTaskQueue.ShutdownBehavior CANCEL_PENDING

On shutdown, all pending but not-yet-executing tasks will be cancelled, their futures completing exceptionally with a QueueShutdownException

CANCEL_RUNNING

public static final BlockingTaskQueue.ShutdownBehavior CANCEL_RUNNING

On shutdown, all pending and executing tasks will be cancelled, their futures completing exceptionally with a QueueShutdownException

Method Details

values

public static BlockingTaskQueue.ShutdownBehavior[] 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 BlockingTaskQueue.ShutdownBehavior 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