Package org.spongepowered.api.command.exception

Class CommandException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.spongepowered.api.util.ComponentMessageException

org.spongepowered.api.command.exception.CommandException

All Implemented Interfaces:

Serializable, ComponentMessageThrowable

Direct Known Subclasses:

ArgumentParseException, CommandNotFoundException, CommandPermissionException, InvocationCommandException

public class CommandException
extends ComponentMessageException

Thrown when an executed command raises an error or when execution of the command failed.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CommandException(@Nullable Component message)	Constructs a new CommandException with the given message.
CommandException(@Nullable Component message, boolean includeUsage)	Constructs a new CommandException with the given message.
CommandException(@Nullable Component message, Throwable cause)	Constructs a new CommandException with the given message and the given cause.
CommandException(@Nullable Component message, Throwable cause, boolean includeUsage)	Constructs a new CommandException with the given message and the given cause.

Method Summary

Modifier and Type	Method	Description
boolean	shouldIncludeUsage()	Gets whether the exception should include usage in the presentation of the exception/stack-trace.

Methods inherited from class org.spongepowered.api.util.ComponentMessageException

componentMessage, getLocalizedMessage, getMessage

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, 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(@Nullable Component message)

Constructs a new CommandException with the given message.

Parameters:

message - The detail message

CommandException

public CommandException(@Nullable Component message,
 Throwable cause)

Constructs a new CommandException with the given message and the given cause.

Parameters:

message - The detail message

cause - The cause

CommandException

public CommandException(@Nullable Component message,
 boolean includeUsage)

Constructs a new CommandException with the given message.

Parameters:

message - The detail message

includeUsage - Whether to include usage in the exception

CommandException

public CommandException(@Nullable Component message,
 Throwable cause,
 boolean includeUsage)

Constructs a new CommandException with the given message and the given cause.

Parameters:

message - The detail message

cause - The cause

includeUsage - Whether to include the usage in the exception

Method Details

shouldIncludeUsage

public boolean shouldIncludeUsage()

Gets whether the exception should include usage in the presentation of the exception/stack-trace.

Returns:

Whether to include usage in the exception