Package cloud.commandframework.exceptions

Class InvalidSyntaxException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IllegalArgumentException

cloud.commandframework.exceptions.CommandParseException

cloud.commandframework.exceptions.InvalidSyntaxException

All Implemented Interfaces:

Serializable

@API(status=STABLE)
public class InvalidSyntaxException
extends CommandParseException

Exception sent when a command sender inputs invalid command syntax

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
InvalidSyntaxException(@NonNull String correctSyntax, @NonNull Object commandSender, @NonNull List<@NonNull CommandArgument<?,?>> currentChain)	Create a new invalid syntax exception instance

Method Summary

Modifier and Type	Method	Description
@NonNull String	getCorrectSyntax()	Get the correct syntax of the command
final String	getMessage()

Methods inherited from class cloud.commandframework.exceptions.CommandParseException

getCommandSender, getCurrentChain

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, 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

InvalidSyntaxException

@API(status=INTERNAL,
     consumers="cloud.commandframework.*")
public InvalidSyntaxException(@NonNull String correctSyntax,
 @NonNull Object commandSender,
 @NonNull List<@NonNull CommandArgument<?,?>> currentChain)

Create a new invalid syntax exception instance

Parameters:

correctSyntax - Expected syntax

commandSender - Sender that sent the command

currentChain - Chain leading up to issue

Method Details

getCorrectSyntax

public @NonNull String getCorrectSyntax()

Get the correct syntax of the command

Returns:

Correct command syntax

getMessage

public final String getMessage()

Overrides:

getMessage in class Throwable