Index

A B C D E F G H I K L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

accessManager - Variable in class dev.sympho.modular_commands.execute.BaseCommandExecutor
The access manager to use for access checks.
accessManager(AccessManager) - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutorBuilder
Initializes the optional value accessManager to accessManager.
accessManager(Optional<? extends AccessManager>) - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutorBuilder
Initializes the optional value accessManager to accessManager.
accumulateGroups(List<? extends Command<?>>) - Static method in class dev.sympho.modular_commands.execute.InvocationUtils
Determines the total set of groups required for an execution chain.
ack(ReactionEmoji, String) - Static method in class dev.sympho.modular_commands.api.command.result.Results
Generates a result that acknowledges to the user that the command finished executing.
ackMono(ReactionEmoji, String) - Static method in class dev.sympho.modular_commands.api.command.result.Results
Generates a result that acknowledges to the user that the command finished executing.
ackR(ReactionEmoji, String) - Static method in class dev.sympho.modular_commands.api.command.result.Results
Alias for Results.ack(ReactionEmoji, String) that casts to a plain Result to avoid Generics issues.
adaptChannel(ParserFunction<C, T>, Class<C>) - Static method in class dev.sympho.modular_commands.utils.parse.ParseUtils
Creates an adapter for a channel parser to be used with string values.
adaptFloat(ParserFunction<Double, T>) - Static method in class dev.sympho.modular_commands.utils.parse.ParseUtils
Creates an adapter for an float parser to be used with string values.
adaptInteger(ParserFunction<Long, T>) - Static method in class dev.sympho.modular_commands.utils.parse.ParseUtils
Creates an adapter for an integer parser to be used with string values.
adaptMessage(ParserFunction<Message, T>) - Static method in class dev.sympho.modular_commands.utils.parse.ParseUtils
Creates an adapter for a message parser to be used with string values.
adaptRole(ParserFunction<Role, T>) - Static method in class dev.sympho.modular_commands.utils.parse.ParseUtils
Creates an adapter for a role parser to be used with string values.
adaptSnowflake(ParserFunction<Snowflake, T>) - Static method in class dev.sympho.modular_commands.utils.parse.ParseUtils
Creates an adapter for a snowflake parser to be used with string values.
adaptUser(ParserFunction<User, T>) - Static method in class dev.sympho.modular_commands.utils.parse.ParseUtils
Creates an adapter for an user parser to be used with string values.
addTags(E) - Method in class dev.sympho.modular_commands.execute.BaseCommandExecutor
Creates a function that adds the common instrumentation tags for the given event to Monos.
addTags(Mono<T>) - Method in interface dev.sympho.modular_commands.execute.InstrumentedContext
Adds the common instrumentation tags for this context to a Mono.
aliases() - Method in interface dev.sympho.modular_commands.api.command.Command
The aliases that may also invoke the command, when invoking through a message.
aliases(AliasProvider) - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutorBuilder
Initializes the optional value aliases to aliases.
aliases(Optional<? extends AliasProvider>) - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutorBuilder
Initializes the optional value aliases to aliases.
aliasInvocations() - Method in interface dev.sympho.modular_commands.api.command.Command
The alias invocations that may also invoke the command.
AliasProvider - Interface in dev.sympho.modular_commands.execute
Provides aliases that apply to message-based commands.
allowMerge() - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.ListParser
 
allowMerge() - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.StringParser
Whether to allow merge behavior when a parameter using this parser is the last parameter of the command.
ANY - Enum constant in enum class dev.sympho.modular_commands.api.command.parameter.parse.SnowflakeParser.Type
An arbitrary snowflake ID.
apply(C) - Method in interface dev.sympho.modular_commands.api.command.handler.InvocationHandler
 
apply(C, CommandResult) - Method in interface dev.sympho.modular_commands.api.command.handler.ResultHandler
 
apply(CommandContext, R) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.ParserFunction
 
apply(StringSplitter.Async.Iterator) - Method in interface dev.sympho.modular_commands.execute.AliasProvider
Applies aliases to the given iterator over received raw tokens.
apply(String) - Method in interface dev.sympho.modular_commands.utils.parse.RawParser
 
apply(String) - Method in interface dev.sympho.modular_commands.utils.StringSplitter
 
apply(Flux<T>) - Method in interface dev.sympho.modular_commands.execute.Metrics.Tag
Applies this tag to the given flux using Flux.tag(String, String).
apply(Mono<T>) - Method in interface dev.sympho.modular_commands.execute.Metrics.Tag
Applies this tag to the given mono using Mono.tag(String, String).
args() - Method in record class dev.sympho.modular_commands.api.command.result.CommandFailureArgumentExtra
Returns the value of the args record component.
argString() - Method in interface dev.sympho.modular_commands.api.command.context.MessageCommandContext
Retrieves the raw argument string as it was received, before being split.
argString() - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl
 
