Package dev.polv.taleapi.command

Class CommandException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

dev.polv.taleapi.command.CommandException

All Implemented Interfaces:

Serializable

public class CommandException
extends RuntimeException

Exception thrown when a command fails to execute or parse.

This exception can be thrown by CommandExecutor implementations or during command parsing to indicate various failure conditions.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CommandException.Type	The type of command exception.

Constructor Summary

Constructors

Constructor	Description
CommandException(String message)	Creates a new CommandException with a message.
CommandException(String message, CommandException.Type type)	Creates a new CommandException with a message and type.
CommandException(String message, Throwable cause)	Creates a new CommandException with a message and cause.
CommandException(String message, Throwable cause, CommandException.Type type)	Creates a new CommandException with a message, cause, and type.

Method Summary

Modifier and Type	Method	Description
static CommandException	argument(String argument, String message)	Creates an argument exception indicating an invalid argument.
CommandException.Type	getType()	Returns the type of this exception.
static CommandException	permission(String permission)	Creates a permission exception indicating missing permissions.
static CommandException	syntax(String message)	Creates a syntax exception indicating invalid command syntax.

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(String message)

Creates a new CommandException with a message.

Parameters:

message - the error message

CommandException

public CommandException(String message,
 Throwable cause)

Creates a new CommandException with a message and cause.

Parameters:

message - the error message

cause - the underlying cause

CommandException

public CommandException(String message,
 CommandException.Type type)

Creates a new CommandException with a message and type.

Parameters:

message - the error message

type - the exception type

CommandException

public CommandException(String message,
 Throwable cause,
 CommandException.Type type)

Creates a new CommandException with a message, cause, and type.

Parameters:

message - the error message

cause - the underlying cause

type - the exception type

Method Details

getType

public CommandException.Type getType()

Returns the type of this exception.

Returns:

the exception type

syntax

public static CommandException syntax(String message)

Creates a syntax exception indicating invalid command syntax.

Parameters:

message - the error message

Returns:

a new CommandException of type SYNTAX

permission

public static CommandException permission(String permission)

Creates a permission exception indicating missing permissions.

Parameters:

permission - the missing permission

Returns:

a new CommandException of type PERMISSION

argument

public static CommandException argument(String argument,
 String message)

Creates an argument exception indicating an invalid argument.

Parameters:

argument - the argument name

message - the error message

Returns:

a new CommandException of type ARGUMENT