Package org.incendo.cloud.exception.parsing

Class ParserException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IllegalArgumentException

org.incendo.cloud.exception.parsing.ParserException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AggregateParser.AggregateParseException, BooleanParser.BooleanParseException, CharacterParser.CharParseException, CommandFlagParser.FlagParseException, DurationParser.DurationParseException, EitherParser.EitherParseException, EnumParser.EnumParseException, NumberParseException, StringParser.StringParseException, UUIDParser.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)
protected	ParserException(@Nullable Throwable cause, @NonNull Class<?> argumentParser, @NonNull CommandContext<?> context, @NonNull Caption errorCaption, @NonNull CaptionVariable... captionVariables)

Method Summary

Modifier and Type	Method	Description
final @NonNull Class<?>	argumentParserClass()	Returns the argument parser class.
@NonNull CaptionVariable @NonNull []	captionVariables()	Get a copy of the caption variables present in this parser exception.
final @NonNull CommandContext<?>	context()	Returns the command context.
@NonNull Caption	errorCaption()	Get the error caption for this parser exception
final <T> @NonNull T	formatCaption(@NonNull CaptionFormatter<?,T> formatter)	Formats the error caption using the given formatter.
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(@Nullable Throwable cause,
 @NonNull Class<?> argumentParser,
 @NonNull CommandContext<?> context,
 @NonNull Caption errorCaption,
 @NonNull CaptionVariable... captionVariables)

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

formatCaption

@API(status=STABLE)
public final <T> @NonNull T formatCaption(@NonNull CaptionFormatter<?,T> formatter)

Formats the error caption using the given formatter.

Type Parameters:

T - the type produced by the formatter

Parameters:

formatter - the formatter

Returns:

the formatted caption

errorCaption

@API(status=STABLE)
public @NonNull Caption errorCaption()

Get the error caption for this parser exception

Returns:

The caption

captionVariables

@API(status=STABLE)
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

argumentParserClass

public final @NonNull Class<?> argumentParserClass()

Returns the argument parser class.

Returns:

argument parser class

context

public final @NonNull CommandContext<?> context()

Returns the command context.

Returns:

command context