Package dev.sympho.modular_commands.execute

Class MessageCommandExecutor

java.lang.Object

dev.sympho.modular_commands.execute.CommandExecutor

dev.sympho.modular_commands.execute.BaseCommandExecutor<MessageCreateEvent,MessageContextImpl,MessageHandlers,StringSplitter.Async.Iterator>

dev.sympho.modular_commands.execute.MessageCommandExecutor

public class MessageCommandExecutor
extends BaseCommandExecutor<MessageCreateEvent,MessageContextImpl,MessageHandlers,StringSplitter.Async.Iterator>

Executor that receives and handles commands through text messages.

Note that, as command names are restricted to only using lowercase characters, command matching is case insensitive (argument parsing is not affected).

Since:

1.0

Version:

1.0

Field Summary

Fields inherited from class dev.sympho.modular_commands.execute.BaseCommandExecutor

accessManager, client, meters, observations, registry

Fields inherited from class dev.sympho.modular_commands.execute.CommandExecutor

logger

Constructor Summary

Constructors

Constructor	Description
MessageCommandExecutor(GatewayDiscordClient client, Registry registry, Optional<dev.sympho.bot_utils.access.AccessManager> accessManager, Optional<io.micrometer.core.instrument.MeterRegistry> meters, Optional<io.micrometer.observation.ObservationRegistry> observations, PrefixProvider prefixProvider, Optional<AliasProvider> aliases)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
static MessageCommandExecutorBuilder	builder()	Creates a new builder.
protected Class<MessageHandlers>	commandType()	Retrives the command type to use.
protected boolean	eventFilter(MessageCreateEvent event)	Determines if an event should be processed for commands.
protected Class<MessageCreateEvent>	eventType()	Retrieves the event type to listen for.
protected boolean	fullMatch()	Determines whether a parsed arg list (as given by BaseCommandExecutor.parse(Event)) must always be fully matched to a command.
protected User	getCaller(MessageCreateEvent event)	Retrieves the user that invoked the command from the triggering event.
protected Mono<MessageChannel>	getChannel(MessageCreateEvent event)	Retrieves the channel where the command was invoked from the triggering event.
protected Snowflake	getChannelId(MessageCreateEvent event)	Retrieves the ID of the channel where the command was invoked from the triggering event.
protected Mono<Guild>	getGuild(MessageCreateEvent event)	Retrieves the guild where the command was invoked, if any, from the triggering event.
protected Optional<Snowflake>	getGuildId(MessageCreateEvent event)	Retrieves the ID of the guild where the command was invoked, if any, from the triggering event.
protected InvocationHandler<? super MessageContextImpl>	getInvocationHandler(MessageHandlers handlers)	Retrieves the invocation handler specified by the given hander set.
protected List<? extends ResultHandler<? super MessageContextImpl>>	getResultHandlers(MessageHandlers handlers)	Retrieves the result handlers specified by the given hander set.
protected MessageContextImpl	makeContext(MessageCreateEvent event, Command<? extends MessageHandlers> command, Invocation invocation, StringSplitter.Async.Iterator args)	Creates a command context from a parsed invocation.
protected StringSplitter.Async.Iterator	parse(MessageCreateEvent event)	Parses the raw args from the event.
protected Metrics.Tag.Type	tagType()	Determines the type tag for this pipeline.

Methods inherited from class dev.sympho.modular_commands.execute.BaseCommandExecutor

addTags, buildPipeline

Methods inherited from class dev.sympho.modular_commands.execute.CommandExecutor

start, stop

Methods inherited from class java.lang.Object

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

Constructor Details

MessageCommandExecutor

@Constructor
public MessageCommandExecutor(GatewayDiscordClient client,
 Registry registry,
 Optional<dev.sympho.bot_utils.access.AccessManager> accessManager,
 Optional<io.micrometer.core.instrument.MeterRegistry> meters,
 Optional<io.micrometer.observation.ObservationRegistry> observations,
 PrefixProvider prefixProvider,
 Optional<AliasProvider> aliases)

Creates a new instance.

Parameters:

client - The client to receive events from.

registry - The registry to use to look up commands.

accessManager - The access manager to use for access checks. Defaults to AccessManager.basic().

meters - The meter registry to use. Defaults to a no-op registry.

observations - The observation registry to use. Defaults to a no-op registry.

prefixProvider - The provider to get prefixes from.

aliases - Provides the aliases that should be applied. Defaults to AliasProvider.none().

Method Details

builder

public static MessageCommandExecutorBuilder builder()

Creates a new builder.

Returns:

The created builder.

tagType

protected Metrics.Tag.Type tagType()

Description copied from class: BaseCommandExecutor

Determines the type tag for this pipeline.

Specified by:

tagType in class BaseCommandExecutor<MessageCreateEvent,MessageContextImpl,MessageHandlers,StringSplitter.Async.Iterator>

Returns:

The tag.

eventType

protected Class<MessageCreateEvent> eventType()

Description copied from class: BaseCommandExecutor

Retrieves the event type to listen for.

Specified by:

eventType in class BaseCommandExecutor<MessageCreateEvent,MessageContextImpl,MessageHandlers,StringSplitter.Async.Iterator>

Returns:

The event type.

commandType

protected Class<MessageHandlers> commandType()

Description copied from class: BaseCommandExecutor

Retrives the command type to use.

Specified by:

commandType in class BaseCommandExecutor<MessageCreateEvent,MessageContextImpl,MessageHandlers,StringSplitter.Async.Iterator>

Returns:

The command type.

fullMatch

protected boolean fullMatch()

