Package org.incendo.cloud.minecraft.extras

Class MinecraftExceptionHandler<C>

java.lang.Object

org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler<C>

Type Parameters:

C - command sender type

public final class MinecraftExceptionHandler<C>
extends Object

Creates and registers ExceptionHandlers that send a Component to the command sender.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MinecraftExceptionHandler.ComponentMessageThrowableConverter	Converts Throwables to ComponentMessageThrowables when possible.
static final class	MinecraftExceptionHandler.ComponentMessageThrowableConverterHolder	Default implementation and holder for MinecraftExceptionHandler.ComponentMessageThrowableConverter.
static interface	MinecraftExceptionHandler.Decorator<C>
static interface	MinecraftExceptionHandler.MessageFactory<C,T extends Throwable>

Method Summary

Modifier and Type	Method	Description
@NonNull MinecraftExceptionHandler<C>	captionFormatter(@NonNull ComponentCaptionFormatter<C> captionFormatter)	Sets the caption formatter that is responsible for turning captions into Adventure components.
static <C> MinecraftExceptionHandler<C>	create(AudienceProvider<C> audienceProvider)	Create a new MinecraftExceptionHandler using audienceProvider.
static <C> MinecraftExceptionHandler.MessageFactory<C,ArgumentParseException>	createDefaultArgumentParsingHandler()	The default ArgumentParseException handler.
static <C> MinecraftExceptionHandler.MessageFactory<C,CommandExecutionException>	createDefaultCommandExecutionHandler()	The default CommandExecutionException handler, using createDefaultCommandExecutionLogger().
static <C> MinecraftExceptionHandler.MessageFactory<C,CommandExecutionException>	createDefaultCommandExecutionHandler(Consumer<ExceptionContext<C,CommandExecutionException>> logger)	The default CommandExecutionException handler, with a specific logger.
static <C> Consumer<ExceptionContext<C,CommandExecutionException>>	createDefaultCommandExecutionLogger()	Default logger for createDefaultCommandExecutionHandler(Consumer), using Throwable.printStackTrace() on the CommandExecutionException's cause.
static <C> MinecraftExceptionHandler.MessageFactory<C,InvalidCommandSenderException>	createDefaultInvalidSenderHandler()	The default InvalidCommandSenderException handler.
static <C> MinecraftExceptionHandler.MessageFactory<C,InvalidSyntaxException>	createDefaultInvalidSyntaxHandler()	The default InvalidSyntaxException handler.
static <C> MinecraftExceptionHandler.MessageFactory<C,NoPermissionException>	createDefaultNoPermissionHandler()	The default NoPermissionException handler.
static <C extends Audience> MinecraftExceptionHandler<C>	createNative()	Create a new MinecraftExceptionHandler using AudienceProvider.nativeAudience().
@NonNull MinecraftExceptionHandler<C>	decorator(@NonNull Function<@NonNull Component,@NonNull ComponentLike> decorator)	Sets the decorator that acts on a component before it's sent to the sender.
@NonNull MinecraftExceptionHandler<C>	decorator(@NonNull MinecraftExceptionHandler.Decorator<C> decorator)	Sets the decorator that acts on a component before it's sent to the sender.
@NonNull MinecraftExceptionHandler<C>	defaultArgumentParsingHandler()	Use the default ArgumentParseException handler.
@NonNull MinecraftExceptionHandler<C>	defaultCommandExecutionHandler()	Use the default CommandExecutionException handler with createDefaultCommandExecutionLogger().
@NonNull MinecraftExceptionHandler<C>	defaultCommandExecutionHandler(@NonNull Consumer<ExceptionContext<C,CommandExecutionException>> logger)	Use the default CommandExecutionException handler with a custom logger.
@NonNull MinecraftExceptionHandler<C>	defaultHandlers()	Use all the default exception handlers.
@NonNull MinecraftExceptionHandler<C>	defaultInvalidSenderHandler()	Use the default InvalidCommandSenderException handler.
@NonNull MinecraftExceptionHandler<C>	defaultInvalidSyntaxHandler()	Use the default InvalidSyntaxException handler.
@NonNull MinecraftExceptionHandler<C>	defaultNoPermissionHandler()	Use the default NoPermissionException handler.
<T extends Throwable> @NonNull MinecraftExceptionHandler<C>	handler(@NonNull Class<T> type, @NonNull MinecraftExceptionHandler.MessageFactory<C,T> componentFactory)	Sets the exception handler for the given type.
void	registerTo(@NonNull CommandManager<C> manager)	Registers configured handlers to the ExceptionController.

