Package software.amazon.smithy.cli

Class CliError

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

software.amazon.smithy.cli.CliError

All Implemented Interfaces:

Serializable

public final class CliError
extends RuntimeException

Throw this exception to cause the CLI to exit with a message and code.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
final int	code

Constructor Summary

Constructors

Constructor	Description
CliError(String message)	Exits the CLI with a message and an error code of 1.
CliError(String message, int code)
CliError(String message, int code, Throwable previous)

Method Summary

Modifier and Type	Method	Description
static CliError	wrap(Throwable e)	Wraps the given exception in a CliError (no wrapping is performed if the given exception is an instance of CliError).

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

code

public final int code

Constructor Details

CliError

public CliError(String message)

Exits the CLI with a message and an error code of 1.

Parameters:

message - Message to output.

CliError

public CliError(String message,
 int code)

Parameters:

message - Message to use in the exception.

code - Exit code to set.

CliError

public CliError(String message,
 int code,
 Throwable previous)

Parameters:

message - Message to use in the exception.

code - Exit code to set.

previous - Previous exception.

Method Details

wrap

public static CliError wrap(Throwable e)

Wraps the given exception in a CliError (no wrapping is performed if the given exception is an instance of CliError).

Parameters:

e - Exception to wrap.

Returns:

Returns the wrapped exception.