Description copied from class: BaseCommandExecutor

Determines whether a parsed arg list (as given by BaseCommandExecutor.parse(Event)) must always be fully matched to a command. If true, the presence of leftover args (as would be received by BaseCommandExecutor.makeContext(Event, Command, Invocation, SmartIterator)) triggers an error for that event (stopping the processing of that particular event, but without stopping the pipeline).

Specified by:

fullMatch in class BaseCommandExecutor<MessageCreateEvent,MessageContextImpl,MessageHandlers,StringSplitter.Async.Iterator>

Returns:

true if the parsed args must be fully matched to a command. false if additional args are allowed.

eventFilter

protected boolean eventFilter(MessageCreateEvent event)

Description copied from class: BaseCommandExecutor

Determines if an event should be processed for commands. This filter is applied at the start of handling, before any parsing is performed.

Overrides:

eventFilter in class BaseCommandExecutor<MessageCreateEvent,MessageContextImpl,MessageHandlers,StringSplitter.Async.Iterator>

Parameters:

event - The event to check.

Returns:

true if the event should be processed. false if the event should be discarded.

parse

protected StringSplitter.Async.Iterator parse(MessageCreateEvent event)

Description copied from class: BaseCommandExecutor

Parses the raw args from the event. This includes the names that identify the command and subcommands, as well as any additional args, if allowed.

Specified by:

parse in class BaseCommandExecutor<MessageCreateEvent,MessageContextImpl,MessageHandlers,StringSplitter.Async.Iterator>

Parameters:

event - The event to parse args from.

Returns:

The parsed args. May have no elements if the event should not be handled as a command.

makeContext

protected MessageContextImpl makeContext(MessageCreateEvent event,
 Command<? extends MessageHandlers> command,
 Invocation invocation,
 StringSplitter.Async.Iterator args)

Description copied from class: BaseCommandExecutor

Creates a command context from a parsed invocation.

Specified by:

makeContext in class BaseCommandExecutor<MessageCreateEvent,MessageContextImpl,MessageHandlers,StringSplitter.Async.Iterator>

Parameters:

event - The event being processed.

command - The identified command.

invocation - The invocation that mapped to the command. This may be different from the command's declared Command.invocation() if it was invoked using an alias (when supported).

args - The args that remained after removing the command identifiers. If BaseCommandExecutor.fullMatch() is true, this will always be empty.

Returns:

The context that represents the given invocation.

getGuildId

protected Optional<Snowflake> getGuildId(MessageCreateEvent event)

Description copied from class: BaseCommandExecutor

Retrieves the ID of the guild where the command was invoked, if any, from the triggering event.

Specified by:

getGuildId in class BaseCommandExecutor<MessageCreateEvent,MessageContextImpl,MessageHandlers,StringSplitter.Async.Iterator>

Parameters:

event - The triggering event.

Returns:

The ID of the guild where the event was invoked.

getGuild

protected Mono<Guild> getGuild(MessageCreateEvent event)

Description copied from class: BaseCommandExecutor

Retrieves the guild where the command was invoked, if any, from the triggering event.

Specified by:

getGuild in class BaseCommandExecutor<MessageCreateEvent,MessageContextImpl,MessageHandlers,StringSplitter.Async.Iterator>

Parameters:

event - The triggering event.

Returns:

The guild where the event was invoked.

getChannelId

protected Snowflake getChannelId(MessageCreateEvent event)

Description copied from class: BaseCommandExecutor

Retrieves the ID of the channel where the command was invoked from the triggering event.

Specified by:

getChannelId in class BaseCommandExecutor<MessageCreateEvent,MessageContextImpl,MessageHandlers,StringSplitter.Async.Iterator>

Parameters:

event - The triggering event.

Returns:

The ID of the channel where the event was invoked.

getChannel

protected Mono<MessageChannel> getChannel(MessageCreateEvent event)

Description copied from class: BaseCommandExecutor

Retrieves the channel where the command was invoked from the triggering event.

Specified by:

getChannel in class BaseCommandExecutor<MessageCreateEvent,MessageContextImpl,MessageHandlers,StringSplitter.Async.Iterator>

Parameters:

event - The triggering event.

Returns:

The channel where the event was invoked.

getCaller

protected User getCaller(MessageCreateEvent event)

Description copied from class: BaseCommandExecutor

Retrieves the user that invoked the command from the triggering event.

Specified by:

getCaller in class BaseCommandExecutor<MessageCreateEvent,MessageContextImpl,MessageHandlers,StringSplitter.Async.Iterator>

Parameters:

event - The triggering event.

Returns:

The user that invoked the command.

getInvocationHandler

protected InvocationHandler<? super MessageContextImpl> getInvocationHandler(MessageHandlers handlers)

Description copied from class: BaseCommandExecutor

Retrieves the invocation handler specified by the given hander set.

Specified by:

getInvocationHandler in class BaseCommandExecutor<MessageCreateEvent,MessageContextImpl,MessageHandlers,StringSplitter.Async.Iterator>

Parameters:

handlers - The handler set.

Returns:

The invocation handler.

getResultHandlers

protected List<? extends ResultHandler<? super MessageContextImpl>> getResultHandlers(MessageHandlers handlers)

Description copied from class: BaseCommandExecutor

Retrieves the result handlers specified by the given hander set.

Specified by:

getResultHandlers in class BaseCommandExecutor<MessageCreateEvent,MessageContextImpl,MessageHandlers,StringSplitter.Async.Iterator>

Parameters:

handlers - The handler set.

Returns:

The result handlers.