revxrsal.commands.command

Interface Potential<A extends CommandActor>

Type Parameters:

A - The actor type

All Superinterfaces:

java.lang.Comparable<Potential<A>>

public interface Potential<A extends CommandActor>
extends java.lang.Comparable<Potential<A>>

Represents the result obtained from attempting to parse an ExecutableCommand with some MutableStringStream input.

This attempt may either be successful, or failed with an error (Throwable).

Note that this will send no feedback at all to the user. It can continue execution with execute() or handle the exception with handleException().

See Also:

ExecutableCommand.test(CommandActor, MutableStringStream)

Method Summary

Modifier and Type	Method and Description
@NotNull ExecutionContext<A>	context() Returns the ExecutionContext generated from the execution attempt, as well as any values parsed from the input.
@Nullable java.lang.Throwable	error() Returns the error generated from the execution attempt.
@Nullable ErrorContext<A>	errorContext() Returns the context in which the error has occurred.
void	execute() Executes the command.
boolean	failed() Tests whether the execution failed or not
void	handleException() Handles the exception that caused the attempt to fail.
boolean	successful() Tests whether the execution was successful or not

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

successful

boolean successful()

Tests whether the execution was successful or not

Returns:

if the execution was successful or not

failed

boolean failed()

Tests whether the execution failed or not

Returns:

if the execution failed or not

context

@NotNull
@NotNull ExecutionContext<A> context()

Returns the ExecutionContext generated from the execution attempt, as well as any values parsed from the input.

Returns:

The execution context

error

@Nullable
@Nullable java.lang.Throwable error()

Returns the error generated from the execution attempt. If the attempt was successful(), this will be null.

Returns:

The error

errorContext

@Nullable
@Nullable ErrorContext<A> errorContext()

Returns the context in which the error has occurred.

For example, if the error was because a parameter was invalid, this will be a ErrorContext.ParsingParameter context, which contains information about the parameter being parsed.

If, however, it occurred during executing the command function, this will be an ErrorContext.ExecutingFunction context.

Returns:

The error context, or null if this was successful

handleException

void handleException()

Handles the exception that caused the attempt to fail.

If the attempt was successful, this method will do nothing

execute

void execute()

Executes the command.

If the attempt was not successful, this method will do nothing