me.lucko.helper.command

Class CommandInterruptException

java.lang.Object

java.lang.Throwable

java.lang.Exception

me.lucko.helper.command.CommandInterruptException

All Implemented Interfaces:

Serializable

public class CommandInterruptException
extends Exception

Exception thrown when the handling of a command should be interrupted.

This exception is silently swallowed by the command processing handler.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CommandInterruptException(Consumer<org.bukkit.command.CommandSender> action)
CommandInterruptException(String message)

Method Summary

Modifier and Type	Method and Description
Consumer<org.bukkit.command.CommandSender>	getAction()
static void	makeAssertion(boolean condition, String failMsg) Makes an assertion about a condition.

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

CommandInterruptException

public CommandInterruptException(Consumer<org.bukkit.command.CommandSender> action)

CommandInterruptException

public CommandInterruptException(String message)

Method Detail

makeAssertion

public static void makeAssertion(boolean condition,
                                 String failMsg)
                          throws CommandInterruptException

Makes an assertion about a condition.

When used inside a command, command processing will be gracefully halted if the condition is not true.

Parameters:

condition - the condition

failMsg - the message to send to the player if the assertion fails

Throws:

CommandInterruptException - if the assertion fails

getAction

public Consumer<org.bukkit.command.CommandSender> getAction()