Methods inherited from class java.lang.Object

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

Method Details

createDefaultInvalidSyntaxHandler

@API(status=STABLE,
     since="2.0.0")
public static <C>
MinecraftExceptionHandler.MessageFactory<C,InvalidSyntaxException> createDefaultInvalidSyntaxHandler()

The default InvalidSyntaxException handler.

Type Parameters:

C - sender type

Returns:

InvalidSyntaxException handler function

Since:

2.0.0

See Also:

• defaultInvalidSyntaxHandler()

createDefaultInvalidSenderHandler

@API(status=STABLE,
     since="2.0.0")
public static <C>
MinecraftExceptionHandler.MessageFactory<C,InvalidCommandSenderException> createDefaultInvalidSenderHandler()

The default InvalidCommandSenderException handler.

Type Parameters:

C - sender type

Returns:

InvalidCommandSenderException handler function

Since:

2.0.0

See Also:

• defaultInvalidSenderHandler()

createDefaultNoPermissionHandler

@API(status=STABLE,
     since="2.0.0")
public static <C>
MinecraftExceptionHandler.MessageFactory<C,NoPermissionException> createDefaultNoPermissionHandler()

The default NoPermissionException handler.

Type Parameters:

C - sender type

Returns:

NoPermissionException handler function

Since:

2.0.0

See Also:

• defaultNoPermissionHandler()

createDefaultArgumentParsingHandler

@API(status=STABLE,
     since="2.0.0")
public static <C>
MinecraftExceptionHandler.MessageFactory<C,ArgumentParseException> createDefaultArgumentParsingHandler()

The default ArgumentParseException handler.

Type Parameters:

C - sender type

Returns:

ArgumentParseException handler function

Since:

2.0.0

See Also:

• defaultArgumentParsingHandler()

createDefaultCommandExecutionLogger

@API(status=STABLE,
     since="2.0.0")
public static <C>
Consumer<ExceptionContext<C,CommandExecutionException>> createDefaultCommandExecutionLogger()

Default logger for createDefaultCommandExecutionHandler(Consumer), using Throwable.printStackTrace() on the CommandExecutionException's cause.

Type Parameters:

C - sender type

Returns:

default logger

Since:

2.0.0

createDefaultCommandExecutionHandler

@API(status=STABLE,
     since="2.0.0")
public static <C>
MinecraftExceptionHandler.MessageFactory<C,CommandExecutionException> createDefaultCommandExecutionHandler()

The default CommandExecutionException handler, using createDefaultCommandExecutionLogger().

Type Parameters:

C - sender type

Returns:

CommandExecutionException handler function

Since:

2.0.0

See Also:

• defaultCommandExecutionHandler()

createDefaultCommandExecutionHandler

@API(status=STABLE,
     since="2.0.0")
public static <C>
MinecraftExceptionHandler.MessageFactory<C,CommandExecutionException> createDefaultCommandExecutionHandler(Consumer<ExceptionContext<C,CommandExecutionException>> logger)

The default CommandExecutionException handler, with a specific logger.

Type Parameters:

C - sender type

Parameters:

logger - logger

Returns:

CommandExecutionException handler function

Since:

2.0.0

See Also:

• defaultCommandExecutionHandler(Consumer)

create

@API(status=STABLE,
     since="2.0.0")
public static <C> MinecraftExceptionHandler<C> create(AudienceProvider<C> audienceProvider)

Create a new MinecraftExceptionHandler using audienceProvider.

Type Parameters:

C - sender type

Parameters:

audienceProvider - audience provider

Returns:

new MinecraftExceptionHandler

Since:

2.0.0

createNative

@API(status=STABLE,
     since="2.0.0")
public static <C extends Audience>
MinecraftExceptionHandler<C> createNative()

