Package dev.jorel.commandapi.arguments

Class CustomArgument.CustomArgumentException

java.lang.Object

java.lang.Throwable

java.lang.Exception

dev.jorel.commandapi.arguments.CustomArgument.CustomArgumentException

All Implemented Interfaces:

Serializable

Enclosing class:

CustomArgument<T,B>

public static class CustomArgument.CustomArgumentException
extends Exception

An exception used to create command-related errors for the CustomArgument

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CustomArgumentException(CustomArgument.MessageBuilder errorMessage)	Constructs a CustomArgumentException with a given error message
CustomArgumentException(String errorMessage)	Constructs a CustomArgumentException with a given error message

Method Summary

Modifier and Type	Method	Description
com.mojang.brigadier.exceptions.CommandSyntaxException	toCommandSyntax(String result, com.mojang.brigadier.context.CommandContext<?> cmdCtx)	Converts this CustomArgumentException into a CommandSyntaxException

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

CustomArgumentException

public CustomArgumentException(String errorMessage)

Constructs a CustomArgumentException with a given error message

Parameters:

errorMessage - the error message to display to the user when this exception is thrown

CustomArgumentException

public CustomArgumentException(CustomArgument.MessageBuilder errorMessage)

Constructs a CustomArgumentException with a given error message

Parameters:

errorMessage - the error message to display to the user when this exception is thrown

Method Details

toCommandSyntax

public com.mojang.brigadier.exceptions.CommandSyntaxException toCommandSyntax(String result,
 com.mojang.brigadier.context.CommandContext<?> cmdCtx)

Converts this CustomArgumentException into a CommandSyntaxException

Parameters:

result - the argument that the user entered that caused this exception to arise

cmdCtx - the command context that executed this command

Returns:

a Brigadier CommandSyntaxException