revxrsal.commands.exception

Class SendMessageException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

revxrsal.commands.exception.SendableException

revxrsal.commands.exception.SendMessageException

All Implemented Interfaces:

java.io.Serializable

public class SendMessageException
extends SendableException

Used to directly send-and-return a message to the command actor.

This exception should be used to directly transfer messages to the CommandActor, however should not be used in command-fail contexts. To signal an error to the actor, use CommandErrorException.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SendMessageException() Constructs a new SendMessageException that does not send any message.
SendMessageException(java.lang.String message) Constructs a new SendMessageException 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

SendMessageException

public SendMessageException()

Constructs a new SendMessageException that does not send any message.

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

SendMessageException

public SendMessageException(java.lang.String message)

Constructs a new SendMessageException 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