CliEdgeCaseException class sealed

Base class for all standard-CLI edge-case exceptions.

Subclasses carry the metadata the audit and the help screen need to give the user a precise diagnostic. Every CliEdgeCaseException has a code (one of the CliExitCodes vocabulary names) and a details map for the JSON error shape.

Implemented types

• Exception

Implementers

• AmbiguousCommandException
• BindingException
• CircularReferenceException
• CommandAlreadyRegistered
• NonInteractiveContextException
• ReferencedAppMissingException
• UnknownCommandException
• VersionMismatchException

Available extensions

• ExceptionToFailure

Properties

code → String

The error code, one of the CliExitCodes vocabulary names as a string (e.g. 'notFound', 'conflict'). Used in the JSON error shape's code field and translated to the contract exit code by CliApp.

no setter

details → Map<String, Object?>

Additional context for the JSON error shape's details field.

no setter

hashCode → int

The hash code for this object.

no setter, inherited

message → String

Human-readable error message.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toFailure([StackTrace? stackTrace]) → AppFailure

Available on Exception, provided by the ExceptionToFailure extension

Convert this exception to an AppFailure

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited