Enum BlockingTaskQueue.ShutdownBehavior
- java.lang.Object
-
- java.lang.Enum<BlockingTaskQueue.ShutdownBehavior>
-
- com.inductiveautomation.perspective.gateway.threading.BlockingTaskQueue.ShutdownBehavior
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<BlockingTaskQueue.ShutdownBehavior>
- Enclosing class:
- BlockingTaskQueue
public static enum BlockingTaskQueue.ShutdownBehavior extends java.lang.Enum<BlockingTaskQueue.ShutdownBehavior>
-
-
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 aQueueShutdownException
CANCEL_RUNNING
On shutdown, all pending and executing tasks will be cancelled, their futures completing exceptionally with aQueueShutdownException
FLUSH_PENDING
On shutdown, all currently executing/pending tasks will run to completion, but no new tasks may be submitted.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static BlockingTaskQueue.ShutdownBehavior
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static BlockingTaskQueue.ShutdownBehavior[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
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 aQueueShutdownException
-
CANCEL_RUNNING
public static final BlockingTaskQueue.ShutdownBehavior CANCEL_RUNNING
On shutdown, all pending and executing tasks will be cancelled, their futures completing exceptionally with aQueueShutdownException
-
-
Method Detail
-
values
public static BlockingTaskQueue.ShutdownBehavior[] 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 (BlockingTaskQueue.ShutdownBehavior c : BlockingTaskQueue.ShutdownBehavior.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static BlockingTaskQueue.ShutdownBehavior 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 namejava.lang.NullPointerException
- if the argument is null
-
-