net.lenni0451.commandlib.exceptions

Class ChainExecutionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

net.lenni0451.commandlib.exceptions.ChainExecutionException

All Implemented Interfaces:

java.io.Serializable

public class ChainExecutionException
extends java.lang.Exception

An exception which is thrown when the execution of a command chain fails.
Reasons for failure are:
- A ArgumentParseException was thrown while parsing an argument
- A unhandled RuntimeException was thrown while parsing an argument
- The input ended before all arguments were parsed
- The input contained more arguments than the command chain can handle

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChainExecutionException.Reason The reason why the execution failed.

Constructor Summary

Constructors

Constructor and Description
ChainExecutionException(ArgumentParseException parseException, int executionIndex, int readerCursor, java.lang.String argumentName, java.lang.String extraData)
ChainExecutionException(ChainExecutionException.Reason reason, int executionIndex, int readerCursor, java.lang.String argumentName, java.lang.String extraData)
ChainExecutionException(ChainExecutionException exception, int executionIndexOffset)
ChainExecutionException(HandledException handled, int executionIndex, int readerCursor, java.lang.String argumentName, java.lang.String extraData)
ChainExecutionException(java.lang.RuntimeException e, int executionIndex, int readerCursor, java.lang.String argumentName, java.lang.String extraData)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getArgumentName()
int	getExecutionIndex()
java.lang.String	getExtraData()
int	getReaderCursor()
ChainExecutionException.Reason	getReason()

Methods inherited from class java.lang.Throwable

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

ChainExecutionException

public ChainExecutionException(ArgumentParseException parseException,
                               int executionIndex,
                               int readerCursor,
                               @Nullable
                               java.lang.String argumentName,
                               @Nullable
                               java.lang.String extraData)

ChainExecutionException

public ChainExecutionException(java.lang.RuntimeException e,
                               int executionIndex,
                               int readerCursor,
                               @Nullable
                               java.lang.String argumentName,
                               @Nullable
                               java.lang.String extraData)

ChainExecutionException

public ChainExecutionException(HandledException handled,
                               int executionIndex,
                               int readerCursor,
                               @Nullable
                               java.lang.String argumentName,
                               @Nullable
                               java.lang.String extraData)

ChainExecutionException

public ChainExecutionException(ChainExecutionException.Reason reason,
                               int executionIndex,
                               int readerCursor,
                               @Nullable
                               java.lang.String argumentName,
                               @Nullable
                               java.lang.String extraData)

ChainExecutionException

public ChainExecutionException(ChainExecutionException exception,
                               int executionIndexOffset)

Method Detail

getReason

public ChainExecutionException.Reason getReason()

Returns:

The reason why the execution failed

getExecutionIndex

public int getExecutionIndex()

Returns:

The index of the argument which caused the failure

getReaderCursor

public int getReaderCursor()

Returns:

The cursor position of the reader when the failure occurred

getArgumentName

@Nullable
public java.lang.String getArgumentName()

Returns:

The name of the argument which caused the failure

getExtraData

@Nullable
public java.lang.String getExtraData()

Returns:

Extra data which was provided by the command chain