org.spongepowered.api.command.args

Class ArgumentParseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.spongepowered.api.util.TextMessageException

org.spongepowered.api.command.CommandException

org.spongepowered.api.command.args.ArgumentParseException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ArgumentParseException.WithUsage

public class ArgumentParseException
extends CommandException

Exception thrown when an error occurs while parsing arguments.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ArgumentParseException.WithUsage An ArgumentParseException where the usage is already specified.

Constructor Summary

Constructors

Constructor and Description
ArgumentParseException(Text message, String source, int position) Return a new ArgumentParseException with the given message, source and position.
ArgumentParseException(Text 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 and Description
String	getAnnotatedPosition() Return a string pointing to the position of the arguments when this exception occurs.
int	getPosition() Gets the position of the last fetched argument in the provided source string.
String	getSourceString() Returns the source string arguments are being parsed from.
Text	getText() Returns the text message for this exception, or null if nothing is present.

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

shouldIncludeUsage

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

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(Text 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(Text 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

getText

public Text getText()

Description copied from class: TextMessageException

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

Overrides:

getText in class TextMessageException

Returns:

The text for this message

getAnnotatedPosition

public String getAnnotatedPosition()

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

Returns:

The appropriate position string

getPosition

public int getPosition()

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

Returns:

The source string to get position for

getSourceString

public String getSourceString()

Returns the source string arguments are being parsed from.

Returns:

The source string