Package com.tnsai.tools.spi

Enum Class ToolUserCanceledException.CancelReason

java.lang.Object

java.lang.Enum<ToolUserCanceledException.CancelReason>

com.tnsai.tools.spi.ToolUserCanceledException.CancelReason

All Implemented Interfaces:

Serializable, Comparable<ToolUserCanceledException.CancelReason>, Constable

Enclosing class:

ToolUserCanceledException

public static enum ToolUserCanceledException.CancelReason
extends Enum<ToolUserCanceledException.CancelReason>

Why the user-facing cancellation happened.

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
CONFIRMATION_DENIED	User saw a confirmation prompt and declined.
DEADLINE_EXCEEDED	Confirmation prompt timed out without a response.
EXPLICIT_ABORT	Explicit cancel signal from the host (Ctrl-C, abort button, etc.).

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CONFIRMATION_DENIED

public static final ToolUserCanceledException.CancelReason CONFIRMATION_DENIED

User saw a confirmation prompt and declined.

DEADLINE_EXCEEDED

public static final ToolUserCanceledException.CancelReason DEADLINE_EXCEEDED

Confirmation prompt timed out without a response.

EXPLICIT_ABORT

public static final ToolUserCanceledException.CancelReason EXPLICIT_ABORT

Explicit cancel signal from the host (Ctrl-C, abort button, etc.).

Method Details

values

public static ToolUserCanceledException.CancelReason[] 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 ToolUserCanceledException.CancelReason 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