Package dev.sympho.modular_commands.api.command.handler

Interface Handlers

All Known Subinterfaces:

InteractionHandlers, MessageHandlers, SlashHandlers, TextHandlers

All Known Implementing Classes:

InteractionHandlers.Impl, MessageHandlers.Impl, SlashHandlers.Impl, TextHandlers.Impl

public sealed interface Handlers
permits MessageHandlers, SlashHandlers

A set of handlers for executing an invocation of a command.

Note that the implemented subinterfaces of this type determine what kinds of commands are supported; if the handlers are specified through a MessageHandlers, the command will only support invocations through messages, even if the invocation handler actually supports slash commands. Implementing more than one is allowed, however, and some joint-type interfaces are provided for convenience.

All instances of this class, as well as any contained collections, should be unmodifiable.

Since:

1.0

Version:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final InvocationHandler<CommandContext>	CONTINUE	An invocation handler that simply signals that handling should continue.

Method Summary

Modifier and Type	Method	Description
static InteractionHandlers	interaction(InvocationHandler<? super InteractionCommandContext> invocation)	Creates a handler set with the given handlers, with support only for interaction-based commands, and no result handlers.
static InteractionHandlers	interaction(InvocationHandler<? super InteractionCommandContext> invocation, ResultHandler<? super InteractionCommandContext>... result)	Creates a handler set with the given handlers, with support for interaction-based commands.
static InteractionHandlers	interaction(InvocationHandler<? super InteractionCommandContext> invocation, List<? extends ResultHandler<? super InteractionCommandContext>> result)	Creates a handler set with the given handlers, with support for interaction-based commands.
InvocationHandler<?>	invocation()	The handler to use for executing the invocation.
static MessageHandlers	message(InvocationHandler<? super MessageCommandContext> invocation)	Creates a handler set with the given handlers, with support only for message-based commands, and no result handlers.
static MessageHandlers	message(InvocationHandler<? super MessageCommandContext> invocation, ResultHandler<? super MessageCommandContext>... result)	Creates a handler set with the given handlers, with support only for message-based commands.
static MessageHandlers	message(InvocationHandler<? super MessageCommandContext> invocation, List<? extends ResultHandler<? super MessageCommandContext>> result)	Creates a handler set with the given handlers, with support only for message-based commands.
List<? extends ResultHandler<?>>	result()	The handlers to use to handle the result (in the order given).
static SlashHandlers	slash(InvocationHandler<? super SlashCommandContext> invocation)	Creates a handler set with the given handlers, with support only for slash-based commands, and no result handlers.
static SlashHandlers	slash(InvocationHandler<? super SlashCommandContext> invocation, ResultHandler<? super SlashCommandContext>... result)	Creates a handler set with the given handlers, with support only for slash-based commands.
static SlashHandlers	slash(InvocationHandler<? super SlashCommandContext> invocation, List<? extends ResultHandler<? super SlashCommandContext>> result)	Creates a handler set with the given handlers, with support only for slash-based commands.
static TextHandlers	text(InvocationHandler<CommandContext> invocation)	Creates a handler set with the given handlers, with support only for text-based commands, and no result handlers.
static TextHandlers	text(InvocationHandler<CommandContext> invocation, ResultHandler<CommandContext>... result)	Creates a handler set with the given handlers, with support for text-based commands.
static TextHandlers	text(InvocationHandler<CommandContext> invocation, List<? extends ResultHandler<CommandContext>> result)	Creates a handler set with the given handlers, with support for text-based commands.

Field Details

CONTINUE

static final InvocationHandler<CommandContext> CONTINUE

An invocation handler that simply signals that handling should continue.

Method Details

invocation

@Pure
InvocationHandler<?> invocation()

The handler to use for executing the invocation.

Returns:

The handler.

result

@Pure
List<? extends ResultHandler<?>> result()

The handlers to use to handle the result (in the order given).

Returns:

The handlers.

message

static MessageHandlers message(InvocationHandler<? super MessageCommandContext> invocation,
 List<? extends ResultHandler<? super MessageCommandContext>> result)

Creates a handler set with the given handlers, with support only for message-based commands.

Parameters:

invocation - The invocation handler.

result - The result handlers.

Returns:

The handler set.

message

@SafeVarargs
static MessageHandlers message(InvocationHandler<? super MessageCommandContext> invocation,
 ResultHandler<? super MessageCommandContext>... result)

Creates a handler set with the given handlers, with support only for message-based commands.

Parameters:

invocation - The invocation handler.

result - The result handlers.

Returns:

The handler set.

message

static MessageHandlers message(InvocationHandler<? super MessageCommandContext> invocation)

Creates a handler set with the given handlers, with support only for message-based commands, and no result handlers.

Parameters:

invocation - The invocation handler.

Returns:

The handler set.

slash

static SlashHandlers slash(InvocationHandler<? super SlashCommandContext> invocation,
 List<? extends ResultHandler<? super SlashCommandContext>> result)

Creates a handler set with the given handlers, with support only for slash-based commands.

Parameters:

invocation - The invocation handler.

result - The result handlers.

Returns:

The handler set.

slash

@SafeVarargs
static SlashHandlers slash(InvocationHandler<? super SlashCommandContext> invocation,
 ResultHandler<? super SlashCommandContext>... result)

Creates a handler set with the given handlers, with support only for slash-based commands.

Parameters:

invocation - The invocation handler.

result - The result handlers.

Returns:

The handler set.

slash

static SlashHandlers slash(InvocationHandler<? super SlashCommandContext> invocation)

Creates a handler set with the given handlers, with support only for slash-based commands, and no result handlers.

Parameters:

invocation - The invocation handler.

Returns:

The handler set.

interaction

static InteractionHandlers interaction(InvocationHandler<? super InteractionCommandContext> invocation,
 List<? extends ResultHandler<? super InteractionCommandContext>> result)

Creates a handler set with the given handlers, with support for interaction-based commands.

Parameters:

invocation - The invocation handler.

result - The result handlers.

Returns:

The handler set.

interaction

@SafeVarargs
static InteractionHandlers interaction(InvocationHandler<? super InteractionCommandContext> invocation,
 ResultHandler<? super InteractionCommandContext>... result)

Creates a handler set with the given handlers, with support for interaction-based commands.

Parameters:

invocation - The invocation handler.

result - The result handlers.

Returns:

The handler set.

interaction

static InteractionHandlers interaction(InvocationHandler<? super InteractionCommandContext> invocation)

Creates a handler set with the given handlers, with support only for interaction-based commands, and no result handlers.

Parameters:

invocation - The invocation handler.

Returns:

The handler set.

text

static TextHandlers text(InvocationHandler<CommandContext> invocation,
 List<? extends ResultHandler<CommandContext>> result)

Creates a handler set with the given handlers, with support for text-based commands.

Parameters:

invocation - The invocation handler.

result - The result handlers.

Returns:

The handler set.

text

@SafeVarargs
static TextHandlers text(InvocationHandler<CommandContext> invocation,
 ResultHandler<CommandContext>... result)

Creates a handler set with the given handlers, with support for text-based commands.

Parameters:

invocation - The invocation handler.

result - The result handlers.

Returns:

The handler set.

text

static TextHandlers text(InvocationHandler<CommandContext> invocation)

Creates a handler set with the given handlers, with support only for text-based commands, and no result handlers.

Parameters:

invocation - The invocation handler.

Returns:

The handler set.