Package cloud.commandframework.exceptions.parsing

Class ParserException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IllegalArgumentException

cloud.commandframework.exceptions.parsing.ParserException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BooleanArgument.BooleanParseException, CharArgument.CharParseException, DurationArgument.DurationParseException, EnumArgument.EnumParseException, FlagArgument.FlagParseException, NoInputProvidedException, NumberParseException, StringArgument.StringParseException, UUIDArgument.UUIDParseException

@API(status=STABLE)
public class ParserException
extends IllegalArgumentException

See Also:

• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ParserException(@NonNull Class<?> argumentParser, @NonNull CommandContext<?> context, @NonNull Caption errorCaption, @NonNull CaptionVariable... captionVariables)

Method Summary

Modifier and Type	Method	Description
@NonNull CaptionVariable @NonNull []	captionVariables()	Get a copy of the caption variables present in this parser exception.
@NonNull Caption	errorCaption()	Get the error caption for this parser exception
final @NonNull Class<?>	getArgumentParserClass()	Get the argument parser
final @NonNull CommandContext<?>	getContext()	Get the command context
final String	getMessage()

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

ParserException

protected ParserException(@NonNull Class<?> argumentParser,
 @NonNull CommandContext<?> context,
 @NonNull Caption errorCaption,
 @NonNull CaptionVariable... captionVariables)

Method Details

getMessage

public final String getMessage()

Overrides:

getMessage in class Throwable

errorCaption

@API(status=STABLE,
     since="1.4.0")
public @NonNull Caption errorCaption()

Get the error caption for this parser exception

Returns:

The caption

Since:

1.4.0

captionVariables

@API(status=STABLE,
     since="1.4.0")
public @NonNull CaptionVariable @NonNull [] captionVariables()

Get a copy of the caption variables present in this parser exception. The returned array may be empty if no variables are present.

Returns:

The caption variables

Since:

1.4.0

getArgumentParserClass

public final @NonNull Class<?> getArgumentParserClass()

Get the argument parser

Returns:

Argument parser

getContext

public final @NonNull CommandContext<?> getContext()

Get the command context

Returns:

Command context