Class ParsingExceptionImpl

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

net.kyori.adventure.text.minimessage.ParsingException

net.kyori.adventure.text.minimessage.internal.parser.ParsingExceptionImpl

All Implemented Interfaces:

Serializable

@Internal
public class ParsingExceptionImpl
extends ParsingException

An exception that happens while parsing.

Since:

4.10.0

See Also:

• Serialized Form

Field Summary

Fields inherited from class ParsingException

LOCATION_UNKNOWN

Constructor Summary

Constructors

Constructor	Description
ParsingExceptionImpl(String message, @Nullable String originalText, @Nullable Throwable cause, boolean withStackTrace, Token... tokens)	Create a new parsing exception.
ParsingExceptionImpl(String message, @Nullable String originalText, Token... tokens)	Create a new parsing exception.

Method Summary

Modifier and Type	Method	Description
@Nullable String	detailMessage()	Get the detail message optionally passed with this exception.
int	endIndex()	Get the end index of the location which caused this exception.
String	getMessage()
@Nullable String	originalText()	Get the message which caused this exception.
int	startIndex()	Get the start index of the location which caused this exception.
Token[]	tokens()	Gets the tokens associated with this parsing error.
void	tokens(Token[] tokens)	Sets the tokens associated with this parsing error.

Methods inherited from class Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ParsingExceptionImpl

public ParsingExceptionImpl(String message,
 @Nullable String originalText,
 Token... tokens)

Create a new parsing exception.

Parameters:

message - the detail message

originalText - the original text which was parsed

tokens - the token which caused the error

Since:

4.10.0

ParsingExceptionImpl

public ParsingExceptionImpl(String message,
 @Nullable String originalText,
 @Nullable Throwable cause,
 boolean withStackTrace,
 Token... tokens)

Create a new parsing exception.

Parameters:

message - the detail message

originalText - the original text which was parsed

cause - the cause

withStackTrace - whether to generate a stacktrace

tokens - the token which caused the error

Since:

4.10.0

Method Details

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

detailMessage

public @Nullable String detailMessage()

Description copied from class: ParsingException

Get the detail message optionally passed with this exception.

Unlike Throwable.getMessage(), this method does not include location information.

Specified by:

detailMessage in class ParsingException

Returns:

the detail message passed to this exception

originalText

public @Nullable String originalText()

Get the message which caused this exception.

Specified by:

originalText in class ParsingException

Returns:

the original message

Since:

4.10.0

tokens

public Token[] tokens()

Gets the tokens associated with this parsing error.

Returns:

the tokens for this error

Since:

4.10.0

tokens

public void tokens(Token[] tokens)

Sets the tokens associated with this parsing error.

Parameters:

tokens - the tokens for this error

Since:

4.10.0

startIndex

public int startIndex()

Description copied from class: ParsingException

Get the start index of the location which caused this exception.

This index is an index into ParsingException.originalText(). If location is unknown, ParsingException.LOCATION_UNKNOWN will be returned instead.

Specified by:

startIndex in class ParsingException

Returns:

the start index

endIndex

public int endIndex()

Description copied from class: ParsingException

Get the end index of the location which caused this exception.

This index is an index into ParsingException.originalText(). If location is unknown, ParsingException.LOCATION_UNKNOWN will be returned instead.

Specified by:

endIndex in class ParsingException

Returns:

the end index