revxrsal.commands.exception

Class RuntimeExceptionAdapter<A extends CommandActor>

java.lang.Object

revxrsal.commands.exception.RuntimeExceptionAdapter<A>

Type Parameters:

A - The actor type

All Implemented Interfaces:

CommandExceptionHandler<A>

Direct Known Subclasses:

DefaultExceptionHandler

public class RuntimeExceptionAdapter<A extends CommandActor>
extends java.lang.Object
implements CommandExceptionHandler<A>

A utility class that allows to easily handle individual exceptions by creating smaller functions that handle specific types of exceptions or deal with specific ErrorContexts.

This works by creating a function and annotating it with RuntimeExceptionAdapter.HandleException. The function parameters dictate the conditions that this function works in.

• If a function has no parameters, it will always be invoked
• If a function has a specific Throwable type, it will handle exceptions of such type
• If a function has a specific ErrorContext type, it will handle exceptions of such context
• If a function has a CommandParameter parameter, it will handle error contexts of type ErrorContext.ParsingParameter and automatically get the parameter
• If a function has a ParameterNode parameter, it will handle error contexts of type ErrorContext.ParsingParameter and automatically get the parameter node
• If a function has a LiteralNode parameter, it will handle error contexts of type ErrorContext.ParsingLiteral and automatically get the literal node

The function will also get these parameters automatically:

• Lamp
• CommandActor
• ExecutionContext
• ErrorContext
• ExecutableCommand
• CommandFunction

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RuntimeExceptionAdapter.HandleException Annotation for creating handler functions.

Constructor Summary

Constructors

Constructor and Description
RuntimeExceptionAdapter() Registers all RuntimeExceptionAdapter.HandleException-annotated methods to this exception handler

Method Summary

Modifier and Type	Method and Description
protected static @NotNull java.lang.String	fmt(@NotNull java.lang.Number number)
void	handleException(@NotNull java.lang.Throwable throwable, @NotNull ErrorContext<A> errorContext) Handles the given exception.

Methods inherited from class java.lang.Object

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

Constructor Detail

RuntimeExceptionAdapter

public RuntimeExceptionAdapter()

Registers all RuntimeExceptionAdapter.HandleException-annotated methods to this exception handler

Method Detail

fmt

@NotNull
protected static @NotNull java.lang.String fmt(@NotNull
                                                        @NotNull java.lang.Number number)

handleException

public final void handleException(@NotNull
                                  @NotNull java.lang.Throwable throwable,
                                  @NotNull
                                  @NotNull ErrorContext<A> errorContext)

Description copied from interface: CommandExceptionHandler

Handles the given exception.

Specified by:

handleException in interface CommandExceptionHandler<A extends CommandActor>

Parameters:

throwable - Exception to handle

errorContext - The context in which the error 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.