Package org.spongepowered.api.command.exception

Class ArgumentParseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.spongepowered.api.util.ComponentMessageException

org.spongepowered.api.command.exception.CommandException

org.spongepowered.api.command.exception.ArgumentParseException

All Implemented Interfaces:

Serializable, ComponentMessageThrowable

public class ArgumentParseException
extends CommandException

Exception thrown when a Parameter cannot parse an argument.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ArgumentParseException(@Nullable Component message, String source, int position)	Return a new ArgumentParseException with the given message, source and position.
ArgumentParseException(@Nullable Component message, Throwable cause, String source, int position)	Return a new ArgumentParseException with the given message, cause, source and position.

Method Summary

Modifier and Type	Method	Description
String	annotatedPosition()	Return a string pointing to the position of the arguments when this exception occurs.
@Nullable Component	componentMessage()	Returns the text message for this exception, or null if nothing is present.
int	position()	Gets the position of the last fetched argument in the provided source string.
String	sourceString()	Returns the source string arguments are being parsed from.
@Nullable Component	superText()

Methods inherited from class org.spongepowered.api.command.exception.CommandException

shouldIncludeUsage

Methods inherited from class org.spongepowered.api.util.ComponentMessageException

getLocalizedMessage, getMessage

Methods inherited from class java.lang.Throwable

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

ArgumentParseException

public ArgumentParseException(@Nullable Component message,
                              String source,
                              int position)

Return a new ArgumentParseException with the given message, source and position.

Parameters:

message - The message to use for this exception

source - The source string being parsed

position - The current position in the source string

ArgumentParseException

public ArgumentParseException(@Nullable Component message,
                              Throwable cause,
                              String source,
                              int position)

Return a new ArgumentParseException with the given message, cause, source and position.

Parameters:

message - The message to use for this exception

cause - The cause for this exception

source - The source string being parsed

position - The current position in the source string

Method Detail

componentMessage

public @Nullable Component componentMessage()

Description copied from class: ComponentMessageException

Returns the text message for this exception, or null if nothing is present.

Specified by:

componentMessage in interface ComponentMessageThrowable

Overrides:

componentMessage in class ComponentMessageException

Returns:

The text for this message

superText

public @Nullable Component superText()

annotatedPosition

public String annotatedPosition()

Return a string pointing to the position of the arguments when this exception occurs.

Returns:

The appropriate position string

position

public int position()

Gets the position of the last fetched argument in the provided source string.

Returns:

The source string to get position for

sourceString

public String sourceString()

Returns the source string arguments are being parsed from.

Returns:

The source string