revxrsal.commands.exception

Class CommandErrorException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

revxrsal.commands.exception.SendableException

revxrsal.commands.exception.CommandErrorException

All Implemented Interfaces:

java.io.Serializable

public class CommandErrorException
extends SendableException

Represents a command error, for example when an invalid value is returned, a condition is violated, or an illegal value is inputted, and validated through a parameter validator.

This exception should be used to directly transfer error messages to the CommandActor, and is always used in command-fail contexts. For exceptions that only reply to the actor, see SendMessageException.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CommandErrorException() Constructs a new CommandErrorException that does not send any message.
CommandErrorException(java.lang.String message, java.lang.Object... arguments) Constructs a new CommandErrorException with an inferred actor

Method Summary

Modifier and Type	Method and Description
void	sendTo(@NotNull CommandActor actor) Sends the message to the given actor

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

CommandErrorException

public CommandErrorException()

Constructs a new CommandErrorException that does not send any message.

Use this constructor if you would like to implement your own messaging system instead of relying on CommandActor.error(String).

CommandErrorException

public CommandErrorException(java.lang.String message,
                             java.lang.Object... arguments)

Constructs a new CommandErrorException with an inferred actor

Parameters:

message - Message to send

Method Detail

sendTo

public void sendTo(@NotNull
                   @NotNull CommandActor actor)

Sends the message to the given actor

Specified by:

sendTo in class SendableException

Parameters:

actor - Actor to send to