Package org.springframework.boot.cli.command

Class CommandException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.springframework.boot.cli.command.CommandException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

NoHelpCommandArgumentsException, NoSuchCommandException, ShellExitException

public class CommandException
extends RuntimeException

Runtime exception wrapper that defines additional CommandException.Options that are understood by the CommandRunner.

Since:

1.0.0

Author:

Phillip Webb

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CommandException.Option	Specific options understood by the CommandRunner.

Constructor Summary

Constructors

Constructor	Description
CommandException(String message, Throwable cause, CommandException.Option... options)	Create a new CommandException with the specified options.
CommandException(String message, CommandException.Option... options)	Create a new CommandException with the specified options.
CommandException(Throwable cause, CommandException.Option... options)	Create a new CommandException with the specified options.
CommandException(CommandException.Option... options)	Create a new CommandException with the specified options.

Method Summary

Modifier and Type	Method	Description
Set<CommandException.Option>	getOptions()	Returns a set of options that are understood by the CommandRunner.

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

Constructor Details

CommandException

public CommandException(CommandException.Option... options)

Create a new CommandException with the specified options.

Parameters:

options - the exception options

CommandException

public CommandException(String message,
 CommandException.Option... options)

Create a new CommandException with the specified options.

Parameters:

message - the exception message to display to the user

options - the exception options

CommandException

public CommandException(String message,
 Throwable cause,
 CommandException.Option... options)

Create a new CommandException with the specified options.

Parameters:

message - the exception message to display to the user

cause - the underlying cause

options - the exception options

CommandException

public CommandException(Throwable cause,
 CommandException.Option... options)

Create a new CommandException with the specified options.

Parameters:

cause - the underlying cause

options - the exception options

Method Details

getOptions

public Set<CommandException.Option> getOptions()

Returns a set of options that are understood by the CommandRunner.

Returns:

the options understood by the runner