Create a new MinecraftExceptionHandler using AudienceProvider.nativeAudience().

Type Parameters:

C - sender type

Returns:

new MinecraftExceptionHandler

Since:

2.0.0

defaultInvalidSyntaxHandler

@API(status=STABLE,
     since="2.0.0")
public @NonNull MinecraftExceptionHandler<C> defaultInvalidSyntaxHandler()

Use the default InvalidSyntaxException handler.

Returns:

this

Since:

2.0.0

defaultInvalidSenderHandler

@API(status=STABLE,
     since="2.0.0")
public @NonNull MinecraftExceptionHandler<C> defaultInvalidSenderHandler()

Use the default InvalidCommandSenderException handler.

Returns:

this

Since:

2.0.0

defaultNoPermissionHandler

@API(status=STABLE,
     since="2.0.0")
public @NonNull MinecraftExceptionHandler<C> defaultNoPermissionHandler()

Use the default NoPermissionException handler.

Returns:

this

Since:

2.0.0

defaultArgumentParsingHandler

@API(status=STABLE,
     since="2.0.0")
public @NonNull MinecraftExceptionHandler<C> defaultArgumentParsingHandler()

Use the default ArgumentParseException handler.

Returns:

this

Since:

2.0.0

defaultCommandExecutionHandler

@API(status=STABLE,
     since="2.0.0")
public @NonNull MinecraftExceptionHandler<C> defaultCommandExecutionHandler()

Use the default CommandExecutionException handler with createDefaultCommandExecutionLogger().

Returns:

this

Since:

2.0.0

See Also:

• defaultCommandExecutionHandler(Consumer)

defaultCommandExecutionHandler

@API(status=STABLE,
     since="2.0.0")
public @NonNull MinecraftExceptionHandler<C> defaultCommandExecutionHandler(@NonNull Consumer<ExceptionContext<C,CommandExecutionException>> logger)

Use the default CommandExecutionException handler with a custom logger.

Parameters:

logger - logger

Returns:

this

Since:

2.0.0

defaultHandlers

@API(status=STABLE,
     since="2.0.0")
public @NonNull MinecraftExceptionHandler<C> defaultHandlers()

Use all the default exception handlers.

Returns:

this

Since:

2.0.0

See Also:

• defaultArgumentParsingHandler()
• defaultInvalidSenderHandler()
• defaultInvalidSyntaxHandler()
• defaultNoPermissionHandler()
• defaultCommandExecutionHandler()

handler

@API(status=STABLE,
     since="2.0.0")
public <T extends Throwable>
@NonNull MinecraftExceptionHandler<C> handler(@NonNull Class<T> type,
 @NonNull MinecraftExceptionHandler.MessageFactory<C,T> componentFactory)

Sets the exception handler for the given type. A handler can return null to indicate no message should be sent.

Type Parameters:

T - exception type

Parameters:

type - the exception type to handle

componentFactory - the factory that produces the components

Returns:

this

Since:

2.0.0

decorator

@API(status=STABLE,
     since="2.0.0")
public @NonNull MinecraftExceptionHandler<C> decorator(@NonNull MinecraftExceptionHandler.Decorator<C> decorator)

Sets the decorator that acts on a component before it's sent to the sender.

Parameters:

decorator - the component decorator

Returns:

this

Since:

2.0.0

captionFormatter

public @NonNull MinecraftExceptionHandler<C> captionFormatter(@NonNull ComponentCaptionFormatter<C> captionFormatter)

Sets the caption formatter that is responsible for turning captions into Adventure components.

Parameters:

captionFormatter - caption formatter

Returns:

this

decorator

@API(status=STABLE,
     since="2.0.0")
public @NonNull MinecraftExceptionHandler<C> decorator(@NonNull Function<@NonNull Component,@NonNull ComponentLike> decorator)

Sets the decorator that acts on a component before it's sent to the sender.

Parameters:

decorator - the component decorator

Returns:

this

Since:

2.0.0

registerTo

@API(status=STABLE,
     since="2.0.0")
public void registerTo(@NonNull CommandManager<C> manager)

Registers configured handlers to the ExceptionController.

Parameters:

manager - the manager instance

Since:

2.0.0