com.sk89q.intake

Class CommandException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.sk89q.intake.CommandException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

InvalidUsageException, InvocationCommandException

public class CommandException
extends Exception

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CommandException() Constructs a new exception with null as its detail message.
CommandException(String message) Constructs a new exception with the specified detail message.
CommandException(String message, Throwable cause) Constructs a new exception with the specified detail message and cause.
CommandException(Throwable cause) Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

Method Summary

Modifier and Type	Method and Description
String	getCommandUsed(String prefix, String spacedSuffix) Gets the command that was called, which will include the sub-command (i.e.
void	prependStack(String name) Add the command to the stack of commands that are a parent to the command that was called.

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 Detail

CommandException

public CommandException()

Constructs a new exception with null as its detail message. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).

CommandException

public CommandException(String message)

Constructs a new exception with the specified detail message. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).

Parameters:

message - the detail message. The detail message is saved for later retrieval by the Throwable.getMessage() method.

CommandException

public CommandException(String message,
                        Throwable cause)

Constructs a new exception with the specified detail message and cause.

Note that the detail message associated with cause is not automatically incorporated in this exception's detail message.

Parameters:

message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

CommandException

public CommandException(Throwable cause)

Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

Parameters:

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

Method Detail

prependStack

public void prependStack(String name)

Add the command to the stack of commands that are a parent to the command that was called.

Parameters:

name - the parent command

getCommandUsed

public String getCommandUsed(String prefix,
                             @Nullable
                             String spacedSuffix)

Gets the command that was called, which will include the sub-command (i.e. "/br sphere").

Parameters:

prefix - the command shebang character (such as "/") -- may be empty

spacedSuffix - a suffix to put at the end (optional) -- may be null

Returns:

the command that was used