Package com.tnsai.tools.spi

Class ToolUserCanceledException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.tnsai.exceptions.TnsAIException

com.tnsai.tools.spi.ToolException

com.tnsai.tools.spi.ToolUserCanceledException

All Implemented Interfaces:

Serializable

public class ToolUserCanceledException
extends ToolException

Tool execution was canceled by the user — confirmation prompt declined, deadline elapsed before the user responded, or an explicit abort signal. Non-retryable: silently retrying would defeat the user's choice.

Since:

0.5.0 (issue #88)

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ToolUserCanceledException.CancelReason	Why the user-facing cancellation happened.

Nested classes/interfaces inherited from class com.tnsai.tools.spi.ToolException

ToolException.Builder, ToolException.ErrorType

Constructor Summary

Constructors

Constructor	Description
ToolUserCanceledException(String toolName, ToolUserCanceledException.CancelReason reason)

Method Summary

Modifier and Type	Method	Description
String	getErrorCode()	Gets the error code for this exception type.
ToolUserCanceledException.CancelReason	getReason()

Methods inherited from class com.tnsai.tools.spi.ToolException

apiError, builder, configurationError, getAttribute, getAttributes, getDetailedMessage, getErrorType, getHttpStatusCode, getQuery, getTimestamp, getToolName, isRetryable, networkError, parseError, timeout, toString, validationError

Methods inherited from class com.tnsai.exceptions.TnsAIException

getContext, getMaxRetryAttempts, getMessage, getSuggestedRetryDelayMs, getThrownAt, wrap

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ToolUserCanceledException

public ToolUserCanceledException(String toolName,
 ToolUserCanceledException.CancelReason reason)

Method Details

getReason

public ToolUserCanceledException.CancelReason getReason()

getErrorCode

public String getErrorCode()

Description copied from class: TnsAIException

Gets the error code for this exception type. Format: TNSAI-XXX where XXX is derived from class name.

Overrides:

getErrorCode in class TnsAIException