ArgumentParser<R extends @NonNull Object,T extends @NonNull Object> - Interface in dev.sympho.modular_commands.api.command.parameter.parse
Parses received arguments into their actual value.
attachment() - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives raw attachment values.
attachment(int, AttachmentParserStages.Parser<T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given parser to parse the contents received in an attachment, with no validation performed prior to receiving attachment data (other than the size limit).
attachment(AttachmentParserStages.Validator, AttachmentParserStages.Parser<T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given parser to parse the contents received in an attachment, with unbounded file size.
attachment(AttachmentParserStages.Validator, int, AttachmentParserStages.Parser<T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given validator and parser to parse the contents received in an attachment.
attachment(ParserFunction<Attachment, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given function to parse received values.
AttachmentDataParser<T extends @NonNull Object> - Interface in dev.sympho.modular_commands.api.command.parameter.parse
Parses received attachment arguments into their actual value.
AttachmentDataParser.Resources - Class in dev.sympho.modular_commands.api.command.parameter.parse
Resources used by an instance.
AttachmentDataParser.Resources.HttpClientRetriever - Interface in dev.sympho.modular_commands.api.command.parameter.parse
A function that determines the HTTP client that should be used to fetch an attachment's data based on the execution context.
AttachmentFetchFailedException - Exception in dev.sympho.modular_commands.api.command.parameter.parse
Exception raised when fetching an attachment argument fails.
AttachmentFetchFailedException(String) - Constructor for exception dev.sympho.modular_commands.api.command.parameter.parse.AttachmentFetchFailedException
Creates a new instance.
AttachmentParser<T extends @NonNull Object> - Interface in dev.sympho.modular_commands.api.command.parameter.parse
Parses received attachment arguments into their actual value.
AttachmentParserStages - Class in dev.sympho.modular_commands.api.command.parameter.parse
Components of an attachment argument parser.
AttachmentParserStages.Parser<T> - Interface in dev.sympho.modular_commands.api.command.parameter.parse
Parses the response from fetching the attachment file into the corresponding value.
AttachmentParserStages.Validator - Interface in dev.sympho.modular_commands.api.command.parameter.parse
Validates that the attachment is appropriate prior to fetching it.

B

BaseCommandExecutor<E extends Event,CTX extends InstrumentedContext & LazyContext,H extends Handlers,I extends SmartIterator<String>> - Class in dev.sympho.modular_commands.execute
Base implementation for a command executor.
BaseCommandExecutor(GatewayDiscordClient, Registry, Optional<AccessManager>, Optional<MeterRegistry>, Optional<ObservationRegistry>) - Constructor for class dev.sympho.modular_commands.execute.BaseCommandExecutor
Creates a new instance.
BaseHandler - Class in dev.sympho.modular_commands.execute
Provides the global base result handler.
bool() - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives plain boolean values.
bool(ParserFunction<Boolean, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given function to parse received values.
bool(T, T) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives one of two values depending on the argument.
BOOLEAN - Static variable in class dev.sympho.modular_commands.utils.parse.ParseUtils
Parser for booleans from strings.
BOOLEAN - Static variable in interface dev.sympho.modular_commands.utils.parse.RawParser
Parser for booleans.
BooleanParser<T extends @NonNull Object> - Interface in dev.sympho.modular_commands.api.command.parameter.parse
Parses boolean-based input arguments.
build() - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutorBuilder
Invokes new dev.sympho.modular_commands.execute.MessageCommandExecutor(..) using the collected parameters and returns the result of the invocation
builder() - Static method in interface dev.sympho.modular_commands.api.command.Command
Creates a new builder.
builder() - Static method in interface dev.sympho.modular_commands.api.command.parameter.Parameter
Creates a new builder.
builder() - Static method in class dev.sympho.modular_commands.execute.MessageCommandExecutor
Creates a new builder.
builder(Command<H>) - Static method in interface dev.sympho.modular_commands.api.command.Command
Creates a new builder initialized with the properties of the given command.
builder(Parameter<T>) - Static method in interface dev.sympho.modular_commands.api.command.parameter.Parameter
Creates a new builder initialized with the properties of the given parameter.
Builder() - Constructor for class dev.sympho.modular_commands.api.command.Command.Builder
 
Builder() - Constructor for class dev.sympho.modular_commands.api.command.parameter.Parameter.Builder
 
buildPipeline() - Method in class dev.sympho.modular_commands.execute.BaseCommandExecutor
 
buildPipeline() - Method in class dev.sympho.modular_commands.execute.CommandExecutor
Constructs the processing pipeline that processes command events.

C

callable() - Method in interface dev.sympho.modular_commands.api.command.Command
Whether this command can be invoked by a user.
caller() - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext
Retrieves the user that called the command.
callerMember() - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext
Retrieves the user that called the command as a guild member as provided by the triggering event, if present.
callerMember() - Method in interface dev.sympho.modular_commands.api.command.context.InteractionCommandContext
 
callerMember() - Method in interface dev.sympho.modular_commands.api.command.context.MessageCommandContext
 
callerMember(Snowflake) - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext
Retrieves the user that called the command as a guild member of the given guild.
castPresent(Optional<T>) - Static method in class dev.sympho.modular_commands.utils.OptionalUtils
Casts an optional as present.
cause() - Method in interface dev.sympho.modular_commands.api.command.result.CommandErrorException
Retrieves the cause of the error.
chain() - Method in record class dev.sympho.modular_commands.api.command.Invocation
Returns the value of the chain record component.
channel() - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext
 
channel() - Method in interface dev.sympho.modular_commands.api.command.context.InteractionCommandContext
 
channel() - Method in interface dev.sympho.modular_commands.api.command.context.MessageCommandContext
 
channel(CommandContext, Class<C>) - Static method in interface dev.sympho.modular_commands.utils.parse.RawParser
Creates a parser for channels with the given context.
channel(Class<C>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives raw channel values.
channel(Class<C>) - Static method in class dev.sympho.modular_commands.utils.parse.ParseUtils
Creates a parser for channels of the given type.
channel(Class<C>, ParserFunction<C, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given function to parse received values.
CHANNEL - Enum constant in enum class dev.sympho.modular_commands.api.command.parameter.parse.SnowflakeParser.Type
A channel ID.
CHANNEL_ID - Static variable in class dev.sympho.modular_commands.utils.parse.ParseUtils
Parser for channel IDs from strings.
ChannelArgumentParser<C extends Channel,T extends @NonNull Object> - Interface in dev.sympho.modular_commands.api.command.parameter.parse
Parses Discord channels.
channelId() - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives channel IDs.
channelId() - Method in record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.MessageRef
Returns the value of the channelId record component.
channelId(CommandContext) - Static method in interface dev.sympho.modular_commands.utils.parse.RawParser
Creates a parser for channel IDs with the given context.
channelId(ParserFunction<Snowflake, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given function to parse received values.
ChannelMentionParser<C extends @NonNull Channel> - Class in dev.sympho.modular_commands.utils.parse.entity
A parser for channel mentions.
ChannelMentionParser(Class<C>) - Constructor for class dev.sympho.modular_commands.utils.parse.entity.ChannelMentionParser
Creates a new instance.
ChannelParser<C extends @NonNull Channel> - Class in dev.sympho.modular_commands.utils.parse.entity
A parser that extracts a channel from a string.
ChannelParser(Class<C>) - Constructor for class dev.sympho.modular_commands.utils.parse.entity.ChannelParser
Creates a new instance.
channelRef(Class<C>) - Static method in class dev.sympho.modular_commands.utils.parse.ParseUtils
Creates a parser for channel references of the given type.
ChannelRef(Class<C>, Snowflake) - Constructor for record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.ChannelRef
Creates an instance of a ChannelRef record class.
ChannelRefMentionParser<C extends Channel> - Class in dev.sympho.modular_commands.utils.parse.entity
A parser for channel mentions to references.
ChannelRefMentionParser(Class<C>) - Constructor for class dev.sympho.modular_commands.utils.parse.entity.ChannelRefMentionParser
Creates a new instance.
ChannelRefParser<C extends @NonNull Channel> - Class in dev.sympho.modular_commands.utils.parse.entity
A parser that extracts a channel reference from a string.
ChannelRefParser(Class<C>) - Constructor for class dev.sympho.modular_commands.utils.parse.entity.ChannelRefParser
Creates a new instance.
ChannelRefUrlParser<C extends @NonNull Channel> - Class in dev.sympho.modular_commands.utils.parse.entity
A reference parser for channel URLs.
ChannelRefUrlParser(Class<C>) - Constructor for class dev.sympho.modular_commands.utils.parse.entity.ChannelRefUrlParser
Creates a new instance.
channels(Class<C>) - Static method in class dev.sympho.modular_commands.utils.parse.ParseUtils
A parser that parses a list of channels.
ChannelUrlParser<C extends @NonNull Channel> - Class in dev.sympho.modular_commands.utils.parse.entity
A parser for channel URLs.
ChannelUrlParser(Class<C>) - Constructor for class dev.sympho.modular_commands.utils.parse.entity.ChannelUrlParser
Creates a new instance.
checkType(Command<?>, Class<H>) - Static method in class dev.sympho.modular_commands.execute.InvocationUtils
Determines if a command has handlers compatible with the given type.
child(String) - Method in record class dev.sympho.modular_commands.api.command.Invocation
Determines the invocation formed by adding the given command name to this invocation.
choice(FunctorUrlParser<T>...) - Static method in interface dev.sympho.modular_commands.utils.parse.FunctorUrlParser
Creates a parser that delegates to the given parsers.
choice(UrlParser<T>...) - Static method in interface dev.sympho.modular_commands.utils.parse.UrlParser
Creates a parser that delegates to the given parsers.
choice(Collection<? extends FunctorUrlParser<T>>) - Static method in interface dev.sympho.modular_commands.utils.parse.FunctorUrlParser
Creates a parser that delegates to the given parsers.
choice(Collection<? extends UrlParser<T>>) - Static method in interface dev.sympho.modular_commands.utils.parse.UrlParser
Creates a parser that delegates to the given parsers.
choice(Function<URL, FunctorUrlParser<T>>) - Static method in interface dev.sympho.modular_commands.utils.parse.FunctorUrlParser
Creates a parser that delegates to other parsers, chosen by the given mapping function based on the URL to parse.
choice(Function<URL, UrlParser<T>>) - Static method in interface dev.sympho.modular_commands.utils.parse.UrlParser
Creates a parser that delegates to other parsers, chosen by the given mapping function based on the URL to parse.
Choice(String, P) - Constructor for record class dev.sympho.modular_commands.api.command.parameter.parse.ChoicesParser.Choice
Creates an instance of a Choice record class.
Choice(Function<URL, FunctorUrlParser<T>>) - Constructor for class dev.sympho.modular_commands.utils.parse.FunctorUrlParser.Choice
Creates a new instance.
Choice(Function<URL, UrlParser<T>>) - Constructor for class dev.sympho.modular_commands.utils.parse.UrlParser.Choice
Creates a new instance.
ChoiceBase(Function<URL, P>) - Constructor for class dev.sympho.modular_commands.utils.parse.FunctorUrlParser.ChoiceBase
Creates a new instance.
ChoiceBase(Function<URL, P>) - Constructor for class dev.sympho.modular_commands.utils.parse.UrlParser.ChoiceBase
Creates a new instance.
choiceHost(Map<String, ? extends FunctorUrlParser<T>>) - Static method in interface dev.sympho.modular_commands.utils.parse.FunctorUrlParser
Creates a parser that delegates to a parser depending on the host of the URL, using the given host-parser mappings.
choiceHost(Map<String, ? extends UrlParser<T>>) - Static method in interface dev.sympho.modular_commands.utils.parse.UrlParser
Creates a parser that delegates to a parser depending on the host of the URL, using the given host-parser mappings.
choiceInteger(List<Map.Entry<ChoicesParser.Choice<Long>, T>>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives a value from within a set of choices.
choiceInteger(Map.Entry<ChoicesParser.Choice<Long>, T>...) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives a value from within a set of choices.
choices() - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.ChoicesParser
The allowed choices.
ChoicesParser<P extends @NonNull Object,T extends @NonNull Object> - Interface in dev.sympho.modular_commands.api.command.parameter.parse
Parses received input arguments, potentially restricting the acceptable values to a set of choices.
ChoicesParser.Choice<P extends @NonNull Object> - Record Class in dev.sympho.modular_commands.api.command.parameter.parse
A possible choice to be selected.
clearPrefix(Snowflake) - Method in record class dev.sympho.modular_commands.execute.GuildPrefix
Clears the override for a guild, if there is one.
client - Variable in class dev.sympho.modular_commands.execute.BaseCommandExecutor
The client to receive events from.
client(GatewayDiscordClient) - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutorBuilder
Initializes the value for the client attribute.
command - Variable in class dev.sympho.modular_commands.impl.context.MessageContextImpl
The invoked command.
Command<H extends @NonNull Handlers> - Interface in dev.sympho.modular_commands.api.command
A command that can be invoked by a user.
Command.Builder<H extends @NonNull Handlers> - Class in dev.sympho.modular_commands.api.command
The default builder.
Command.Scope - Enum Class in dev.sympho.modular_commands.api.command
The scopes that a command may be defined in.
CommandContext - Interface in dev.sympho.modular_commands.api.command.context
The execution context of an invoked command.
CommandError - Interface in dev.sympho.modular_commands.api.command.result
The result from a command that fails to execute due to an internal error.
CommandErrorException - Interface in dev.sympho.modular_commands.api.command.result
An error result due to an exception being thrown.
CommandException - Exception in dev.sympho.modular_commands.api.exception
Base type for exceptions related to the command system.
CommandException() - Constructor for exception dev.sympho.modular_commands.api.exception.CommandException
Constructs a new exception.
CommandException(String) - Constructor for exception dev.sympho.modular_commands.api.exception.CommandException
Constructs a new exception.
CommandException(String, Throwable, boolean, boolean) - Constructor for exception dev.sympho.modular_commands.api.exception.CommandException
Constructs a new exception.
CommandException(String, Throwable) - Constructor for exception dev.sympho.modular_commands.api.exception.CommandException
Constructs a new exception.
CommandException(Throwable) - Constructor for exception dev.sympho.modular_commands.api.exception.CommandException
Constructs a new exception.
CommandExecutor - Class in dev.sympho.modular_commands.execute
Executor that receives events and invokes triggered commands as appropriate.
CommandExecutor() - Constructor for class dev.sympho.modular_commands.execute.CommandExecutor
Creates a new instance.
CommandFailure - Interface in dev.sympho.modular_commands.api.command.result
The result from a command that fails to execute due to user error.
CommandFailureArgument - Interface in dev.sympho.modular_commands.api.command.result
Failure result due to an issue with the provided arguments.
CommandFailureArgumentExtra - Record Class in dev.sympho.modular_commands.api.command.result
Failure result due to one or more argument being provided where one wasn't expected.
CommandFailureArgumentExtra(List<String>) - Constructor for record class dev.sympho.modular_commands.api.command.result.CommandFailureArgumentExtra
Creates an instance of a CommandFailureArgumentExtra record class.
CommandFailureArgumentInvalid - Record Class in dev.sympho.modular_commands.api.command.result
Failure result due to a provided argument being invalid.
CommandFailureArgumentInvalid(Parameter<?>, String) - Constructor for record class dev.sympho.modular_commands.api.command.result.CommandFailureArgumentInvalid
Creates an instance of a CommandFailureArgumentInvalid record class.
CommandFailureArgumentMissing - Record Class in dev.sympho.modular_commands.api.command.result
Failure result due to a required argument not being provided.
CommandFailureArgumentMissing(Parameter<?>) - Constructor for record class dev.sympho.modular_commands.api.command.result.CommandFailureArgumentMissing
Creates an instance of a CommandFailureArgumentMissing record class.
CommandFailureMessage - Interface in dev.sympho.modular_commands.api.command.result
A failure result with a message to the user.
CommandGroup - Interface in dev.sympho.modular_commands.api
Encapsulates a group of commands.
CommandId(String) - Constructor for record class dev.sympho.modular_commands.execute.Metrics.Tag.CommandId
Creates a new instance.
commandInvocation() - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext
Retrieves the canonical invocation of the triggered command, that is, the value of Command.invocation().
commandInvocation() - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl
 
CommandResult - Interface in dev.sympho.modular_commands.api.command.result
The result of a command.
commands() - Method in interface dev.sympho.modular_commands.api.CommandGroup
Retrieves the commands contained in this group.
CommandSuccess - Interface in dev.sympho.modular_commands.api.command.result
The result from a command that ran successfully.
CommandSuccessAck - Interface in dev.sympho.modular_commands.api.command.result
A successful result that should be acknowledged to the user.
CommandSuccessMessage - Interface in dev.sympho.modular_commands.api.command.result
A successful result with a message to the user.
commandType() - Method in class dev.sympho.modular_commands.execute.BaseCommandExecutor
Retrives the command type to use.
commandType() - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutor
 
CommandUtils - Class in dev.sympho.modular_commands.utils
Utility functions for Commands.
CONTINUE - Static variable in interface dev.sympho.modular_commands.api.command.handler.Handlers
An invocation handler that simply signals that handling should continue.

D

DEFAULT - Static variable in class dev.sympho.modular_commands.execute.BaseHandler
The initial/default base handler.
DEFAULT_CALLABLE - Static variable in interface dev.sympho.modular_commands.api.command.Command
Default for Command.callable().
DEFAULT_CLIENT_GETTER - Static variable in class dev.sympho.modular_commands.api.command.parameter.parse.AttachmentDataParser.Resources
The default HTTP client getter.
DEFAULT_DEFER - Static variable in interface dev.sympho.modular_commands.api.command.Command
DEFAULT_GROUP - Static variable in interface dev.sympho.modular_commands.api.command.Command
DEFAULT_INHERIT - Static variable in interface dev.sympho.modular_commands.api.command.Command
DEFAULT_INVOKE_PARENT - Static variable in interface dev.sympho.modular_commands.api.command.Command
DEFAULT_NSFW - Static variable in interface dev.sympho.modular_commands.api.command.Command
Default for Command.nsfw().
DEFAULT_PRIVATE - Static variable in interface dev.sympho.modular_commands.api.command.Command
DEFAULT_REQUIRE_PARENT_GROUPS - Static variable in interface dev.sympho.modular_commands.api.command.Command
DEFAULT_SCOPE - Static variable in interface dev.sympho.modular_commands.api.command.Command
DEFAULT_SKIP - Static variable in interface dev.sympho.modular_commands.api.command.Command
DEFAULT_SPLITTER - Static variable in interface dev.sympho.modular_commands.api.command.parameter.parse.ListParser
The default splitter (StringSplitter.Shell).
defaultGuild(CommandContext) - Static method in record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.RoleRef
Obtains the default guild based on the context.
defaultPrefix() - Method in record class dev.sympho.modular_commands.execute.GuildPrefix
Returns the value of the defaultPrefix record component.
defaultValue() - Method in interface dev.sympho.modular_commands.api.command.parameter.Parameter
The default value for the parameter.
deferReply() - Method in interface dev.sympho.modular_commands.api.command.Command
Whether the initial reply to the command should be automatically deferred.
delimiter() - Method in interface dev.sympho.modular_commands.utils.StringSplitter
Obtains a string that can be used to delimit two elements according to this splitter.
delimiter() - Method in class dev.sympho.modular_commands.utils.StringSplitter.Shell
 
description() - Method in interface dev.sympho.modular_commands.api.command.Command
The description of the command.
description() - Method in interface dev.sympho.modular_commands.api.command.parameter.Parameter
The description of the parameter.
DESCRIPTION_REGEX - Static variable in interface dev.sympho.modular_commands.api.command.Command
Pattern for valid command descriptions in the Discord API.
DESCRIPTION_REGEX - Static variable in interface dev.sympho.modular_commands.api.command.parameter.Parameter
Pattern for valid parameter descriptions in the Discord API.
dev.sympho.modular_commands - package dev.sympho.modular_commands
Framework for creating and managing chat commands for Discord bots that use Discord4J.
dev.sympho.modular_commands.api - package dev.sympho.modular_commands.api
External interface through which client code can utilize the command system.
dev.sympho.modular_commands.api.command - package dev.sympho.modular_commands.api.command
APIs related to defining a command.
dev.sympho.modular_commands.api.command.context - package dev.sympho.modular_commands.api.command.context
Interfaces that represent the invocation context of a command.
dev.sympho.modular_commands.api.command.handler - package dev.sympho.modular_commands.api.command.handler
Handler interfaces used across the system.
dev.sympho.modular_commands.api.command.parameter - package dev.sympho.modular_commands.api.command.parameter
API for defining the parameters that a command takes.
dev.sympho.modular_commands.api.command.parameter.parse - package dev.sympho.modular_commands.api.command.parameter.parse
Interfaces defining how received arguments are parsed.
dev.sympho.modular_commands.api.command.result - package dev.sympho.modular_commands.api.command.result
Interfaces defining the result of handling an invoked command.
dev.sympho.modular_commands.api.exception - package dev.sympho.modular_commands.api.exception
Exceptions thrown by the system.
dev.sympho.modular_commands.api.registry - package dev.sympho.modular_commands.api.registry
Registry system for registering commands that can be executed.
dev.sympho.modular_commands.execute - package dev.sympho.modular_commands.execute
Runtime system for executing commands defined through the API.
dev.sympho.modular_commands.impl - package dev.sympho.modular_commands.impl
Internal implementation-specific classes.
dev.sympho.modular_commands.impl.context - package dev.sympho.modular_commands.impl.context
Implementations for command contexts.
dev.sympho.modular_commands.impl.registry - package dev.sympho.modular_commands.impl.registry
Default implementations for registries.
dev.sympho.modular_commands.utils - package dev.sympho.modular_commands.utils
Collection of classes that provide assorted utilies for ease of use.
dev.sympho.modular_commands.utils.parse - package dev.sympho.modular_commands.utils.parse
Parsing utilities.
dev.sympho.modular_commands.utils.parse.entity - package dev.sympho.modular_commands.utils.parse.entity
Parsers for Discord entities.
DISPLAY_NAME_REGEX - Static variable in interface dev.sympho.modular_commands.api.command.Command
Pattern for valid user/message command names in the Discord API.
displayName() - Method in interface dev.sympho.modular_commands.api.command.Command
The display name of the command.
doLoad(ObservationRegistry) - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl
Performs the LazyContext.load() operation.

E

empty() - Static method in interface dev.sympho.modular_commands.utils.SmartIterator
Returns an empty iterator.
EMPTY - Static variable in record class dev.sympho.modular_commands.api.command.Invocation
The empty invocation.
emptyIterator() - Method in interface dev.sympho.modular_commands.utils.StringSplitter.Async
Creates an empty iterator for this splitter.
emptyIterator() - Method in interface dev.sympho.modular_commands.utils.StringSplitter
Creates an empty iterator for this splitter.
EntityArgumentParser<E extends @NonNull Entity,T extends @NonNull Object> - Interface in dev.sympho.modular_commands.api.command.parameter.parse
Parses Discord entities.
EntityMentionParser<E extends @NonNull Entity> - Class in dev.sympho.modular_commands.utils.parse.entity
A parser for mentions of Discord entities.
EntityMentionParser(EntityRefMentionParser<? extends EntityRef<E>>) - Constructor for class dev.sympho.modular_commands.utils.parse.entity.EntityMentionParser
Creates a new instance.
EntityParser<E extends @NonNull Entity> - Class in dev.sympho.modular_commands.utils.parse.entity
A parser that extracts an entity from a string.
EntityParser(EntityRefParser<? extends EntityRef<E>>) - Constructor for class dev.sympho.modular_commands.utils.parse.entity.EntityParser
Creates a new instance.
EntityRef<E extends @NonNull Entity> - Interface in dev.sympho.modular_commands.utils.parse.entity
A reference to a Discord entity that can be used to fetch the entity.
EntityRef.ChannelRef<C extends @NonNull Channel> - Record Class in dev.sympho.modular_commands.utils.parse.entity
A reference to a channel.
EntityRef.MessageRef - Record Class in dev.sympho.modular_commands.utils.parse.entity
A reference to a message.
EntityRef.RoleRef - Record Class in dev.sympho.modular_commands.utils.parse.entity
A reference to a role.
EntityRef.UserRef - Record Class in dev.sympho.modular_commands.utils.parse.entity
A reference to a user.
EntityRefMentionParser<R extends EntityRef<? extends @NonNull Entity>> - Class in dev.sympho.modular_commands.utils.parse.entity
A parser for mentions of Discord entities to references.
EntityRefMentionParser() - Constructor for class dev.sympho.modular_commands.utils.parse.entity.EntityRefMentionParser
 
EntityRefParser<R extends EntityRef<? extends @NonNull Entity>> - Class in dev.sympho.modular_commands.utils.parse.entity
A parser that extracts an entity reference from a string.
EntityRefParser(EntityRefUrlParser<R>, EntityRefMentionParser<R>) - Constructor for class dev.sympho.modular_commands.utils.parse.entity.EntityRefParser
Creates a new instance.
EntityRefUrlParser<R extends EntityRef<? extends @NonNull Entity>> - Class in dev.sympho.modular_commands.utils.parse.entity
A parser for URLs of Discord entities to references.
EntityRefUrlParser() - Constructor for class dev.sympho.modular_commands.utils.parse.entity.EntityRefUrlParser
 
EntityUrlParser<E extends @NonNull Entity> - Class in dev.sympho.modular_commands.utils.parse.entity
A parser for URLs of Discord entities.
EntityUrlParser(EntityRefUrlParser<? extends EntityRef<E>>) - Constructor for class dev.sympho.modular_commands.utils.parse.entity.EntityUrlParser
Creates a new instance.
enums(Class<E>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives an enum value.
equals(Object) - Method in record class dev.sympho.modular_commands.api.command.handler.InteractionHandlers.Impl
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.sympho.modular_commands.api.command.handler.MessageHandlers.Impl
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.sympho.modular_commands.api.command.handler.SlashHandlers.Impl
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.sympho.modular_commands.api.command.handler.TextHandlers.Impl
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.sympho.modular_commands.api.command.Invocation
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.sympho.modular_commands.api.command.parameter.parse.ChoicesParser.Choice
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.sympho.modular_commands.api.command.result.CommandFailureArgumentExtra
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.sympho.modular_commands.api.command.result.CommandFailureArgumentInvalid
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.sympho.modular_commands.api.command.result.CommandFailureArgumentMissing
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.sympho.modular_commands.api.command.result.UserNotAllowed
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.sympho.modular_commands.execute.GuildPrefix
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.sympho.modular_commands.execute.Metrics.Tag.CommandId
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.sympho.modular_commands.execute.StaticPrefix
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.ChannelRef
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.MessageRef
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.RoleRef
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.UserRef
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.sympho.modular_commands.utils.parse.StringAdapter
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.sympho.modular_commands.utils.parse.TryParser.Failure
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.sympho.modular_commands.utils.parse.TryParser.Success
Indicates whether some other object is "equal to" this one.
error() - Method in record class dev.sympho.modular_commands.api.command.result.CommandFailureArgumentInvalid
Returns the value of the error record component.
error() - Method in record class dev.sympho.modular_commands.utils.parse.TryParser.Failure
Returns the value of the error record component.
error() - Method in interface dev.sympho.modular_commands.utils.parse.TryParser.Result
The error encountered in parsing, if any.
error() - Method in record class dev.sympho.modular_commands.utils.parse.TryParser.Success
 
error(String) - Static method in class dev.sympho.modular_commands.api.command.result.Results
Generates a result indicating the command encountered an error.
errorMono(String) - Static method in class dev.sympho.modular_commands.api.command.result.Results
Generates a result indicating the command encountered an error.
errorR(String) - Static method in class dev.sympho.modular_commands.api.command.result.Results
Alias for Results.error(String) that casts to a plain Result to avoid Generics issues.
errors() - Method in exception dev.sympho.modular_commands.api.command.parameter.parse.InvalidListException
Retrieves the items that had errors.
errors(List<TryParser.Result<R, T>>) - Static method in interface dev.sympho.modular_commands.utils.parse.TryParser
Extracts the items in a result list that had errors.
eventFilter(MessageCreateEvent) - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutor
 
eventFilter(E) - Method in class dev.sympho.modular_commands.execute.BaseCommandExecutor
Determines if an event should be processed for commands.
eventType() - Method in class dev.sympho.modular_commands.execute.BaseCommandExecutor
Retrieves the event type to listen for.
eventType() - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutor
 
everyoneId(CommandContext) - Static method in record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.RoleRef
Obtains the ID for the @everyone role.
exception(Throwable) - Static method in class dev.sympho.modular_commands.api.command.result.Results
Generates a result indicating the command encountered an error due to an exception.
exceptionMono(Throwable) - Static method in class dev.sympho.modular_commands.api.command.result.Results
Generates a result indicating the command encountered an error due to an exception.
exceptionR(Throwable) - Static method in class dev.sympho.modular_commands.api.command.result.Results
Alias for Results.exception(Throwable) that casts to a plain Result to avoid Generics issues.

F

fail() - Static method in class dev.sympho.modular_commands.api.command.result.Results
Generates a result indicating the command failed with no further context.
FAIL - Static variable in class dev.sympho.modular_commands.api.command.result.Results
Result indicating the command failed with no further context.
failFast() - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.ListParser
Determines whether the parser should fail on the first element that encounters an error (true), or finish parsing all elements before reporting an InvalidListException with all encountered errors (false).
failMono() - Static method in class dev.sympho.modular_commands.api.command.result.Results
Generates a result indicating the command failed with no further context.
failR() - Static method in class dev.sympho.modular_commands.api.command.result.Results
Alias for Results.fail() that casts to a plain Result to avoid Generics issues.
failure(String) - Static method in class dev.sympho.modular_commands.api.command.result.Results
Generates a result indicating the command failed with a message to the user.
Failure(R, InvalidArgumentException) - Constructor for record class dev.sympho.modular_commands.utils.parse.TryParser.Failure
Creates an instance of a Failure record class.
failureMono(String) - Static method in class dev.sympho.modular_commands.api.command.result.Results
Generates a result indicating the command failed with a message to the user.
failureR(String) - Static method in class dev.sympho.modular_commands.api.command.result.Results
Alias for Results.failure(String) that casts to a plain Result to avoid Generics issues.
findCommand(Invocation, Class<H>) - Method in interface dev.sympho.modular_commands.api.registry.Registry
Retrieves the best command known to this registry that has the given invocation, and is compatible with the given type.
findCommand(Invocation, Class<H>) - Method in class dev.sympho.modular_commands.impl.registry.SimpleRegistry
 
FLOAT - Static variable in class dev.sympho.modular_commands.utils.parse.ParseUtils
Parser for floats from strings.
FLOAT - Static variable in interface dev.sympho.modular_commands.utils.parse.RawParser
Parser for floats.
FloatParser<T extends @NonNull Object> - Interface in dev.sympho.modular_commands.api.command.parameter.parse
Parses float-based input arguments.
floats() - Static method in class dev.sympho.modular_commands.utils.parse.ParseUtils
A parser that parses a list of floats.
flux(ParserFunction<String, Mono<T>>) - Static method in class dev.sympho.modular_commands.utils.parse.ParseUtils
A parser that generates a flux by using the default list parser to split the raw argument, then the given item parser to convert each item into a mono, which are then merged.
format(long) - Static method in class dev.sympho.modular_commands.utils.SizeUtils
Formats a size to the nearest (supported) prefix.
from(String) - Static method in record class dev.sympho.modular_commands.execute.Metrics.Tag.CommandId
Creates a tag with the given id as value.
from(Iterator<E>) - Static method in interface dev.sympho.modular_commands.utils.SmartIterator
Creates a smart iterator backed by the given iterator.
from(List<E>) - Static method in interface dev.sympho.modular_commands.utils.SmartIterator
Creates a smart iterator that iterates over the contents of the given list.
fullMatch() - Method in class dev.sympho.modular_commands.execute.BaseCommandExecutor
Determines whether a parsed arg list (as given by BaseCommandExecutor.parse(Event)) must always be fully matched to a command.
fullMatch() - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutor
 
functor(Parsers.Functor<R, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Uses a parser that does not depend on the execution context.
FunctorUrlParser<T extends @NonNull Object> - Interface in dev.sympho.modular_commands.utils.parse
A parser for URL-based arguments that are independent from the invocation context.
FunctorUrlParser.Choice<T extends @NonNull Object> - Class in dev.sympho.modular_commands.utils.parse
Parser that supports multiple URL types by delegating to one of a list of parsers.
FunctorUrlParser.ChoiceBase<T extends @NonNull Object,P extends FunctorUrlParser<T>> - Class in dev.sympho.modular_commands.utils.parse
Base for a parser that supports multiple URL types by delegating to one of a list of parsers.
FunctorUrlParser.PostParser<I extends @NonNull Object,T extends @NonNull Object,P1 extends @NonNull FunctorUrlParser<I>,P2 extends @NonNull Parsers.Functor<I,T>> - Class in dev.sympho.modular_commands.utils.parse
A composed parser that first applies this parser to one parser, and then applies the results to a second parser.

G

get() - Static method in class dev.sympho.modular_commands.execute.BaseHandler
Retrieves the current base handler.
get(GatewayDiscordClient) - Method in record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.ChannelRef
 
get(GatewayDiscordClient) - Method in interface dev.sympho.modular_commands.utils.parse.entity.EntityRef
Obtains the referenced entity.
get(GatewayDiscordClient) - Method in record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.MessageRef
 
get(GatewayDiscordClient) - Method in record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.RoleRef
 
get(GatewayDiscordClient) - Method in record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.UserRef
 
getArgument(Parameter<? extends T>) - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext
Retrieves one of the arguments to the command.
getArgument(Parameter<? extends T>) - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl
 
getArgument(Parameter<? extends T>, Class<T>) - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext
Retrieves one of the arguments to the command.
getArgument(String, Class<T>) - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext
Retrieves one of the arguments to the command.
getArgument(String, Class<T>) - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl
 
getAttachmentArgument(String) - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl
 
getBooleanArgument(String) - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl
 
getCaller(MessageCreateEvent) - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutor
 
getCaller(E) - Method in class dev.sympho.modular_commands.execute.BaseCommandExecutor
Retrieves the user that invoked the command from the triggering event.
getCaller(E) - Method in class dev.sympho.modular_commands.execute.InvocationValidator
Retrieves the command's caller from the triggering event.
getChannel(MessageCreateEvent) - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutor
 
getChannel(E) - Method in class dev.sympho.modular_commands.execute.BaseCommandExecutor
Retrieves the channel where the command was invoked from the triggering event.
getChannel(E) - Method in class dev.sympho.modular_commands.execute.InvocationValidator
Retrieves the channel where the command was invoked from the triggering event.
getChannelArgument(String, Class<C>) - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl
 
getChannelId(MessageCreateEvent) - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutor
 
getChannelId(E) - Method in class dev.sympho.modular_commands.execute.BaseCommandExecutor
Retrieves the ID of the channel where the command was invoked from the triggering event.
getCharset(HttpClientResponse) - Static method in class dev.sympho.modular_commands.utils.HttpUtils
Retrives the charset used to encode an HTTP response.
getCharset(HttpClientResponse, Function<String, E>) - Static method in class dev.sympho.modular_commands.utils.HttpUtils
Retrives the charset used to encode an HTTP response.
getClient(CommandContext) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.AttachmentDataParser.Resources.HttpClientRetriever
Determines the HTTP client to use with the given execution context.
getClientGetter() - Method in class dev.sympho.modular_commands.api.command.parameter.parse.AttachmentDataParser.Resources
Retrieves the function to be used to obtain an HTTP client for fetching attachment data unless overriden by the parser.
getCommand() - Method in exception dev.sympho.modular_commands.api.exception.IncompleteHandlingException
Retrieves the command that was invoked.
getCommand() - Method in exception dev.sympho.modular_commands.api.exception.InvalidChainException
Retrieves the command that was being executed.
getCommand(String) - Method in interface dev.sympho.modular_commands.api.registry.Registry
Retrieves the command with the given ID that is registered to this registry.
getCommand(String) - Method in class dev.sympho.modular_commands.impl.registry.SimpleRegistry
 
getCommandId() - Method in interface dev.sympho.modular_commands.execute.InstrumentedContext
Retrieves the ID of the invoked command.
getCommandId() - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl
 
getCommands(Class<H>) - Method in interface dev.sympho.modular_commands.api.registry.Registry
Retrieves all commands known to this registry that are compatible with the given type.
getCommands(Class<H>) - Method in class dev.sympho.modular_commands.impl.registry.SimpleRegistry
 
getContext(String, Class<? extends T>) - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext
Retrieves a context object set by CommandContext.setContext(String, Object, boolean).
getContext(String, Class<? extends T>) - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl
 
getExecutionChain() - Method in exception dev.sympho.modular_commands.api.exception.IncompleteHandlingException
Retrieves the command chain that was being executed.
getFloatArgument(String) - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl
 
getGuild(MessageCreateEvent) - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutor
 
getGuild(E) - Method in class dev.sympho.modular_commands.execute.BaseCommandExecutor
Retrieves the guild where the command was invoked, if any, from the triggering event.
getGuild(E) - Method in class dev.sympho.modular_commands.execute.InvocationValidator
Retrieves the guild where the command was invoked from the triggering event.
getGuildId(MessageCreateEvent) - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutor
 
getGuildId(E) - Method in class dev.sympho.modular_commands.execute.BaseCommandExecutor
Retrieves the ID of the guild where the command was invoked, if any, from the triggering event.
getHttpClient(CommandContext) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.AttachmentDataParser
Determines the HTTP client to use to fetch the attachment.
getIntegerArgument(String) - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl
 
getInvocation() - Method in exception dev.sympho.modular_commands.api.exception.IncompleteHandlingException
Retrieves the invocation that triggered the command.
getInvocationHandler(MessageHandlers) - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutor
 
getInvocationHandler(H) - Method in class dev.sympho.modular_commands.execute.BaseCommandExecutor
Retrieves the invocation handler specified by the given hander set.
getInvokedCommand(List<? extends C>) - Static method in class dev.sympho.modular_commands.execute.InvocationUtils
Extracts the command being invoked from an execution chain.
getMessage() - Method in exception dev.sympho.modular_commands.api.command.parameter.parse.AttachmentFetchFailedException
 
getMessage() - Method in exception dev.sympho.modular_commands.api.command.parameter.parse.InvalidArgumentException
 
getMessageArgument(String) - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl
Retrieves the message argument associated with the parameter of the given name.
getParent() - Method in exception dev.sympho.modular_commands.api.exception.InvalidChainException
Retrieves the ancestor that is incompatible.
getParser(URL) - Method in class dev.sympho.modular_commands.utils.parse.UrlParser.ChoiceBase
Retrives the parser to use for the given URL.
getPrefix(Snowflake) - Method in record class dev.sympho.modular_commands.execute.GuildPrefix
 
getPrefix(Snowflake) - Method in interface dev.sympho.modular_commands.execute.PrefixProvider
Determines the prefix that should be used for the given guild.
getPrefix(Snowflake) - Method in record class dev.sympho.modular_commands.execute.StaticPrefix
 
getResult() - Method in exception dev.sympho.modular_commands.api.exception.ResultException
Retrieves the execution result.
getResultHandlers(MessageHandlers) - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutor
 
getResultHandlers(H) - Method in class dev.sympho.modular_commands.execute.BaseCommandExecutor
Retrieves the result handlers specified by the given hander set.
getRoleArgument(String) - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl
 
getSettingsSource(List<C>) - Static method in class dev.sympho.modular_commands.execute.InvocationUtils
Determines the command in the execution chain that should provide the invocation settings.
getSnowflakeArgument(String, SnowflakeParser.Type) - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl
 
getStringArgument(String) - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl
 
getUrl(Attachment) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.AttachmentDataParser
Obtains the URL to download the attachment from.
getUrl(String) - Static method in interface dev.sympho.modular_commands.utils.parse.UrlParser
Parses the given string into a URL.
getUserArgument(String) - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl
 
giga(int) - Static method in class dev.sympho.modular_commands.utils.SizeUtils
Makes a size in gigabytes.
giga(long) - Static method in class dev.sympho.modular_commands.utils.SizeUtils
Makes a size in gigabytes.
GIGA - Static variable in class dev.sympho.modular_commands.utils.SizeUtils
The value of the G prefix.
GLOBAL - Enum constant in enum class dev.sympho.modular_commands.api.command.Command.Scope
A command that can be invoked in either guild channels or private channels.
GLOBAL_RESOURCES - Static variable in interface dev.sympho.modular_commands.api.command.parameter.parse.AttachmentDataParser
Resources used by all instances.
GUILD - Enum constant in enum class dev.sympho.modular_commands.api.command.Command.Scope
A command that can only be invoked in guild channels.
guildId() - Method in record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.RoleRef
Returns the value of the guildId record component.
GuildPrefix - Record Class in dev.sympho.modular_commands.execute
Prefix provider that allows prefix overrides per guild while falling back to a default construction-time prefix if no override.
GuildPrefix(String) - Constructor for record class dev.sympho.modular_commands.execute.GuildPrefix
Creates a new instance with no overrides.
GuildPrefix(Map<Snowflake, String>, String) - Constructor for record class dev.sympho.modular_commands.execute.GuildPrefix
Creates a new instance with the given set of initial overrides.

H

handle(C) - Method in interface dev.sympho.modular_commands.api.command.handler.InvocationHandler
Handles an invocation of the command.
handle(C, CommandResult) - Method in interface dev.sympho.modular_commands.api.command.handler.ResultHandler
Handles the result of a command.
handlers() - Method in interface dev.sympho.modular_commands.api.command.Command
The handlers to use for processing an invocation of the command.
Handlers - Interface in dev.sympho.modular_commands.api.command.handler
A set of handlers for executing an invocation of a command.
handleWrapped(C) - Method in interface dev.sympho.modular_commands.api.command.handler.InvocationHandler
Handles an invocation of the command using InvocationHandler.handle(CommandContext), automatically converting any exception thrown in that method or issued in the resulting mono to an exception result (with the exception of a ResultException, which is unpacked into the contained result).
handlingOrder(List<C>) - Static method in class dev.sympho.modular_commands.execute.InvocationUtils
Determines the sequence that command handlers should be invoked in for the given chain.
hashCode() - Method in record class dev.sympho.modular_commands.api.command.handler.InteractionHandlers.Impl
Returns a hash code value for this object.
hashCode() - Method in record class dev.sympho.modular_commands.api.command.handler.MessageHandlers.Impl
Returns a hash code value for this object.
hashCode() - Method in record class dev.sympho.modular_commands.api.command.handler.SlashHandlers.Impl
Returns a hash code value for this object.
hashCode() - Method in record class dev.sympho.modular_commands.api.command.handler.TextHandlers.Impl
Returns a hash code value for this object.
hashCode() - Method in record class dev.sympho.modular_commands.api.command.Invocation
Returns a hash code value for this object.
hashCode() - Method in record class dev.sympho.modular_commands.api.command.parameter.parse.ChoicesParser.Choice
Returns a hash code value for this object.
hashCode() - Method in record class dev.sympho.modular_commands.api.command.result.CommandFailureArgumentExtra
Returns a hash code value for this object.
hashCode() - Method in record class dev.sympho.modular_commands.api.command.result.CommandFailureArgumentInvalid
Returns a hash code value for this object.
hashCode() - Method in record class dev.sympho.modular_commands.api.command.result.CommandFailureArgumentMissing
Returns a hash code value for this object.
hashCode() - Method in record class dev.sympho.modular_commands.api.command.result.UserNotAllowed
Returns a hash code value for this object.
hashCode() - Method in record class dev.sympho.modular_commands.execute.GuildPrefix
Returns a hash code value for this object.
hashCode() - Method in record class dev.sympho.modular_commands.execute.Metrics.Tag.CommandId
Returns a hash code value for this object.
hashCode() - Method in record class dev.sympho.modular_commands.execute.StaticPrefix
Returns a hash code value for this object.
hashCode() - Method in record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.ChannelRef
Returns a hash code value for this object.
hashCode() - Method in record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.MessageRef
Returns a hash code value for this object.
hashCode() - Method in record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.RoleRef
Returns a hash code value for this object.
hashCode() - Method in record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.UserRef
Returns a hash code value for this object.
hashCode() - Method in record class dev.sympho.modular_commands.utils.parse.StringAdapter
Returns a hash code value for this object.
hashCode() - Method in record class dev.sympho.modular_commands.utils.parse.TryParser.Failure
Returns a hash code value for this object.
hashCode() - Method in record class dev.sympho.modular_commands.utils.parse.TryParser.Success
Returns a hash code value for this object.
hasNext() - Method in interface dev.sympho.modular_commands.utils.SmartIterator
 
HttpUtils - Class in dev.sympho.modular_commands.utils
Utilities for working with HTTP requests.

I

id() - Method in interface dev.sympho.modular_commands.api.command.Command
The ID that uniquely identifies this command in the system.
id() - Method in record class dev.sympho.modular_commands.execute.Metrics.Tag.CommandId
Returns the value of the id record component.
id() - Method in record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.ChannelRef
Returns the value of the id record component.
id() - Method in record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.MessageRef
Returns the value of the id record component.
id() - Method in record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.RoleRef
Returns the value of the id record component.
id() - Method in record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.UserRef
Returns the value of the id record component.
Impl(InvocationHandler<? super InteractionCommandContext>, List<? extends ResultHandler<? super InteractionCommandContext>>) - Constructor for record class dev.sympho.modular_commands.api.command.handler.InteractionHandlers.Impl
Creates an instance of a Impl record class.
Impl(InvocationHandler<? super MessageCommandContext>, List<? extends ResultHandler<? super MessageCommandContext>>) - Constructor for record class dev.sympho.modular_commands.api.command.handler.MessageHandlers.Impl
Creates an instance of a Impl record class.
Impl(InvocationHandler<? super SlashCommandContext>, List<? extends ResultHandler<? super SlashCommandContext>>) - Constructor for record class dev.sympho.modular_commands.api.command.handler.SlashHandlers.Impl
Creates an instance of a Impl record class.
Impl(InvocationHandler<CommandContext>, List<? extends ResultHandler<CommandContext>>) - Constructor for record class dev.sympho.modular_commands.api.command.handler.TextHandlers.Impl
Creates an instance of a Impl record class.
IncompleteHandlingException - Exception in dev.sympho.modular_commands.api.exception
Exception type that indicates that the invocation handling of a command was completed but did not issue any result (i.e.
IncompleteHandlingException(List<? extends Command<?>>, Invocation) - Constructor for exception dev.sympho.modular_commands.api.exception.IncompleteHandlingException
Creates a new instance.
inheritSettings() - Method in interface dev.sympho.modular_commands.api.command.Command
Whether the command settings should be inherited from the parent command (ignoring the values provided by this command).
initArgs() - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl
 
initialize(ObservationRegistry) - Method in interface dev.sympho.modular_commands.execute.LazyContext
Partially initializes internal state, making the context minimally ready for handling to start.
initialize(ObservationRegistry) - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl
 
InputParser<P extends @NonNull Object,T extends @NonNull Object> - Interface in dev.sympho.modular_commands.api.command.parameter.parse
Parses received input arguments.
InstrumentedContext - Interface in dev.sympho.modular_commands.execute
A command context that is instrumented for use with metrics and tracing tooling.
integer() - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives plain integer values.
integer(List<ChoicesParser.Choice<Long>>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives plain integer values from within a set of choices.
integer(ChoicesParser.Choice<Long>...) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives plain integer values from within a set of choices.
integer(ParserFunction<Long, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given function to parse received values.
INTEGER - Static variable in class dev.sympho.modular_commands.utils.parse.ParseUtils
Parser for integers from strings.
INTEGER - Static variable in interface dev.sympho.modular_commands.utils.parse.RawParser
Parser for integers.
integerAbove(long) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives plain integer values, which must be at least the given value.
integerAbove(long, ParserFunction<Long, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given function to parse received values, which must be at least the given value.
integerBelow(long) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives plain integer values, which must be at most the given value.
integerBelow(long, ParserFunction<Long, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given function to parse received values, which must be at most the given value.
integerBetween(long, long) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives plain integer values, which must be between the given values.
integerBetween(long, long, ParserFunction<Long, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given function to parse received values, which must be between the given values.
IntegerParser<T extends @NonNull Object> - Interface in dev.sympho.modular_commands.api.command.parameter.parse
Parses integer-based input arguments.
integers() - Static method in class dev.sympho.modular_commands.utils.parse.ParseUtils
A parser that parses a list of integers.
interaction() - Static method in interface dev.sympho.modular_commands.api.command.Command
Creates a builder for an interaction command.
interaction(InvocationHandler<? super InteractionCommandContext>) - Static method in interface dev.sympho.modular_commands.api.command.handler.Handlers
Creates a handler set with the given handlers, with support only for interaction-based commands, and no result handlers.
interaction(InvocationHandler<? super InteractionCommandContext>, ResultHandler<? super InteractionCommandContext>...) - Static method in interface dev.sympho.modular_commands.api.command.handler.Handlers
Creates a handler set with the given handlers, with support for interaction-based commands.
interaction(InvocationHandler<? super InteractionCommandContext>, List<? extends ResultHandler<? super InteractionCommandContext>>) - Static method in interface dev.sympho.modular_commands.api.command.handler.Handlers
Creates a handler set with the given handlers, with support for interaction-based commands.
InteractionCommandContext - Interface in dev.sympho.modular_commands.api.command.context
The execution context of an command invoked through an interaction (application command).
InteractionHandlers - Interface in dev.sympho.modular_commands.api.command.handler
A set of handlers that support interaction-based invocations.
InteractionHandlers.Impl - Record Class in dev.sympho.modular_commands.api.command.handler
A record-based implementation.
InvalidArgumentException - Exception in dev.sympho.modular_commands.api.command.parameter.parse
Exception thrown when an argument cannot be parsed due to being invalid.
InvalidArgumentException(String) - Constructor for exception dev.sympho.modular_commands.api.command.parameter.parse.InvalidArgumentException
Constructs a new exception.
InvalidArgumentException(String, Throwable) - Constructor for exception dev.sympho.modular_commands.api.command.parameter.parse.InvalidArgumentException
Constructs a new exception.
InvalidChainException - Exception in dev.sympho.modular_commands.api.exception
Exception type that is triggered when a command chain being invoked is not valid due to an incompatiblity between commands in the chain.
InvalidChainException(Command<?>, Command<?>, String) - Constructor for exception dev.sympho.modular_commands.api.exception.InvalidChainException
Creates a new instance.
InvalidListException - Exception in dev.sympho.modular_commands.api.command.parameter.parse
Exception that indicates that some items in an argument list were invalid.
InvalidListException(List<? extends TryParser.Failure<?, ?>>) - Constructor for exception dev.sympho.modular_commands.api.command.parameter.parse.InvalidListException
Creates a new instance.
invocation() - Method in interface dev.sympho.modular_commands.api.command.Command
The invocation that executes this command.
invocation() - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext
Retrieves the invocation that triggered the command.
invocation() - Method in interface dev.sympho.modular_commands.api.command.handler.Handlers
The handler to use for executing the invocation.
invocation() - Method in record class dev.sympho.modular_commands.api.command.handler.InteractionHandlers.Impl
Returns the value of the invocation record component.
invocation() - Method in interface dev.sympho.modular_commands.api.command.handler.InteractionHandlers
 
invocation() - Method in record class dev.sympho.modular_commands.api.command.handler.MessageHandlers.Impl
Returns the value of the invocation record component.
invocation() - Method in interface dev.sympho.modular_commands.api.command.handler.MessageHandlers
 
invocation() - Method in record class dev.sympho.modular_commands.api.command.handler.SlashHandlers.Impl
Returns the value of the invocation record component.
invocation() - Method in interface dev.sympho.modular_commands.api.command.handler.SlashHandlers
 
invocation() - Method in record class dev.sympho.modular_commands.api.command.handler.TextHandlers.Impl
Returns the value of the invocation record component.
invocation() - Method in interface dev.sympho.modular_commands.api.command.handler.TextHandlers
 
invocation() - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl
 
Invocation - Record Class in dev.sympho.modular_commands.api.command
An invocation of a command.
Invocation(List<String>) - Constructor for record class dev.sympho.modular_commands.api.command.Invocation
Constructs an invocation determined by the given chain.
InvocationHandler<C extends @NonNull CommandContext> - Interface in dev.sympho.modular_commands.api.command.handler
A function that handles the execution of a command.
InvocationUtils - Class in dev.sympho.modular_commands.execute
Utility functions for handling invocations.
InvocationValidator<E extends Event> - Class in dev.sympho.modular_commands.execute
Validator that checks that a command's invocation is appropriate as per the command's defined parameters.
InvocationValidator() - Constructor for class dev.sympho.modular_commands.execute.InvocationValidator
 
invokeParent() - Method in interface dev.sympho.modular_commands.api.command.Command
Whether the parent command should be invoked before this command is invoked.
isHost(URL, String) - Static method in class dev.sympho.modular_commands.utils.parse.UrlParserUtils
Checks if the given URL has the given host.
isHost(URL, Collection<String>) - Static method in class dev.sympho.modular_commands.utils.parse.UrlParserUtils
Checks if the given URL has a certain host, which may be specified by any of the given aliases.
isHttp(URL) - Static method in class dev.sympho.modular_commands.utils.parse.UrlParserUtils
Checks if the given URL has a HTTP-based protocol (HTTP or HTTPS).
isHttps(URL) - Static method in class dev.sympho.modular_commands.utils.parse.UrlParserUtils
Checks if the given URL has HTTPS as the protocol.
item() - Method in record class dev.sympho.modular_commands.utils.parse.TryParser.Failure
 
item() - Method in interface dev.sympho.modular_commands.utils.parse.TryParser.Result
The parsed item, if parsed successfully.
item() - Method in record class dev.sympho.modular_commands.utils.parse.TryParser.Success
Returns the value of the item record component.
items(List<TryParser.Result<R, T>>) - Static method in interface dev.sympho.modular_commands.utils.parse.TryParser
Extracts the items in a result list that were successfully parsed.
iterate(String) - Method in interface dev.sympho.modular_commands.utils.StringSplitter.Async
 
iterate(String) - Method in interface dev.sympho.modular_commands.utils.StringSplitter
Creates a smart iterator that iterates over the components obtained by splitting the given raw string.
iterator() - Method in record class dev.sympho.modular_commands.api.command.Invocation
 

K

key() - Method in record class dev.sympho.modular_commands.execute.Metrics.Tag.CommandId
 
key() - Method in interface dev.sympho.modular_commands.execute.Metrics.Tag
Retrieves the tag key.
key() - Method in enum class dev.sympho.modular_commands.execute.Metrics.Tag.Type
 
kilo(int) - Static method in class dev.sympho.modular_commands.utils.SizeUtils
Makes a size in kilobytes.
kilo(long) - Static method in class dev.sympho.modular_commands.utils.SizeUtils
Makes a size in kilobytes.
KILO - Static variable in class dev.sympho.modular_commands.utils.SizeUtils
The value of the K prefix.

L

LazyContext - Interface in dev.sympho.modular_commands.execute
A command context whose values (particularly arguments) are lazy-loaded (that is, are not loaded until requested by LazyContext.initialize(ObservationRegistry) and LazyContext.load()).
list() - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a list parser with string items.
list(int, int) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a list parser with string items.
list(ParserFunction<String, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a list parser that uses the given function to parse items.
list(ParserFunction<String, T>, int, int) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a list parser that uses the given function to parse items.
ListIterator(List<E>) - Constructor for class dev.sympho.modular_commands.utils.SmartIterator.ListIterator
Creates a new instance.
ListParser<T extends @NonNull Object> - Interface in dev.sympho.modular_commands.api.command.parameter.parse
A parser that extracts lists of objects by splitting a string argument and parsing each item.
load() - Method in interface dev.sympho.modular_commands.execute.LazyContext
Loads remaining internal state, making the context fully ready for use.
load() - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl
 
logger - Variable in class dev.sympho.modular_commands.execute.CommandExecutor
The logger.

M

makeContext(MessageCreateEvent, Command<? extends MessageHandlers>, Invocation, StringSplitter.Async.Iterator) - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutor
 
makeContext(E, Command<? extends H>, Invocation, I) - Method in class dev.sympho.modular_commands.execute.BaseCommandExecutor
Creates a command context from a parsed invocation.
makeRef(CommandContext, Snowflake) - Method in class dev.sympho.modular_commands.utils.parse.entity.ChannelRefMentionParser
 
makeRef(CommandContext, Snowflake) - Method in class dev.sympho.modular_commands.utils.parse.entity.ChannelRefParser
 
makeRef(CommandContext, Snowflake) - Method in class dev.sympho.modular_commands.utils.parse.entity.EntityRefMentionParser
Creates the reference.
makeRef(CommandContext, Snowflake) - Method in class dev.sympho.modular_commands.utils.parse.entity.EntityRefParser
Creates the reference.
makeRef(CommandContext, Snowflake) - Method in class dev.sympho.modular_commands.utils.parse.entity.MessageRefParser
 
makeRef(CommandContext, Snowflake) - Method in class dev.sympho.modular_commands.utils.parse.entity.RoleRefMentionParser
 
makeRef(CommandContext, Snowflake) - Method in class dev.sympho.modular_commands.utils.parse.entity.RoleRefParser
 
makeRef(CommandContext, Snowflake) - Method in class dev.sympho.modular_commands.utils.parse.entity.UserRefMentionParser
 
makeRef(CommandContext, Snowflake) - Method in class dev.sympho.modular_commands.utils.parse.entity.UserRefParser
 
MASKED_URL_PATTERN - Static variable in interface dev.sympho.modular_commands.utils.parse.UrlParser
Pattern that matches a masked link.
MAX_CHOICES - Static variable in interface dev.sympho.modular_commands.api.command.parameter.parse.ChoicesParser
The maximum number of choices allowed.
MAX_LENGTH - Static variable in interface dev.sympho.modular_commands.api.command.parameter.parse.StringParser
The maximum length possible (in the Discord API for application commands).
maximum() - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.NumberParser
The maximum value allowed (inclusive).
maxItems() - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.ListParser
The maximum amount of items allowed (inclusive).
maxLength() - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.StringParser
The maximum length allowed (inclusive).
maxSize() - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.AttachmentDataParser
Retrieves the maximum size (in bytes) that the attachment may have.
mega(int) - Static method in class dev.sympho.modular_commands.utils.SizeUtils
Makes a size in megabytes.
mega(long) - Static method in class dev.sympho.modular_commands.utils.SizeUtils
Makes a size in megabytes.
MEGA - Static variable in class dev.sympho.modular_commands.utils.SizeUtils
The value of the M prefix.
member() - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext
 
member() - Method in interface dev.sympho.modular_commands.api.command.context.InteractionCommandContext
 
member() - Static method in class dev.sympho.modular_commands.utils.parse.ParseUtils
Creates a parser that receives members of the guild where the command is called in.
member(ParserFunction<Member, T>) - Static method in class dev.sympho.modular_commands.utils.parse.ParseUtils
Creates a parser that parses from members of the guild where the command is called in.
member(Snowflake) - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext
 
member(Snowflake) - Method in interface dev.sympho.modular_commands.api.command.context.InteractionCommandContext
 
member(Snowflake) - Static method in class dev.sympho.modular_commands.utils.parse.ParseUtils
Creates a parser that receives members of the given guild.
member(Snowflake, ParserFunction<Member, T>) - Static method in class dev.sympho.modular_commands.utils.parse.ParseUtils
Creates a parser that parses from members of the given guild.
merge(Collection<CommandGroup>) - Static method in interface dev.sympho.modular_commands.api.CommandGroup
Merges multiple command groups into one.
message() - Static method in interface dev.sympho.modular_commands.api.command.Command
Creates a builder for a message-only command.
message() - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives raw message values.
message() - Method in interface dev.sympho.modular_commands.api.command.result.CommandError
Retrieves the error message.
message() - Method in interface dev.sympho.modular_commands.api.command.result.CommandErrorException
Retrieves the error message.
message() - Method in record class dev.sympho.modular_commands.api.command.result.CommandFailureArgumentExtra
 
message() - Method in record class dev.sympho.modular_commands.api.command.result.CommandFailureArgumentInvalid
 
message() - Method in record class dev.sympho.modular_commands.api.command.result.CommandFailureArgumentMissing
 
message() - Method in interface dev.sympho.modular_commands.api.command.result.CommandFailureMessage
Retrieves the message to the user.
message() - Method in interface dev.sympho.modular_commands.api.command.result.CommandSuccessAck
The message to send if the command was not triggered by a message.
message() - Method in interface dev.sympho.modular_commands.api.command.result.CommandSuccessMessage
Retrieves the message to the user.
message(CommandContext) - Static method in interface dev.sympho.modular_commands.utils.parse.RawParser
Creates a parser for messages with the given context.
message(InvocationHandler<? super MessageCommandContext>) - Static method in interface dev.sympho.modular_commands.api.command.handler.Handlers
Creates a handler set with the given handlers, with support only for message-based commands, and no result handlers.
message(InvocationHandler<? super MessageCommandContext>, ResultHandler<? super MessageCommandContext>...) - Static method in interface dev.sympho.modular_commands.api.command.handler.Handlers
Creates a handler set with the given handlers, with support only for message-based commands.
message(InvocationHandler<? super MessageCommandContext>, List<? extends ResultHandler<? super MessageCommandContext>>) - Static method in interface dev.sympho.modular_commands.api.command.handler.Handlers
Creates a handler set with the given handlers, with support only for message-based commands.
message(ParserFunction<Message, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given function to parse received values.
MESSAGE - Enum constant in enum class dev.sympho.modular_commands.api.command.parameter.parse.SnowflakeParser.Type
A message ID.
MESSAGE - Enum constant in enum class dev.sympho.modular_commands.execute.Metrics.Tag.Type
A message-based command.
MESSAGE - Static variable in class dev.sympho.modular_commands.utils.parse.ParseUtils
Parser for messages from strings.
MESSAGE_ID - Static variable in class dev.sympho.modular_commands.utils.parse.ParseUtils
Parser for message IDs from strings.
MESSAGE_REF - Static variable in class dev.sympho.modular_commands.utils.parse.ParseUtils
Parser for message references from strings.
MessageArgumentParser<T extends @NonNull Object> - Interface in dev.sympho.modular_commands.api.command.parameter.parse
Parses Discord messages.
MessageCommandContext - Interface in dev.sympho.modular_commands.api.command.context
The execution context of an command invoked through a message.
MessageCommandExecutor - Class in dev.sympho.modular_commands.execute
Executor that receives and handles commands through text messages.
MessageCommandExecutor(GatewayDiscordClient, Registry, Optional<AccessManager>, Optional<MeterRegistry>, Optional<ObservationRegistry>, PrefixProvider, Optional<AliasProvider>) - Constructor for class dev.sympho.modular_commands.execute.MessageCommandExecutor
Creates a new instance.
MessageCommandExecutorBuilder - Class in dev.sympho.modular_commands.execute
MessageCommandExecutorBuilder collects parameters and invokes the static factory method: new dev.sympho.modular_commands.execute.MessageCommandExecutor(..).
MessageCommandExecutorBuilder() - Constructor for class dev.sympho.modular_commands.execute.MessageCommandExecutorBuilder
Creates a MessageCommandExecutorBuilder factory builder.
MessageContextImpl - Class in dev.sympho.modular_commands.impl.context
Context object for invocations performed through text messages.
MessageContextImpl(MessageCreateEvent, Invocation, Command<?>, StringSplitter.Async.Iterator, AccessManager, ReplyManager) - Constructor for class dev.sympho.modular_commands.impl.context.MessageContextImpl
Initializes a new context.
MessageHandlers - Interface in dev.sympho.modular_commands.api.command.handler
A set of handlers that support message-based invocations.
MessageHandlers.Impl - Record Class in dev.sympho.modular_commands.api.command.handler
A record-based implementation.
messageId(CommandContext) - Static method in interface dev.sympho.modular_commands.utils.parse.RawParser
Creates a parser for message IDs with the given context.
MessageParser - Class in dev.sympho.modular_commands.utils.parse.entity
A parser that extracts a message from a string.
MessageParser() - Constructor for class dev.sympho.modular_commands.utils.parse.entity.MessageParser
Creates a new instance.
MessageRef(CommandContext, Snowflake) - Constructor for record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.MessageRef
Creates a new instance when only the ID is specified.
MessageRef(Snowflake, Snowflake) - Constructor for record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.MessageRef
Creates an instance of a MessageRef record class.
MessageRefParser - Class in dev.sympho.modular_commands.utils.parse.entity
A parser that extracts a message reference from a string.
MessageRefParser() - Constructor for class dev.sympho.modular_commands.utils.parse.entity.MessageRefParser
Creates a new instance.
MessageRefUrlParser - Class in dev.sympho.modular_commands.utils.parse.entity
A parser for message URLs.
MessageRefUrlParser() - Constructor for class dev.sympho.modular_commands.utils.parse.entity.MessageRefUrlParser
Creates a new instance.
messages() - Static method in class dev.sympho.modular_commands.utils.parse.ParseUtils
A parser that parses a list of messages.
MessageUrlParser - Class in dev.sympho.modular_commands.utils.parse.entity
A parser for message URLs.
MessageUrlParser() - Constructor for class dev.sympho.modular_commands.utils.parse.entity.MessageUrlParser
Creates a new instance.
meters - Variable in class dev.sympho.modular_commands.execute.BaseCommandExecutor
The meter registry to use.
meters(MeterRegistry) - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutorBuilder
Initializes the optional value meters to meters.
meters(Optional<? extends MeterRegistry>) - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutorBuilder
Initializes the optional value meters to meters.
METRIC_NAME_PREFIX - Static variable in class dev.sympho.modular_commands.impl.context.MessageContextImpl
The prefix for metrics in this class.
METRIC_NAME_PREFIX_ARGUMENT - Static variable in class dev.sympho.modular_commands.impl.context.MessageContextImpl
The prefix for argument parsing metrics.
Metrics - Class in dev.sympho.modular_commands.execute
Configuration for metrics instrumentation.
Metrics.Tag - Interface in dev.sympho.modular_commands.execute
Tags used in metrics.
Metrics.Tag.CommandId - Record Class in dev.sympho.modular_commands.execute
The tag that indicates the command ID.
Metrics.Tag.Type - Enum Class in dev.sympho.modular_commands.execute
The tag that indicates the command type.
minimum() - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.NumberParser
The minimum value allowed (inclusive).
minItems() - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.ListParser
The minimum amount of items allowed (inclusive).
minLength() - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.StringParser
The minimum length allowed (inclusive).

N

name() - Method in interface dev.sympho.modular_commands.api.command.Command
The name of the command.
name() - Method in interface dev.sympho.modular_commands.api.command.parameter.Parameter
The name of the parameter.
name() - Method in record class dev.sympho.modular_commands.api.command.parameter.parse.ChoicesParser.Choice
Returns the value of the name record component.
name(String...) - Static method in class dev.sympho.modular_commands.execute.Metrics
Creates the name for a metric or tag from a sequence of components.
NAME_REGEX - Static variable in interface dev.sympho.modular_commands.api.command.Command
Pattern for valid slash command names in the Discord API.
NAME_REGEX - Static variable in interface dev.sympho.modular_commands.api.command.parameter.Parameter
Pattern for valid parameter names in the Discord API.
next() - Method in class dev.sympho.modular_commands.utils.SmartIterator.ListIterator
 
next() - Method in class dev.sympho.modular_commands.utils.SmartIterator.Wrapper
 
NO_MORE_ELEMENTS_ERROR - Static variable in interface dev.sympho.modular_commands.utils.SmartIterator
Exception message for when there are no more elements.
none() - Static method in interface dev.sympho.modular_commands.execute.AliasProvider
Creates an alias provider with no aliases.
notInitializedError() - Static method in interface dev.sympho.modular_commands.execute.LazyContext
Creates an error that indicates that the context was not initialized yet.
notLoadedError() - Static method in interface dev.sympho.modular_commands.execute.LazyContext
Creates an error that indicates that the context was not loaded yet.
nsfw() - Method in interface dev.sympho.modular_commands.api.command.Command
Whether this command can only be invoked in a NSFW channel.
nullValue(R) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that returns an empty result for the given value, otherwise resulting in the raw value.
nullValue(R, ParserFunction<R, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that returns an empty result for the given value, otherwise deferring to the given parser.
nullValues(Collection<? extends R>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that returns an empty result for the given values, otherwise resulting in the raw value.
nullValues(Collection<? extends R>, ParserFunction<R, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that returns an empty result for the given values, otherwise deferring to the given parser.
number() - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives plain floating-point values.
number(List<ChoicesParser.Choice<Double>>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives plain floating-point values from within a set of choices.
number(ChoicesParser.Choice<Double>...) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives plain floating-point values from within a set of choices.
number(ParserFunction<Double, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given function to parse received values.
numberAbove(double) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives plain floating-point values, which must be at least the given value.
numberAbove(double, ParserFunction<Double, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given function to parse received values, which must be at least the given value.
numberBelow(double) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives plain floating-point values, which must be at most the given value.
numberBelow(double, ParserFunction<Double, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given function to parse received values, which must be at most the given value.
numberBetween(double, double) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives plain floating-point values, which must be between the given values.
numberBetween(double, double, ParserFunction<Double, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given function to parse received values, which must be between the given values.
numberChoice(List<Map.Entry<ChoicesParser.Choice<Double>, T>>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives a value from within a set of choices.
numberChoice(Map.Entry<ChoicesParser.Choice<Double>, T>...) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives a value from within a set of choices.
NumberParser<P extends @NonNull Number & Comparable<P>,T extends @NonNull Object> - Interface in dev.sympho.modular_commands.api.command.parameter.parse
Parses number-based input arguments.

O

observations - Variable in class dev.sympho.modular_commands.execute.BaseCommandExecutor
The observation registry to use.
observations(ObservationRegistry) - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutorBuilder
Initializes the optional value observations to observations.
observations(Optional<? extends ObservationRegistry>) - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutorBuilder
Initializes the optional value observations to observations.
of(Command<?>...) - Static method in interface dev.sympho.modular_commands.api.CommandGroup
Creates a command group from the given commands.
of(ParserFunction<R, T>) - Static method in interface dev.sympho.modular_commands.utils.parse.TryParser
Creates a try-parser wrapper the given parser.
of(String...) - Static method in record class dev.sympho.modular_commands.api.command.Invocation
Constructs an invocation from the given sequence of command names.
of(String, P) - Static method in record class dev.sympho.modular_commands.api.command.parameter.parse.ChoicesParser.Choice
Creates a new choice.
of(String, P, V) - Static method in record class dev.sympho.modular_commands.api.command.parameter.parse.ChoicesParser.Choice
Creates a new choice mapping.
of(Collection<? extends Command<?>>) - Static method in interface dev.sympho.modular_commands.api.CommandGroup
Creates a command group from the given commands.
of(Collection<? extends Map.Entry<Invocation, Invocation>>) - Static method in interface dev.sympho.modular_commands.execute.AliasProvider
Creates an alias provider with the given aliases.
of(List<String>) - Static method in record class dev.sympho.modular_commands.api.command.Invocation
Constructs an invocation from the given sequence of command names.
of(Map.Entry<Invocation, Invocation>...) - Static method in interface dev.sympho.modular_commands.execute.AliasProvider
Creates an alias provider with the given aliases.
of(Map<Invocation, Invocation>) - Static method in interface dev.sympho.modular_commands.execute.AliasProvider
Creates an alias provider with the given aliases.
ok() - Static method in class dev.sympho.modular_commands.api.command.result.Results
Generates a result indicating the command executed successfully with no further context.
OK - Static variable in class dev.sympho.modular_commands.api.command.result.Results
Result indicating the command executed successfully with no further context.
okMono() - Static method in class dev.sympho.modular_commands.api.command.result.Results
Generates a result indicating the command executed successfully with no further context.
okR() - Static method in class dev.sympho.modular_commands.api.command.result.Results
Alias for Results.ok() that casts to a plain Result to avoid Generics issues.
OptionalUtils - Class in dev.sympho.modular_commands.utils
Tools for dealing with OptionalChecker, similar to NullnessUtils.

P

parameter() - Method in record class dev.sympho.modular_commands.api.command.result.CommandFailureArgumentInvalid
Returns the value of the parameter record component.
parameter() - Method in record class dev.sympho.modular_commands.api.command.result.CommandFailureArgumentMissing
Returns the value of the parameter record component.
Parameter<T extends @NonNull Object> - Interface in dev.sympho.modular_commands.api.command.parameter
Specification for a parameter received for a command.
Parameter.Builder<T extends @NonNull Object> - Class in dev.sympho.modular_commands.api.command.parameter
The default builder.
parameters() - Method in interface dev.sympho.modular_commands.api.command.Command
The command parameters, in the order that they should be provided by the user.
ParameterUtils - Class in dev.sympho.modular_commands.utils
Utility functions for Parameter interfaces.
parent() - Method in interface dev.sympho.modular_commands.api.command.Command
The parent of the command.
parent() - Method in record class dev.sympho.modular_commands.api.command.Invocation
Determines the parent invocation of this chain.
parent(Command<?>) - Method in class dev.sympho.modular_commands.api.command.Command.Builder
Initializes the value for the parent attribute.
parse(CommandContext, Attachment, ByteBufMono) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.AttachmentParserStages.Parser
Parses the response from fetching the attachment file into the corresponding value.
parse(CommandContext, Attachment, ByteBufMono) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.TextFileParser
 
parse(CommandContext, String) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.TextFileParser
Parses the content of the attachment file.
parse(CommandContext, String) - Method in class dev.sympho.modular_commands.utils.parse.entity.EntityMentionParser
 
parse(CommandContext, String) - Method in class dev.sympho.modular_commands.utils.parse.entity.EntityParser
 
parse(CommandContext, String) - Method in class dev.sympho.modular_commands.utils.parse.entity.EntityRefMentionParser
 
parse(CommandContext, String) - Method in class dev.sympho.modular_commands.utils.parse.entity.EntityRefParser
 
parse(CommandContext, String) - Method in record class dev.sympho.modular_commands.utils.parse.StringAdapter
 
parse(CommandContext, String) - Method in interface dev.sympho.modular_commands.utils.parse.UrlParser
 
parse(CommandContext, URL) - Method in class dev.sympho.modular_commands.utils.parse.entity.EntityRefUrlParser
 
parse(CommandContext, URL) - Method in class dev.sympho.modular_commands.utils.parse.entity.EntityUrlParser
 
parse(CommandContext, URL) - Method in interface dev.sympho.modular_commands.utils.parse.FunctorUrlParser
 
parse(CommandContext, URL) - Method in class dev.sympho.modular_commands.utils.parse.UrlParser.ChoiceBase
 
parse(CommandContext, URL) - Method in interface dev.sympho.modular_commands.utils.parse.UrlParser
Parses the given URL.
parse(CommandContext, URL) - Method in class dev.sympho.modular_commands.utils.parse.UrlParser.PostParser
 
parse(CommandContext, R) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.ArgumentParser
 
parse(CommandContext, R) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.ParserFunction
Parses the given raw argument from the user into the corresponding value.
parse(CommandContext, R) - Method in class dev.sympho.modular_commands.api.command.parameter.parse.ParserFunction.PostParser
 
parse(CommandContext, R) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.Parsers.Functor
 
parse(CommandContext, R) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.Parsers.Simple
 
parse(CommandContext, R) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.Parsers.Synchronous
 
parse(CommandContext, R) - Method in interface dev.sympho.modular_commands.utils.parse.TryParser
 
parse(MessageCreateEvent) - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutor
 
parse(E) - Method in class dev.sympho.modular_commands.execute.BaseCommandExecutor
Parses the raw args from the event.
parse(String) - Method in class dev.sympho.modular_commands.utils.parse.entity.EntityRefUrlParser
Parses the given string as a reference URL.
parse(String) - Method in interface dev.sympho.modular_commands.utils.parse.RawParser
Parses the given string into a raw value.
parse(URL) - Method in class dev.sympho.modular_commands.utils.parse.entity.EntityRefUrlParser
Parses the given URL into the corresponding reference.
parse(URL) - Method in class dev.sympho.modular_commands.utils.parse.FunctorUrlParser.ChoiceBase
 
parse(URL) - Method in interface dev.sympho.modular_commands.utils.parse.FunctorUrlParser
Parses the given URL.
parse(URL) - Method in class dev.sympho.modular_commands.utils.parse.FunctorUrlParser.PostParser
 
parse(R) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.Parsers.Functor
Parses the given raw argument from the user into the corresponding value.
parseArgument(CommandContext, Attachment) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.AttachmentDataParser
 
parseArgument(CommandContext, String) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.ListParser
 
parseArgument(CommandContext, R) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.ArgumentParser
Parses the given raw argument from the user into the corresponding value.
parseId(String) - Method in class dev.sympho.modular_commands.utils.parse.entity.EntityRefMentionParser
Parses the given string.
parseInvocation(Registry, SmartIterator<String>, Class<H>) - Static method in class dev.sympho.modular_commands.execute.InvocationUtils
Extracts an invocation from a sequence of args by performing lookups on the given registry, while building the corresponding execution chain.
parseItem(CommandContext, String) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.ListParser
Parses an individual item in the list.
parseNow(CommandContext, R) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.Parsers.Synchronous
Parses the given raw argument from the user into the corresponding value.
parseNow(R) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.Parsers.Simple
Parses the given raw argument from the user into the corresponding value.
parsePath(String) - Method in class dev.sympho.modular_commands.utils.parse.entity.ChannelRefUrlParser
 
parsePath(String) - Method in class dev.sympho.modular_commands.utils.parse.entity.EntityRefUrlParser
Parses the URL path.
parsePath(String) - Method in class dev.sympho.modular_commands.utils.parse.entity.MessageRefUrlParser
 
parser - Variable in class dev.sympho.modular_commands.api.command.parameter.parse.ParserFunction.PostParser
The first parser to apply.
parser() - Method in interface dev.sympho.modular_commands.api.command.parameter.Parameter
The parser to use to process received arguments.
parser() - Method in interface dev.sympho.modular_commands.utils.parse.TryParser
The parser to delegate to.
parseRef(CommandContext, String) - Method in class dev.sympho.modular_commands.utils.parse.entity.EntityRefMentionParser
Parses the given string.
parseRef(CommandContext, String) - Method in class dev.sympho.modular_commands.utils.parse.entity.EntityRefParser
Parses the given string.
parseRef(CommandContext, String) - Method in class dev.sympho.modular_commands.utils.parse.entity.RoleRefMentionParser
 
parseRef(CommandContext, String) - Method in class dev.sympho.modular_commands.utils.parse.entity.RoleRefParser
 
ParserFunction<R extends @NonNull Object,T extends @NonNull Object> - Interface in dev.sympho.modular_commands.api.command.parameter.parse
A function that parses a value within the context of an execution.
ParserFunction.PostParser<R extends @NonNull Object,I extends @NonNull Object,T extends @NonNull Object,P1 extends @NonNull ParserFunction<R,I>,P2 extends @NonNull ParserFunction<I,T>> - Class in dev.sympho.modular_commands.api.command.parameter.parse
A composed parser that first applies this parser to one parser, and then applies the results to a second parser.
Parsers - Class in dev.sympho.modular_commands.api.command.parameter.parse
Convenience functions for defining argument parsers.
Parsers.Functor<R extends @NonNull Object,T extends @NonNull Object> - Interface in dev.sympho.modular_commands.api.command.parameter.parse
A parser that does not depend on the invocation context.
Parsers.Simple<R extends @NonNull Object,T extends @NonNull Object> - Interface in dev.sympho.modular_commands.api.command.parameter.parse
A parser that executes synchronously and does not depend on the invocation context.
Parsers.Synchronous<R extends @NonNull Object,T extends @NonNull Object> - Interface in dev.sympho.modular_commands.api.command.parameter.parse
A parser that executes synchronously.
parseUrl(String, String) - Static method in interface dev.sympho.modular_commands.utils.parse.UrlParser
Attempts to parse a string as a URL.
parseUrl(String, Collection<String>) - Static method in interface dev.sympho.modular_commands.utils.parse.UrlParser
Attempts to parse a string as a URL.
ParseUtils - Class in dev.sympho.modular_commands.utils.parse
Convenience functions for common parsers.
peek() - Method in interface dev.sympho.modular_commands.utils.SmartIterator
Retrives the element that will be returned by the next call to Iterator.next(), without advancing the iterator.
peek() - Method in class dev.sympho.modular_commands.utils.SmartIterator.Wrapper
 
postParser - Variable in class dev.sympho.modular_commands.api.command.parameter.parse.ParserFunction.PostParser
The second parser to apply.
PostParser(P1, P2) - Constructor for class dev.sympho.modular_commands.api.command.parameter.parse.ParserFunction.PostParser
Creates a new instance.
PostParser(P1, P2) - Constructor for class dev.sympho.modular_commands.utils.parse.FunctorUrlParser.PostParser
Creates a new instance.
PostParser(P1, P2) - Constructor for class dev.sympho.modular_commands.utils.parse.UrlParser.PostParser
Creates a new instance.
prefix() - Method in record class dev.sympho.modular_commands.execute.StaticPrefix
Returns the value of the prefix record component.
PREFIX - Static variable in class dev.sympho.modular_commands.execute.Metrics
The prefix for all metric and tag names.
prefixes() - Method in record class dev.sympho.modular_commands.execute.GuildPrefix
Returns the value of the prefixes record component.
prefixMatches(String) - Method in class dev.sympho.modular_commands.utils.parse.entity.ChannelRefMentionParser
 
prefixMatches(String) - Method in class dev.sympho.modular_commands.utils.parse.entity.EntityRefMentionParser
Determines if the mention prefix matches the expected type.
prefixMatches(String) - Method in class dev.sympho.modular_commands.utils.parse.entity.RoleRefMentionParser
 
prefixMatches(String) - Method in class dev.sympho.modular_commands.utils.parse.entity.UserRefMentionParser
 
prefixProvider(PrefixProvider) - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutorBuilder
Initializes the value for the prefixProvider attribute.
PrefixProvider - Interface in dev.sympho.modular_commands.execute
Object that provides the prefix to consider for commands during event handling.
preprocess(String) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.ListParser
Applies pre-processing steps to the received argument before splitting, such as cleaning the string.
PROTOCOL_HTTP - Static variable in class dev.sympho.modular_commands.utils.parse.UrlParserUtils
The HTTP protocol.
PROTOCOL_HTTP_COMPATIBLE - Static variable in class dev.sympho.modular_commands.utils.parse.UrlParserUtils
HTTP-based protocols.
PROTOCOL_HTTPS - Static variable in class dev.sympho.modular_commands.utils.parse.UrlParserUtils
The HTTPS protocol.

R

raw() - Method in record class dev.sympho.modular_commands.utils.parse.TryParser.Failure
Returns the value of the raw record component.
raw() - Method in interface dev.sympho.modular_commands.utils.parse.TryParser.Result
The raw value used in parsing.
raw() - Method in record class dev.sympho.modular_commands.utils.parse.TryParser.Success
Returns the value of the raw record component.
raw(CommandContext, R) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Returns the raw value received.
rawArgMap() - Method in interface dev.sympho.modular_commands.api.command.context.MessageCommandContext
Retrieves the raw arguments received, keyed by the corresponding parameter name.
rawArgMap() - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl
 
rawArgs() - Method in interface dev.sympho.modular_commands.api.command.context.MessageCommandContext
Retrieves the raw arguments received before parsing, in the order that they were received.
rawArgs() - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl
 
rawParser() - Method in record class dev.sympho.modular_commands.utils.parse.StringAdapter
Returns the value of the rawParser record component.
RawParser<R extends @NonNull Object> - Interface in dev.sympho.modular_commands.utils.parse
Parser function that converts a string into one of the supported raw types.
react() - Method in interface dev.sympho.modular_commands.api.command.result.CommandSuccessAck
The react to use if the command was triggered by a message.
registerCommand(Command<?>) - Method in interface dev.sympho.modular_commands.api.registry.Registry
Registers a command into this registry.
registerCommand(Command<?>) - Method in class dev.sympho.modular_commands.impl.registry.SimpleRegistry
 
registerCommands(Command<?>...) - Method in interface dev.sympho.modular_commands.api.registry.Registry
Registers the given commands into this registry.
registerCommands(CommandGroup) - Method in interface dev.sympho.modular_commands.api.registry.Registry
Registers the given commands into this registry.
registerCommands(Collection<? extends Command<?>>) - Method in interface dev.sympho.modular_commands.api.registry.Registry
Registers the given commands into this registry.
Registries - Class in dev.sympho.modular_commands.utils
Provides instances of default registry implementations.
registry - Variable in class dev.sympho.modular_commands.execute.BaseCommandExecutor
The registry to use to look up commands.
registry(Registry) - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutorBuilder
Initializes the value for the registry attribute.
Registry - Interface in dev.sympho.modular_commands.api.registry
A registry that stores commands that may be invoked by users.
remainder() - Method in interface dev.sympho.modular_commands.utils.StringSplitter.Async.Iterator
Retrieves the remainder of the string that has not been parsed yet.
remaining() - Method in class dev.sympho.modular_commands.utils.SmartIterator.ListIterator
Returns a list view over the portion of the list that has not been iterated over yet.
removeCommand(String) - Method in interface dev.sympho.modular_commands.api.registry.Registry
Removes a command from this registry that was registered with the given ID.
removeCommand(String) - Method in class dev.sympho.modular_commands.impl.registry.SimpleRegistry
 
repliesDefaultPrivate() - Method in interface dev.sympho.modular_commands.api.command.Command
Whether the replies sent by this command should be private by default (i.e.
requireArgument(Parameter<? extends T>) - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext
Retrieves one of the arguments to the command expecting that it is non-null, i.e.
requireArgument(Parameter<? extends T>, Class<T>) - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext
Retrieves one of the arguments to the command expecting that it is non-null, i.e.
requireArgument(String, Class<T>) - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext
Retrieves one of the arguments to the command expecting that it is non-null, i.e.
requireContext(String, Class<? extends T>) - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext
Retrieves a non-null context object set by CommandContext.setContext(String, Object, boolean).
required() - Method in interface dev.sympho.modular_commands.api.command.parameter.Parameter
Whether the parameter must be provided to invoke the command.
required() - Method in record class dev.sympho.modular_commands.api.command.result.UserNotAllowed
Returns the value of the required record component.
requiredGroup() - Method in interface dev.sympho.modular_commands.api.command.Command
The group that a user must have access for in order to invoke this command.
requireParentGroups() - Method in interface dev.sympho.modular_commands.api.command.Command
Whether a user invoking this command must also have access to the groups necessary to invoke its parent command(s).
result() - Method in interface dev.sympho.modular_commands.api.command.handler.Handlers
The handlers to use to handle the result (in the order given).
result() - Method in record class dev.sympho.modular_commands.api.command.handler.InteractionHandlers.Impl
Returns the value of the result record component.
result() - Method in interface dev.sympho.modular_commands.api.command.handler.InteractionHandlers
 
result() - Method in record class dev.sympho.modular_commands.api.command.handler.MessageHandlers.Impl
Returns the value of the result record component.
result() - Method in interface dev.sympho.modular_commands.api.command.handler.MessageHandlers
 
result() - Method in record class dev.sympho.modular_commands.api.command.handler.SlashHandlers.Impl
Returns the value of the result record component.
result() - Method in interface dev.sympho.modular_commands.api.command.handler.SlashHandlers
 
result() - Method in record class dev.sympho.modular_commands.api.command.handler.TextHandlers.Impl
Returns the value of the result record component.
result() - Method in interface dev.sympho.modular_commands.api.command.handler.TextHandlers
 
ResultException - Exception in dev.sympho.modular_commands.api.exception
Exception that indicates that command execution finished.
ResultException(CommandResult) - Constructor for exception dev.sympho.modular_commands.api.exception.ResultException
Creates a new instance.
ResultHandler<C extends @NonNull CommandContext> - Interface in dev.sympho.modular_commands.api.command.handler
A function that handles the result of a command.
Results - Class in dev.sympho.modular_commands.api.command.result
Utilities for generating results from handlers.
role() - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives raw role values.
role(CommandContext) - Static method in interface dev.sympho.modular_commands.utils.parse.RawParser
Creates a parser for roles with the given context.
role(ParserFunction<Role, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given function to parse received values.
ROLE - Enum constant in enum class dev.sympho.modular_commands.api.command.parameter.parse.SnowflakeParser.Type
A role ID.
ROLE - Static variable in class dev.sympho.modular_commands.utils.parse.ParseUtils
Parser for roles from strings.
ROLE_ID - Static variable in class dev.sympho.modular_commands.utils.parse.ParseUtils
Parser for role IDs from strings.
ROLE_REF - Static variable in class dev.sympho.modular_commands.utils.parse.ParseUtils
Parser for role references from strings.
RoleArgumentParser<T extends @NonNull Object> - Interface in dev.sympho.modular_commands.api.command.parameter.parse
Parses Discord roles.
roleId() - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives role IDs.
roleId(CommandContext) - Static method in interface dev.sympho.modular_commands.utils.parse.RawParser
Creates a parser for role IDs with the given context.
roleId(ParserFunction<Snowflake, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given function to parse received values.
RoleMentionParser - Class in dev.sympho.modular_commands.utils.parse.entity
A parser for role mentions.
RoleMentionParser() - Constructor for class dev.sympho.modular_commands.utils.parse.entity.RoleMentionParser
Creates a new instance.
RoleParser - Class in dev.sympho.modular_commands.utils.parse.entity
A parser that extracts a role from a string.
RoleParser() - Constructor for class dev.sympho.modular_commands.utils.parse.entity.RoleParser
Creates a new instance.
RoleRef(CommandContext, Snowflake) - Constructor for record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.RoleRef
Creates a new instance when only the ID is specified.
RoleRef(Snowflake, Snowflake) - Constructor for record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.RoleRef
Creates an instance of a RoleRef record class.
RoleRefMentionParser - Class in dev.sympho.modular_commands.utils.parse.entity
A parser for user mentions to references.
RoleRefMentionParser() - Constructor for class dev.sympho.modular_commands.utils.parse.entity.RoleRefMentionParser
Creates a new instance.
RoleRefParser - Class in dev.sympho.modular_commands.utils.parse.entity
A parser that extracts a role reference from a string.
RoleRefParser() - Constructor for class dev.sympho.modular_commands.utils.parse.entity.RoleRefParser
Creates a new instance.
roles() - Static method in class dev.sympho.modular_commands.utils.parse.ParseUtils
A parser that parses a list of roles.

S

scope() - Method in interface dev.sympho.modular_commands.api.command.Command
The scope that the command is defined in.
set(ResultHandler<CommandContext>) - Static method in class dev.sympho.modular_commands.execute.BaseHandler
Sets the base handler.
setClientGetter(AttachmentDataParser.Resources.HttpClientRetriever) - Method in class dev.sympho.modular_commands.api.command.parameter.parse.AttachmentDataParser.Resources
Sets the given function to be used to obtain an HTTP client for fetching attachment data unless overriden by the parser.
setClientGetter(Supplier<? extends HttpClient>) - Method in class dev.sympho.modular_commands.api.command.parameter.parse.AttachmentDataParser.Resources
Sets the given supplier to be used to obtain an HTTP client for fetching attachment data unless overriden by the parser.
setClientGetter(HttpClient) - Method in class dev.sympho.modular_commands.api.command.parameter.parse.AttachmentDataParser.Resources
Sets the given HTTP client to be used for fetching attachment data unless overriden by the parser.
setContext(String, Object) - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext
Unconditionally places a context object for subsequent handlers.
setContext(String, Object, boolean) - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext
Places a context object for subsequent handlers, optionally replacing any existing values under the same key.
setContext(String, Object, boolean) - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl
 
setPrefix(Snowflake, String) - Method in record class dev.sympho.modular_commands.execute.GuildPrefix
Sets a prefix override for a guild.
Shell() - Constructor for class dev.sympho.modular_commands.utils.StringSplitter.Shell
Creates a new instance.
simple(Parsers.Simple<R, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Uses a parser that executes synchronously and does not depend on the execution context.
simpleRegistry() - Static method in class dev.sympho.modular_commands.utils.Registries
Creates a simple, directly-mapped registry implementation that does not support overrides.
SimpleRegistry - Class in dev.sympho.modular_commands.impl.registry
A simple, directly-mapped registry implementation that does not support overrides.
SimpleRegistry() - Constructor for class dev.sympho.modular_commands.impl.registry.SimpleRegistry
Creates an empty registry.
SizeUtils - Class in dev.sympho.modular_commands.utils
Utilities for working with file sizes.
skipGroupCheckOnInteraction() - Method in interface dev.sympho.modular_commands.api.command.Command
Whether group access checking should be skipped when this command is invoked through an interaction.
slash() - Static method in interface dev.sympho.modular_commands.api.command.Command
Creates a builder for a slash-only command.
slash(InvocationHandler<? super SlashCommandContext>) - Static method in interface dev.sympho.modular_commands.api.command.handler.Handlers
Creates a handler set with the given handlers, with support only for slash-based commands, and no result handlers.
slash(InvocationHandler<? super SlashCommandContext>, ResultHandler<? super SlashCommandContext>...) - Static method in interface dev.sympho.modular_commands.api.command.handler.Handlers
Creates a handler set with the given handlers, with support only for slash-based commands.
slash(InvocationHandler<? super SlashCommandContext>, List<? extends ResultHandler<? super SlashCommandContext>>) - Static method in interface dev.sympho.modular_commands.api.command.handler.Handlers
Creates a handler set with the given handlers, with support only for slash-based commands.
SLASH - Enum constant in enum class dev.sympho.modular_commands.execute.Metrics.Tag.Type
A slash command-based command.
SlashCommandContext - Interface in dev.sympho.modular_commands.api.command.context
The execution context of an command invoked through a slash command.
SlashHandlers - Interface in dev.sympho.modular_commands.api.command.handler
A set of handlers that support slash-based invocations.
SlashHandlers.Impl - Record Class in dev.sympho.modular_commands.api.command.handler
A record-based implementation.
SmartIterator<E extends @NonNull Object> - Interface in dev.sympho.modular_commands.utils
An iterator with extra capabilities.
SmartIterator.Detachable<E extends @NonNull Object> - Interface in dev.sympho.modular_commands.utils
A smart iterator that, when creating other iterators/streams/fluxes/etc from its current state, makes them detached, so that they are independent of the future state of the original iterator and vice-versa.
SmartIterator.ListIterator<E extends @NonNull Object> - Class in dev.sympho.modular_commands.utils
A smart iterator that iterates over a list.
SmartIterator.Wrapper<E extends @NonNull Object> - Class in dev.sympho.modular_commands.utils
A smart iterator that wraps an existing iterator.
snowflake() - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives snowflake IDs.
snowflake(ParserFunction<Snowflake, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given function to parse received values.
SNOWFLAKE - Static variable in class dev.sympho.modular_commands.utils.parse.ParseUtils
Parser for snowflakes from strings.
SNOWFLAKE - Static variable in interface dev.sympho.modular_commands.utils.parse.RawParser
Parser for snowflakes.
SnowflakeParser<T extends @NonNull Object> - Interface in dev.sympho.modular_commands.api.command.parameter.parse
Parses snowflake-based input arguments.
SnowflakeParser.Type - Enum Class in dev.sympho.modular_commands.api.command.parameter.parse
The ID type.
snowflakes() - Static method in class dev.sympho.modular_commands.utils.parse.ParseUtils
A parser that parses a list of snowflake IDs.
split(String) - Method in interface dev.sympho.modular_commands.utils.StringSplitter.Async
 
split(String) - Method in interface dev.sympho.modular_commands.utils.StringSplitter
Splits the given string into components.
split(List<TryParser.Result<R, T>>) - Static method in interface dev.sympho.modular_commands.utils.parse.TryParser
Splits the given result list into a list of successfully parsed items and a list of failed items.
splitAsync(String) - Method in interface dev.sympho.modular_commands.utils.StringSplitter.Async
Splits the given string into components.
spliterate(String) - Method in interface dev.sympho.modular_commands.utils.StringSplitter.Async
Creates a spliterator that iterates over the components obtained by splitting the given raw string.
spliterator() - Method in record class dev.sympho.modular_commands.api.command.Invocation
 
splitStream(String) - Method in interface dev.sympho.modular_commands.utils.StringSplitter.Async
Creates a stream that contains over the components obtained by splitting the given raw string.
splitter() - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.ListParser
Gives the splitter to use for splitting received strings.
splitter() - Method in interface dev.sympho.modular_commands.utils.StringSplitter.Async.Iterator
 
splitter() - Method in interface dev.sympho.modular_commands.utils.StringSplitter.Iterator
Retrieves the splitter that created this iterator.
start() - Method in class dev.sympho.modular_commands.execute.CommandExecutor
Start receiving events and executing commands.
StaticPrefix - Record Class in dev.sympho.modular_commands.execute
Prefix provider that only uses a static prefix determined at construction time.
StaticPrefix(String) - Constructor for record class dev.sympho.modular_commands.execute.StaticPrefix
Creates an instance of a StaticPrefix record class.
stop() - Method in class dev.sympho.modular_commands.execute.CommandExecutor
Stops receiving events and executing commands.
stream() - Method in record class dev.sympho.modular_commands.api.command.Invocation
Obtains a stream over the invocation elements.
string() - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives plain string values.
string(Integer, Integer) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives plain string values.
string(List<ChoicesParser.Choice<String>>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives plain string values from within a set of choices.
string(ChoicesParser.Choice<String>...) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives plain string values from within a set of choices.
string(ParserFunction<String, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given function to parse received values.
string(ParserFunction<String, T>, Integer, Integer) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given function to parse received values.
STRING - Static variable in interface dev.sympho.modular_commands.utils.parse.RawParser
Parser for strings.
StringAdapter<R extends @NonNull Object,T extends @NonNull Object> - Record Class in dev.sympho.modular_commands.utils.parse
Adapter that converts an existing parser into a string parser, by first pre-parsing the string into another raw type.
StringAdapter(ParserFunction<String, R>, ParserFunction<R, T>) - Constructor for record class dev.sympho.modular_commands.utils.parse.StringAdapter
Creates an instance of a StringAdapter record class.
stringChoice(List<Map.Entry<ChoicesParser.Choice<String>, T>>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives a value from within a set of choices.
stringChoice(Map.Entry<ChoicesParser.Choice<String>, T>...) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives a value from within a set of choices.
StringParser<T extends @NonNull Object> - Interface in dev.sympho.modular_commands.api.command.parameter.parse
Parses string-based input arguments.
StringSplitter - Interface in dev.sympho.modular_commands.utils
A function that splits a string into multiple components.
StringSplitter.Async - Interface in dev.sympho.modular_commands.utils
A splitter that is capable of processing the split in an asynchronous manner.
StringSplitter.Async.Iterator - Interface in dev.sympho.modular_commands.utils
Iterator that splits elements lazily on demand during traversal.
StringSplitter.Iterator - Interface in dev.sympho.modular_commands.utils
An iterator over the elements split by a splitter.
StringSplitter.Shell - Class in dev.sympho.modular_commands.utils
A splitter that uses a shell-like splitting algorithm, where components are separated by spaces, with the option of one or more components being delimited by quotes (single or double) to allow for the inclusion of spaces.
stripFormatting(String) - Static method in interface dev.sympho.modular_commands.utils.parse.UrlParser
Clears special URL formatting from the given string, if any exists.
success(String) - Static method in class dev.sympho.modular_commands.api.command.result.Results
Generates a result indicating the command executed successfully with a message to the user.
Success(R, T) - Constructor for record class dev.sympho.modular_commands.utils.parse.TryParser.Success
Creates an instance of a Success record class.
successMono(String) - Static method in class dev.sympho.modular_commands.api.command.result.Results
Generates a result indicating the command executed successfully with a message to the user.
successR(String) - Static method in class dev.sympho.modular_commands.api.command.result.Results
Alias for Results.success(String) that casts to a plain Result to avoid Generics issues.
supports(URL) - Method in class dev.sympho.modular_commands.utils.parse.entity.EntityRefUrlParser
 
supports(URL) - Method in class dev.sympho.modular_commands.utils.parse.entity.EntityUrlParser
 
supports(URL) - Method in class dev.sympho.modular_commands.utils.parse.UrlParser.ChoiceBase
 
supports(URL) - Method in class dev.sympho.modular_commands.utils.parse.UrlParser.PostParser
 
supports(URL) - Method in interface dev.sympho.modular_commands.utils.parse.UrlParser
Checks if the given URL is supported by this parser.
sync(Parsers.Synchronous<R, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Uses a parser that executes synchronously.

T

tagType() - Method in class dev.sympho.modular_commands.execute.BaseCommandExecutor
Determines the type tag for this pipeline.
tagType() - Method in interface dev.sympho.modular_commands.execute.InstrumentedContext
Determines the value for the type tag.
tagType() - Method in class dev.sympho.modular_commands.execute.MessageCommandExecutor
 
tagType() - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl
 
takeNext(String, Consumer<String>) - Method in interface dev.sympho.modular_commands.utils.StringSplitter.Async
Takes the next element from the current state.
takeNext(String, Consumer<String>) - Method in class dev.sympho.modular_commands.utils.StringSplitter.Shell
 
tera(long) - Static method in class dev.sympho.modular_commands.utils.SizeUtils
Makes a size in terabytes.
TERA - Static variable in class dev.sympho.modular_commands.utils.SizeUtils
The value of the T prefix.
text() - Static method in interface dev.sympho.modular_commands.api.command.Command
Creates a builder for a text (message and slash) command.
text() - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives plain string values.
text(Integer, Integer) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives plain string values.
text(InvocationHandler<CommandContext>) - Static method in interface dev.sympho.modular_commands.api.command.handler.Handlers
Creates a handler set with the given handlers, with support only for text-based commands, and no result handlers.
text(InvocationHandler<CommandContext>, ResultHandler<CommandContext>...) - Static method in interface dev.sympho.modular_commands.api.command.handler.Handlers
Creates a handler set with the given handlers, with support for text-based commands.
text(InvocationHandler<CommandContext>, List<? extends ResultHandler<CommandContext>>) - Static method in interface dev.sympho.modular_commands.api.command.handler.Handlers
Creates a handler set with the given handlers, with support for text-based commands.
text(ParserFunction<String, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given function to parse received values.
text(ParserFunction<String, T>, Integer, Integer) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given function to parse received values.
textFile() - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives the plain contents of a text file, with unbounded file size.
textFile(int) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives the plain contents of a text file.
textFile(int, ParserFunction<String, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given parser to parse the contents received in a text file.
textFile(ParserFunction<String, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given parser to parse the contents received in a text file, with unbounded file size.
TextFileParser<T extends @NonNull Object> - Interface in dev.sympho.modular_commands.api.command.parameter.parse
Parses an argument from an attached text file.
TextHandlers - Interface in dev.sympho.modular_commands.api.command.handler
A set of handlers that support text-based (message and slash) invocations.
TextHandlers.Impl - Record Class in dev.sympho.modular_commands.api.command.handler
A record-based implementation.
then(ParserFunction<T, V>) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.ParserFunction
Returns a composed parser that first applies this parser to its input, and then applies the after parser to the result.
then(ParserFunction<T, V>) - Method in interface dev.sympho.modular_commands.utils.parse.UrlParser
Returns a composed parser that first applies this parser to its input, and then applies the after parser to the result.
then(Parsers.Functor<T, V>) - Method in interface dev.sympho.modular_commands.utils.parse.FunctorUrlParser
Returns a composed parser that first applies this parser to its input, and then applies the after parser to the result.
toFlux() - Method in interface dev.sympho.modular_commands.utils.SmartIterator.Detachable
Returns a flux that issues the remaining elements to be traversed by this iterator.
toFlux() - Method in class dev.sympho.modular_commands.utils.SmartIterator.ListIterator
 
toFlux() - Method in interface dev.sympho.modular_commands.utils.SmartIterator
Returns a flux that issues the remaining elements to be traversed by this iterator.
toHostMapper(Map<String, ? extends P>) - Static method in class dev.sympho.modular_commands.utils.parse.UrlParserUtils
Creates a delegate parser mapper where the parser choice depends on the host of the URL, using the given host-parser mappings.
toIterator() - Method in interface dev.sympho.modular_commands.utils.SmartIterator.Detachable
Returns an iterator that iterates over the remaining elements to be traversed by this iterator.
toIterator() - Method in class dev.sympho.modular_commands.utils.SmartIterator.ListIterator
 
toIterator() - Method in interface dev.sympho.modular_commands.utils.StringSplitter.Async.Iterator
 
toIterator() - Method in interface dev.sympho.modular_commands.utils.StringSplitter.Iterator
 
toMapper(Collection<? extends P>) - Static method in class dev.sympho.modular_commands.utils.parse.UrlParserUtils
Creates a delegate parser mapper where the parser choice is defined as the first parser in the iteration order of the given collection for which UrlParser.supports(URL) returns true for the URL being parsed.
toSpliterator() - Method in interface dev.sympho.modular_commands.utils.SmartIterator.Detachable
Returns a spliterator that iterates over the remaining elements to be traversed by this iterator.
toSpliterator() - Method in class dev.sympho.modular_commands.utils.SmartIterator.ListIterator
 
toSpliterator() - Method in interface dev.sympho.modular_commands.utils.SmartIterator
Returns a spliterator that iterates over the remaining elements to be traversed by this iterator.
toStream() - Method in interface dev.sympho.modular_commands.utils.SmartIterator.Detachable
Returns a stream that contains over the remaining elements to be traversed by this iterator.
toStream() - Method in class dev.sympho.modular_commands.utils.SmartIterator.ListIterator
 
toStream() - Method in interface dev.sympho.modular_commands.utils.SmartIterator
Returns a stream that contains the remaining elements to be traversed by this iterator.
toString() - Method in record class dev.sympho.modular_commands.api.command.handler.InteractionHandlers.Impl
Returns a string representation of this record class.
toString() - Method in record class dev.sympho.modular_commands.api.command.handler.MessageHandlers.Impl
Returns a string representation of this record class.
toString() - Method in record class dev.sympho.modular_commands.api.command.handler.SlashHandlers.Impl
Returns a string representation of this record class.
toString() - Method in record class dev.sympho.modular_commands.api.command.handler.TextHandlers.Impl
Returns a string representation of this record class.
toString() - Method in record class dev.sympho.modular_commands.api.command.Invocation
Returns a string representation of this record class.
toString() - Method in record class dev.sympho.modular_commands.api.command.parameter.parse.ChoicesParser.Choice
Returns a string representation of this record class.
toString() - Method in exception dev.sympho.modular_commands.api.command.parameter.parse.InvalidListException
 
toString() - Method in record class dev.sympho.modular_commands.api.command.result.CommandFailureArgumentExtra
Returns a string representation of this record class.
toString() - Method in record class dev.sympho.modular_commands.api.command.result.CommandFailureArgumentInvalid
Returns a string representation of this record class.
toString() - Method in record class dev.sympho.modular_commands.api.command.result.CommandFailureArgumentMissing
Returns a string representation of this record class.
toString() - Method in record class dev.sympho.modular_commands.api.command.result.UserNotAllowed
Returns a string representation of this record class.
toString() - Method in exception dev.sympho.modular_commands.api.exception.InvalidChainException
 
toString() - Method in record class dev.sympho.modular_commands.execute.GuildPrefix
Returns a string representation of this record class.
toString() - Method in record class dev.sympho.modular_commands.execute.Metrics.Tag.CommandId
Returns a string representation of this record class.
toString() - Method in record class dev.sympho.modular_commands.execute.StaticPrefix
Returns a string representation of this record class.
toString() - Method in record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.ChannelRef
Returns a string representation of this record class.
toString() - Method in record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.MessageRef
Returns a string representation of this record class.
toString() - Method in record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.RoleRef
Returns a string representation of this record class.
toString() - Method in record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.UserRef
Returns a string representation of this record class.
toString() - Method in record class dev.sympho.modular_commands.utils.parse.StringAdapter
Returns a string representation of this record class.
toString() - Method in record class dev.sympho.modular_commands.utils.parse.TryParser.Failure
Returns a string representation of this record class.
toString() - Method in record class dev.sympho.modular_commands.utils.parse.TryParser.Success
Returns a string representation of this record class.
TryParser<R extends @NonNull Object,T extends @NonNull Object> - Interface in dev.sympho.modular_commands.utils.parse
A parser wrapper that tolerates errors by returning a result that reports either the parsed item or an encountered error.
TryParser.Failure<R extends @NonNull Object,T extends @NonNull Object> - Record Class in dev.sympho.modular_commands.utils.parse
A result in which the item was invalid.
TryParser.Result<R extends @NonNull Object,T extends @NonNull Object> - Interface in dev.sympho.modular_commands.utils.parse
The result of parsing.
TryParser.Success<R extends @NonNull Object,T extends @NonNull Object> - Record Class in dev.sympho.modular_commands.utils.parse
A result in which the item was parsed successfully.
type() - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.ChannelArgumentParser
The required channel type.
type() - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.SnowflakeParser
The ID type accepted.
type() - Method in record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.ChannelRef
Returns the value of the type record component.
typeName() - Method in class dev.sympho.modular_commands.utils.parse.entity.ChannelRefMentionParser
 
typeName() - Method in class dev.sympho.modular_commands.utils.parse.entity.ChannelRefUrlParser
 
typeName() - Method in class dev.sympho.modular_commands.utils.parse.entity.EntityRefMentionParser
Gets the display name for this type.
typeName() - Method in class dev.sympho.modular_commands.utils.parse.entity.EntityRefUrlParser
Gets the display name for this type.
typeName() - Method in class dev.sympho.modular_commands.utils.parse.entity.MessageRefUrlParser
 
typeName() - Method in class dev.sympho.modular_commands.utils.parse.entity.RoleRefMentionParser
 
typeName() - Method in class dev.sympho.modular_commands.utils.parse.entity.UserRefMentionParser
 

U

UrlParser<T extends @NonNull Object> - Interface in dev.sympho.modular_commands.utils.parse
A parser for URL-based arguments.
UrlParser.Choice<T extends @NonNull Object> - Class in dev.sympho.modular_commands.utils.parse
Parser that supports multiple URL types by delegating to one of a list of parsers.
UrlParser.ChoiceBase<T extends @NonNull Object,P extends UrlParser<T>> - Class in dev.sympho.modular_commands.utils.parse
Base for a parser that supports multiple URL types by delegating to one of a list of parsers.
UrlParser.PostParser<I extends @NonNull Object,T extends @NonNull Object,P1 extends @NonNull UrlParser<I>,P2 extends @NonNull ParserFunction<I,T>> - Class in dev.sympho.modular_commands.utils.parse
A composed parser that first applies this parser to one parser, and then applies the results to a second parser.
UrlParserUtils - Class in dev.sympho.modular_commands.utils.parse
Convenience tools for implementing URL parsers.
user() - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives raw user values.
user(CommandContext) - Static method in interface dev.sympho.modular_commands.utils.parse.RawParser
Creates a parser for users with the given context.
user(ParserFunction<User, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given function to parse received values.
USER - Enum constant in enum class dev.sympho.modular_commands.api.command.parameter.parse.SnowflakeParser.Type
A user ID.
USER - Static variable in class dev.sympho.modular_commands.utils.parse.ParseUtils
Parser for users from strings.
USER_ID - Static variable in class dev.sympho.modular_commands.utils.parse.ParseUtils
Parser for user IDs from strings.
USER_REF - Static variable in class dev.sympho.modular_commands.utils.parse.ParseUtils
Parser for user references from strings.
UserArgumentParser<T extends @NonNull Object> - Interface in dev.sympho.modular_commands.api.command.parameter.parse
Parses Discord users.
userId() - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that receives user IDs.
userId(CommandContext) - Static method in interface dev.sympho.modular_commands.utils.parse.RawParser
Creates a parser for user IDs with the given context.
userId(ParserFunction<Snowflake, T>) - Static method in class dev.sympho.modular_commands.api.command.parameter.parse.Parsers
Creates a parser that uses the given function to parse received values.
UserMentionParser - Class in dev.sympho.modular_commands.utils.parse.entity
A parser for user mentions.
UserMentionParser() - Constructor for class dev.sympho.modular_commands.utils.parse.entity.UserMentionParser
Creates a new instance.
UserNotAllowed - Record Class in dev.sympho.modular_commands.api.command.result
A failure result due to the user not being part of a specific group.
UserNotAllowed(Group) - Constructor for record class dev.sympho.modular_commands.api.command.result.UserNotAllowed
Creates an instance of a UserNotAllowed record class.
UserParser - Class in dev.sympho.modular_commands.utils.parse.entity
A parser that extracts an user from a string.
UserParser() - Constructor for class dev.sympho.modular_commands.utils.parse.entity.UserParser
Creates a new instance.
UserRef(Snowflake) - Constructor for record class dev.sympho.modular_commands.utils.parse.entity.EntityRef.UserRef
Creates an instance of a UserRef record class.
UserRefMentionParser - Class in dev.sympho.modular_commands.utils.parse.entity
A parser for user mentions to references.
UserRefMentionParser() - Constructor for class dev.sympho.modular_commands.utils.parse.entity.UserRefMentionParser
Creates a new instance.
UserRefParser - Class in dev.sympho.modular_commands.utils.parse.entity
A parser that extracts a user reference from a string.
UserRefParser() - Constructor for class dev.sympho.modular_commands.utils.parse.entity.UserRefParser
Creates a new instance.
users() - Static method in class dev.sympho.modular_commands.utils.parse.ParseUtils
A parser that parses a list of users.

V

validate() - Method in interface dev.sympho.modular_commands.api.command.Command
Validates that the command properties of this instance are valid.
validate() - Method in interface dev.sympho.modular_commands.api.command.parameter.Parameter
Validates that the properties of this instance are valid.
validate(Parameter<?>) - Static method in class dev.sympho.modular_commands.utils.ParameterUtils
Validates a parameter.
validate(Attachment) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.AttachmentDataParser
 
validate(Attachment) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.AttachmentParserStages.Validator
Validates that the attachment is appropriate prior to fetching it.
validate(Attachment) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.TextFileParser
 
validateAccess(ChannelAccessValidator, List<? extends Command<?>>) - Method in class dev.sympho.modular_commands.execute.InvocationValidator
Validates that the user that invoked a command has sufficient access to do so.
validateAlias(String) - Static method in class dev.sympho.modular_commands.utils.CommandUtils
Validates an alias.
validateAliases(Set<String>) - Static method in class dev.sympho.modular_commands.utils.CommandUtils
Validates the aliases of a command.
validateCommand(Command<?>) - Static method in class dev.sympho.modular_commands.utils.CommandUtils
Validates a command.
validateDescription(String) - Static method in class dev.sympho.modular_commands.utils.CommandUtils
Validates the description of a command.
validateDescription(String) - Static method in class dev.sympho.modular_commands.utils.ParameterUtils
Validates the description of a parameter.
validateDisplayName(String) - Static method in class dev.sympho.modular_commands.utils.CommandUtils
Validates the display name of a command.
validateGroup(Group) - Static method in class dev.sympho.modular_commands.utils.CommandUtils
Validates the required group of a command.
validateHandlers(Handlers) - Static method in class dev.sympho.modular_commands.utils.CommandUtils
Validates the handlers of a command.
validateId(String) - Static method in class dev.sympho.modular_commands.utils.CommandUtils
Validates the ID of a command.
validateInvocationHandler(InvocationHandler<?>) - Static method in class dev.sympho.modular_commands.utils.CommandUtils
Validates the invocation handler of a command.
validateName(String) - Static method in class dev.sympho.modular_commands.utils.CommandUtils
Validates the name of a command.
validateName(String) - Static method in class dev.sympho.modular_commands.utils.ParameterUtils
Validates the name of a parameter.
validateParameters(List<Parameter<?>>) - Static method in class dev.sympho.modular_commands.utils.CommandUtils
Validates the parameters of a command.
validateParent(Invocation) - Static method in class dev.sympho.modular_commands.utils.CommandUtils
Validates the parent of a command.
validateRaw(Attachment) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.AttachmentDataParser
 
validateRaw(String) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.StringParser
 
validateRaw(P) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.ChoicesParser
 
validateRaw(P) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.NumberParser
 
validateRaw(R) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.ArgumentParser
Validates the raw value before parsing.
validateResponse(HttpClientResponse) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.AttachmentDataParser
Validates that the attachment fetch request was successful.
validateResultHandlers(List<? extends ResultHandler<?>>) - Static method in class dev.sympho.modular_commands.utils.CommandUtils
Validates the result handlers of a command.
validateSettings(E, List<? extends Command<?>>) - Method in class dev.sympho.modular_commands.execute.InvocationValidator
Validates that a command invocation is appropriate as per the command's settings.
validPath(String) - Method in class dev.sympho.modular_commands.utils.parse.entity.ChannelRefUrlParser
 
validPath(String) - Method in class dev.sympho.modular_commands.utils.parse.entity.EntityRefUrlParser
Checks if the given path (endpoint) is valid for the entity type of this parser.
validPath(String) - Method in class dev.sympho.modular_commands.utils.parse.entity.MessageRefUrlParser
 
value() - Method in record class dev.sympho.modular_commands.api.command.parameter.parse.ChoicesParser.Choice
Returns the value of the value record component.
value() - Method in record class dev.sympho.modular_commands.execute.Metrics.Tag.CommandId
 
value() - Method in enum class dev.sympho.modular_commands.execute.Metrics.Tag.Type
 
value() - Method in interface dev.sympho.modular_commands.execute.Metrics.Tag
Retrieves the tag value.
valueOf(String) - Static method in enum class dev.sympho.modular_commands.api.command.Command.Scope
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class dev.sympho.modular_commands.api.command.parameter.parse.SnowflakeParser.Type
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class dev.sympho.modular_commands.execute.Metrics.Tag.Type
Returns the enum constant of this class with the specified name.
valueParser() - Method in record class dev.sympho.modular_commands.utils.parse.StringAdapter
Returns the value of the valueParser record component.
values() - Static method in enum class dev.sympho.modular_commands.api.command.Command.Scope
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class dev.sympho.modular_commands.api.command.parameter.parse.SnowflakeParser.Type
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class dev.sympho.modular_commands.execute.Metrics.Tag.Type
Returns an array containing the constants of this enum class, in the order they are declared.
verifyChoice(P) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.ChoicesParser
Verifies that the given value is one of the allowed choices.
verifyInRange(P) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.NumberParser
Verifies that the given value is within the allowed range for this parser.
verifyLength(String) - Method in interface dev.sympho.modular_commands.api.command.parameter.parse.StringParser
Verifies that the given string is within the allowed length range for this parser.

W

Wrapper(Iterator<E>) - Constructor for class dev.sympho.modular_commands.utils.SmartIterator.Wrapper
Creates a new instance.
A B C D E F G H I K L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form