Index

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

A

accumulateDiscordPermissions(List<? extends Command>) - Static method in class dev.sympho.modular_commands.execute.InvocationUtils

Determines the total set of build-in permissions required for an execution chain.

accumulateHandlers(List<C>, Function<C, IH>) - Static method in class dev.sympho.modular_commands.execute.InvocationUtils

Determines the sequence of invocation handlers to execute.

addAliases(String) - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

addAliases(String) - Method in class dev.sympho.modular_commands.utils.builder.command.TextCommandBuilder

addChoice(String, String) - Method in class dev.sympho.modular_commands.utils.builder.parameter.StringParameterBuilder

Adds a possible of the parameter to build.

addChoice(String, Double) - Method in class dev.sympho.modular_commands.utils.builder.parameter.FloatParameterBuilder

Adds a possible of the parameter to build.

addParameter(Parameter<?>) - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Adds a parameter to the command.

addResultHandler(MessageResultHandler) - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Adds a handler that should process the command result after the previously added handlers but before any registry-defined ones.

aliases - Variable in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

The command aliases.

aliases - Variable in class dev.sympho.modular_commands.utils.builder.command.TextCommandBuilder

The command aliases.

aliases() - Method in interface dev.sympho.modular_commands.api.command.MessageCommand

The aliases that may also invoke the command.

aliases() - Method in record class dev.sympho.modular_commands.impl.command.MessageCommandImpl

Returns the value of the aliases record component.

aliases() - Method in record class dev.sympho.modular_commands.impl.command.TextCommandImpl

Returns the value of the aliases record component.

aliasInvocations() - Method in interface dev.sympho.modular_commands.api.command.MessageCommand

The alias invocations that may also invoke the command.

AnyCommandContext - Class in dev.sympho.modular_commands.api.command.context

A class that can represent any context type.

AnyCommandHandler - Interface in dev.sympho.modular_commands.api.command.handler

A function that handles the execution of any command type.

AnyResultHandler - Interface in dev.sympho.modular_commands.api.command.handler

A function that handles the result of any command type.

arg() - Method in record class dev.sympho.modular_commands.api.command.result.CommandFailureArgumentInvalid

Returns the value of the arg record component.

args() - Method in record class dev.sympho.modular_commands.api.command.result.CommandFailureArgumentExtra

Returns the value of the args record component.

B

botOwnerOnly - Variable in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Whether the command can only be run by the bot's owner.

botOwnerOnly() - Method in interface dev.sympho.modular_commands.api.command.Command

Whether this command can only be invoked by the owner of the bot.

botOwnerOnly() - Method in record class dev.sympho.modular_commands.impl.command.InteractionCommandImpl

Returns the value of the botOwnerOnly record component.

botOwnerOnly() - Method in record class dev.sympho.modular_commands.impl.command.MessageCommandImpl

Returns the value of the botOwnerOnly record component.

botOwnerOnly() - Method in record class dev.sympho.modular_commands.impl.command.SlashCommandImpl

Returns the value of the botOwnerOnly record component.

botOwnerOnly() - Method in record class dev.sympho.modular_commands.impl.command.TextCommandImpl

Returns the value of the botOwnerOnly record component.

build() - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

build() - Method in class dev.sympho.modular_commands.utils.builder.command.SlashCommandBuilder

build() - Method in class dev.sympho.modular_commands.utils.builder.command.TextCommandBuilder

build() - Method in class dev.sympho.modular_commands.utils.builder.parameter.ChannelParameterBuilder

build() - Method in class dev.sympho.modular_commands.utils.builder.parameter.FloatParameterBuilder

build() - Method in class dev.sympho.modular_commands.utils.builder.parameter.IntegerParameterBuilder

build() - Method in class dev.sympho.modular_commands.utils.builder.parameter.RoleParameterBuilder

build() - Method in class dev.sympho.modular_commands.utils.builder.parameter.StringParameterBuilder

build() - Method in class dev.sympho.modular_commands.utils.builder.parameter.UserParameterBuilder

buildDescription() - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Retrieve the description to use for building, after error checking.

buildDescription() - Method in class dev.sympho.modular_commands.utils.builder.parameter.ChannelParameterBuilder

Retrieve the description to use for building, after error checking.

buildDisplayName() - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Retrieve the display name to use for building, after error checking.

Builder<SELF extends Builder<SELF>> - Interface in dev.sympho.modular_commands.utils.builder

Base type for a builder.

buildInvocationHandler() - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Retrieve the invocation handler to use for building, after error checking.

buildName() - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Retrieve the name to use for building, after error checking.

buildName() - Method in class dev.sympho.modular_commands.utils.builder.parameter.ChannelParameterBuilder

Retrieve the name to use for building, after error checking.

buildPipeline(GatewayDiscordClient, Registry) - Method in class dev.sympho.modular_commands.execute.PipelineBuilder

Builds a new pipeline with the given client and registry.

C

callable - Variable in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Whether the command can be invoked directly.

callable() - Method in interface dev.sympho.modular_commands.api.command.Command

Whether this command can be invoked by a user.

callable() - Method in record class dev.sympho.modular_commands.impl.command.InteractionCommandImpl

Returns the value of the callable record component.

callable() - Method in record class dev.sympho.modular_commands.impl.command.MessageCommandImpl

Returns the value of the callable record component.

callable() - Method in record class dev.sympho.modular_commands.impl.command.SlashCommandImpl

Returns the value of the callable record component.

callable() - Method in record class dev.sympho.modular_commands.impl.command.TextCommandImpl

Returns the value of the callable record component.

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.

ChannelParameter - Record Class in dev.sympho.modular_commands.api.command.parameter

Specification for a parameter that receives a Discord channel.

ChannelParameter(String, String, boolean, Channel) - Constructor for record class dev.sympho.modular_commands.api.command.parameter.ChannelParameter

Creates a new instance.

ChannelParameterBuilder - Class in dev.sympho.modular_commands.utils.builder.parameter

Builder for a channel parameter.

ChannelParameterBuilder() - Constructor for class dev.sympho.modular_commands.utils.builder.parameter.ChannelParameterBuilder

Constructs a new builder with default values.

ChannelParameterBuilder(ChannelParameter) - Constructor for class dev.sympho.modular_commands.utils.builder.parameter.ChannelParameterBuilder

Constructs a new builder that is initialized to make a copy of the given parameter.

ChannelParameterBuilder(ChannelParameterBuilder) - Constructor for class dev.sympho.modular_commands.utils.builder.parameter.ChannelParameterBuilder

Constructs a new builder that is a copy of the given builder.

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.

choices - Variable in class dev.sympho.modular_commands.utils.builder.parameter.StringParameterBuilder

The valid user choices.

choices() - Method in interface dev.sympho.modular_commands.api.command.parameter.ChoicesParameter

The possible choices for the parameter value.

choices() - Method in record class dev.sympho.modular_commands.api.command.parameter.FloatParameter

Returns the value of the choices record component.

choices() - Method in record class dev.sympho.modular_commands.api.command.parameter.IntegerParameter

Returns the value of the choices record component.

choices() - Method in record class dev.sympho.modular_commands.api.command.parameter.StringParameter

Returns the value of the choices record component.

ChoicesParameter<T extends @NonNull Object> - Interface in dev.sympho.modular_commands.api.command.parameter

Specification for a parameter whose value may optionally be restricted to a set of predetermined values.

clearChoices() - Method in class dev.sympho.modular_commands.utils.builder.parameter.StringParameterBuilder

Clears the possible choices, but does not disable restricting the value with choices.

clearPrefix(Snowflake) - Method in record class dev.sympho.modular_commands.execute.GuildPrefix

Clears the override for a guild, if there is one.

Command - Interface in dev.sympho.modular_commands.api.command

A command that can be invoked by a user.

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.

CommandContinue - Interface in dev.sympho.modular_commands.api.command.result

Result that indicates that the execution chain should continue.

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) - 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(GatewayDiscordClient, Registry, PipelineBuilder<?, ?, ?, ?, ?>) - 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(String, 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.

CommandResult - Interface in dev.sympho.modular_commands.api.command.result

The result of a command.

CommandSuccess - Interface in dev.sympho.modular_commands.api.command.result

The result from a command that ran successfully.

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.PipelineBuilder

Retrives the command type to use.

CommandUtils - Class in dev.sympho.modular_commands.utils

Utility functions for Commands.

cont() - Static method in class dev.sympho.modular_commands.api.command.result.Results

Generates a result indicating execution should continue along the chain.

CONTINUE - Static variable in class dev.sympho.modular_commands.api.command.result.Results

Result indicating execution should continue along the chain.

contMono() - Static method in class dev.sympho.modular_commands.api.command.result.Results

Generates a result indicating execution should continue along the chain.

D

defaultPrefix() - Method in record class dev.sympho.modular_commands.execute.GuildPrefix

Returns the value of the defaultPrefix record component.

defaultValue - Variable in class dev.sympho.modular_commands.utils.builder.parameter.ChannelParameterBuilder

The default parameter value.

defaultValue() - Method in record class dev.sympho.modular_commands.api.command.parameter.ChannelParameter

Returns the value of the defaultValue record component.

defaultValue() - Method in record class dev.sympho.modular_commands.api.command.parameter.FloatParameter

Returns the value of the defaultValue record component.

defaultValue() - Method in record class dev.sympho.modular_commands.api.command.parameter.IntegerParameter

Returns the value of the defaultValue record component.

defaultValue() - Method in record class dev.sympho.modular_commands.api.command.parameter.MessageParameter

Returns the value of the defaultValue record component.

defaultValue() - Method in interface dev.sympho.modular_commands.api.command.parameter.Parameter

The default value for the parameter.

defaultValue() - Method in record class dev.sympho.modular_commands.api.command.parameter.RoleParameter

Returns the value of the defaultValue record component.

defaultValue() - Method in record class dev.sympho.modular_commands.api.command.parameter.StringParameter

Returns the value of the defaultValue record component.

defaultValue() - Method in record class dev.sympho.modular_commands.api.command.parameter.UserParameter

Returns the value of the defaultValue record component.

description - Variable in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

The command description.

description - Variable in class dev.sympho.modular_commands.utils.builder.parameter.ChannelParameterBuilder

The parameter description.

description() - Method in interface dev.sympho.modular_commands.api.command.Command

The description of the command.

description() - Method in record class dev.sympho.modular_commands.api.command.parameter.ChannelParameter

Returns the value of the description record component.

description() - Method in record class dev.sympho.modular_commands.api.command.parameter.FloatParameter

Returns the value of the description record component.

description() - Method in record class dev.sympho.modular_commands.api.command.parameter.IntegerParameter

Returns the value of the description record component.

description() - Method in record class dev.sympho.modular_commands.api.command.parameter.MessageParameter

Returns the value of the description record component.

description() - Method in interface dev.sympho.modular_commands.api.command.parameter.Parameter

The description of the parameter.

description() - Method in record class dev.sympho.modular_commands.api.command.parameter.RoleParameter

Returns the value of the description record component.

description() - Method in record class dev.sympho.modular_commands.api.command.parameter.StringParameter

Returns the value of the description record component.

description() - Method in record class dev.sympho.modular_commands.api.command.parameter.UserParameter

Returns the value of the description record component.

description() - Method in record class dev.sympho.modular_commands.impl.command.InteractionCommandImpl

Returns the value of the description record component.

description() - Method in record class dev.sympho.modular_commands.impl.command.MessageCommandImpl

Returns the value of the description record component.

description() - Method in record class dev.sympho.modular_commands.impl.command.SlashCommandImpl

Returns the value of the description record component.

description() - Method in record class dev.sympho.modular_commands.impl.command.TextCommandImpl

Returns the value of the description record component.

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 with 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.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.command - package dev.sympho.modular_commands.impl.command

Default implementation for command interfaces.

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.builder - package dev.sympho.modular_commands.utils.builder

Builders for various types.

dev.sympho.modular_commands.utils.builder.command - package dev.sympho.modular_commands.utils.builder.command

Builders for commands.

dev.sympho.modular_commands.utils.builder.parameter - package dev.sympho.modular_commands.utils.builder.parameter

Builders for command parameters.

displayName - Variable in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

The display name.

displayName() - Method in interface dev.sympho.modular_commands.api.command.Command

The display name of the command.

displayName() - Method in record class dev.sympho.modular_commands.impl.command.InteractionCommandImpl

Returns the value of the displayName record component.

displayName() - Method in record class dev.sympho.modular_commands.impl.command.MessageCommandImpl

Returns the value of the displayName record component.

displayName() - Method in record class dev.sympho.modular_commands.impl.command.SlashCommandImpl

Returns the value of the displayName record component.

displayName() - Method in record class dev.sympho.modular_commands.impl.command.TextCommandImpl

Returns the value of the displayName record component.

E

EntityParameter<T extends Entity> - Interface in dev.sympho.modular_commands.api.command.parameter

Specification for a parameter that receives Discord entities.

equals(Object) - Method in class dev.sympho.modular_commands.utils.builder.parameter.StringParameterBuilder

equals(Object) - Method in class dev.sympho.modular_commands.utils.builder.parameter.FloatParameterBuilder

equals(Object) - Method in class dev.sympho.modular_commands.utils.builder.parameter.ChannelParameterBuilder

Indicates whether the given object is a builder of the same type and configuration as 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.ChannelParameter

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class dev.sympho.modular_commands.api.command.parameter.FloatParameter

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class dev.sympho.modular_commands.api.command.parameter.IntegerParameter

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class dev.sympho.modular_commands.api.command.parameter.MessageParameter

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class dev.sympho.modular_commands.api.command.parameter.RoleParameter

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class dev.sympho.modular_commands.api.command.parameter.StringParameter

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class dev.sympho.modular_commands.api.command.parameter.UserParameter

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.UserMissingPermissions

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.StaticPrefix

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class dev.sympho.modular_commands.impl.command.InteractionCommandImpl

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class dev.sympho.modular_commands.impl.command.MessageCommandImpl

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class dev.sympho.modular_commands.impl.command.SlashCommandImpl

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class dev.sympho.modular_commands.impl.command.TextCommandImpl

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(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.

eventFilter(E) - Method in class dev.sympho.modular_commands.execute.PipelineBuilder

Determines if an event should be processed for commands.

eventType() - Method in class dev.sympho.modular_commands.execute.PipelineBuilder

Retrieves the event type to listen for.

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.

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.

failMono() - Static method in class dev.sympho.modular_commands.api.command.result.Results

Generates a result indicating the command failed with no further context.

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.

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.

findCommand(Invocation, Class<? extends C>) - Method in interface dev.sympho.modular_commands.api.registry.Registry

Retrieves the best command known to this registry that has the given parent and name, and is compatible with the given type.

findCommand(Invocation, Class<? extends C>) - Method in class dev.sympho.modular_commands.impl.registry.SimpleRegistry

FloatParameter - Record Class in dev.sympho.modular_commands.api.command.parameter

Specification for an floating-point parameter.

FloatParameter(String, String, boolean, Double) - Constructor for record class dev.sympho.modular_commands.api.command.parameter.FloatParameter

Creates a new instance with no value restrictions.

FloatParameter(String, String, boolean, Double, double, double) - Constructor for record class dev.sympho.modular_commands.api.command.parameter.FloatParameter

Creates a new instance with no value restrictions.

FloatParameter(String, String, boolean, Double, Map<String, Double>, Double, Double) - Constructor for record class dev.sympho.modular_commands.api.command.parameter.FloatParameter

Creates a new instance.

FloatParameter(String, String, boolean, Double, Map<String, Double>) - Constructor for record class dev.sympho.modular_commands.api.command.parameter.FloatParameter

Creates a new instance where the value is restricted to a set of values.

FloatParameterBuilder - Class in dev.sympho.modular_commands.utils.builder.parameter

Builder for a floating-point parameter.

FloatParameterBuilder() - Constructor for class dev.sympho.modular_commands.utils.builder.parameter.FloatParameterBuilder

Constructs a new builder with default values.

FloatParameterBuilder(FloatParameter) - Constructor for class dev.sympho.modular_commands.utils.builder.parameter.FloatParameterBuilder

Constructs a new builder that is initialized to make a copy of the given parameter.

FloatParameterBuilder(FloatParameterBuilder) - Constructor for class dev.sympho.modular_commands.utils.builder.parameter.FloatParameterBuilder

Constructs a new builder that is a copy of the given builder.

fromUrl(GatewayDiscordClient, String) - Method in record class dev.sympho.modular_commands.api.command.parameter.ChannelParameter

fromUrl(GatewayDiscordClient, String) - Method in interface dev.sympho.modular_commands.api.command.parameter.EntityParameter

Parses the entity from a URL.

fromUrl(GatewayDiscordClient, String) - Method in record class dev.sympho.modular_commands.api.command.parameter.MessageParameter

fullMatch() - Method in class dev.sympho.modular_commands.execute.PipelineBuilder

Determines whether a parsed arg list (as given by PipelineBuilder.parse(Event)) must always be fully matched to a command.

G

getArgument(String, Class<? extends T>) - Method in class dev.sympho.modular_commands.api.command.context.AnyCommandContext

getArgument(String, Class<? extends T>) - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext

Retrieves one of the arguments to the command.

getArgument(String, Class<? extends T>) - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl

getCaller() - Method in class dev.sympho.modular_commands.api.command.context.AnyCommandContext

getCaller() - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext

Retrieves the user that called the command.

getCaller() - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl

getCaller(E) - Method in class dev.sympho.modular_commands.execute.InvocationValidator

Retrieves the command's caller from the triggering event.

getCallerMember() - Method in class dev.sympho.modular_commands.api.command.context.AnyCommandContext

getCallerMember() - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext

Retries the user that called the command as a guild member as provided by the triggering event, if present.

getCallerMember() - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl

getChannel() - Method in class dev.sympho.modular_commands.api.command.context.AnyCommandContext

getChannel() - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext

Retrieves the channel that the command was invoked in.

getChannel() - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl

getChannel(E) - Method in class dev.sympho.modular_commands.execute.InvocationValidator

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

getChannelId() - Method in class dev.sympho.modular_commands.api.command.context.AnyCommandContext

getChannelId() - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext

Retrieves the ID of the channel that the command was invoked in.

getChannelId() - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl

getClient() - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext

Retrieves the client where the command was received.

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

getCommands(Class<? extends C>) - 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<? extends C>) - Method in class dev.sympho.modular_commands.impl.registry.SimpleRegistry

getContext(String, Class<? extends T>) - Method in class dev.sympho.modular_commands.api.command.context.AnyCommandContext

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

getEntity(CommandContext, Snowflake) - Method in record class dev.sympho.modular_commands.api.command.parameter.ChannelParameter

getEntity(CommandContext, Snowflake) - Method in interface dev.sympho.modular_commands.api.command.parameter.EntityParameter

Retrieves the entity with the given ID.

getEntity(CommandContext, Snowflake) - Method in record class dev.sympho.modular_commands.api.command.parameter.MessageParameter

getEntity(CommandContext, Snowflake) - Method in record class dev.sympho.modular_commands.api.command.parameter.RoleParameter

getEntity(CommandContext, Snowflake) - Method in record class dev.sympho.modular_commands.api.command.parameter.UserParameter

getEvent() - Method in class dev.sympho.modular_commands.api.command.context.AnyCommandContext

getEvent() - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext

Retrieves the event that triggered the command.

getEvent() - Method in interface dev.sympho.modular_commands.api.command.context.InteractionCommandContext

getEvent() - Method in interface dev.sympho.modular_commands.api.command.context.MessageCommandContext

getExecutionChain() - Method in exception dev.sympho.modular_commands.api.exception.IncompleteHandlingException

Retrieves the command chain that was being executed.

getGuild() - Method in class dev.sympho.modular_commands.api.command.context.AnyCommandContext

getGuild() - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext

Retrieves the guild that the command was invoked in, if there is one.

getGuild() - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl

getGuild(E) - Method in class dev.sympho.modular_commands.execute.InvocationValidator

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

getGuildId() - Method in class dev.sympho.modular_commands.api.command.context.AnyCommandContext

getGuildId() - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext

Retrieves the ID of the guild that the command was invoked in, if there is one.

getGuildId() - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl

getGuildId(E) - Method in class dev.sympho.modular_commands.execute.PipelineBuilder

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

getInteractionEvent() - Method in class dev.sympho.modular_commands.api.command.context.AnyCommandContext

getInteractionEvent() - Method in interface dev.sympho.modular_commands.api.command.context.InteractionCommandContext

Same as InteractionCommandContext.getEvent().

getInteractionEvent() - Method in interface dev.sympho.modular_commands.api.command.context.SlashCommandContext

getInvocation() - Method in class dev.sympho.modular_commands.api.command.context.AnyCommandContext

getInvocation() - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext

Retrieves the invocation that triggered the command.

getInvocation() - Method in exception dev.sympho.modular_commands.api.exception.IncompleteHandlingException

Retrieves the invocation that triggered the command.

getInvocation() - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl

getInvocationHandler(C) - Method in class dev.sympho.modular_commands.execute.PipelineBuilder

Retreives the invocation handler specified by the given command.

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.exception.InvalidArgumentException

getMessageEvent() - Method in class dev.sympho.modular_commands.api.command.context.AnyCommandContext

getMessageEvent() - Method in interface dev.sympho.modular_commands.api.command.context.MessageCommandContext

Same as MessageCommandContext.getEvent().

getMessageEvent() - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl

getParameter() - Method in exception dev.sympho.modular_commands.api.exception.InvalidArgumentException

Retrieves the parameter for the argument that caused the exception.

getParent() - Method in exception dev.sympho.modular_commands.api.exception.InvalidChainException

Retrieves the ancestor that is incompatible.

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.execute.ResultException

Retrieves the execution result.

getResultHandlers(C) - Method in class dev.sympho.modular_commands.execute.PipelineBuilder

Retreives the result handlers specified by the given command.

getSettingsSource(List<? extends Command>) - Static method in class dev.sympho.modular_commands.execute.InvocationUtils

Determines the command in the execution chain that should provide the invocation settings.

getSlashEvent() - Method in class dev.sympho.modular_commands.api.command.context.AnyCommandContext

getSlashEvent() - Method in interface dev.sympho.modular_commands.api.command.context.SlashCommandContext

Same as SlashCommandContext.getInteractionEvent().

getValidator() - Method in class dev.sympho.modular_commands.execute.PipelineBuilder

Retrieves the validator to use for validating command invocations.

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.

GUILD - Enum constant in enum class dev.sympho.modular_commands.api.command.Command.Scope

A command that can only be invoked in guild channels.

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(AnyCommandContext) - Method in interface dev.sympho.modular_commands.api.command.handler.AnyCommandHandler

handle(AnyCommandContext) - Method in interface dev.sympho.modular_commands.api.command.handler.InvocationHandler

Handles an invocation of the command.

handle(AnyCommandContext) - Method in interface dev.sympho.modular_commands.api.command.handler.MessageInvocationHandler

handle(AnyCommandContext) - Method in interface dev.sympho.modular_commands.api.command.handler.SlashInvocationHandler

handle(AnyCommandContext, CommandResult) - Method in interface dev.sympho.modular_commands.api.command.handler.AnyResultHandler

handle(AnyCommandContext, CommandResult) - Method in interface dev.sympho.modular_commands.api.command.handler.MessageResultHandler

handle(AnyCommandContext, CommandResult) - Method in interface dev.sympho.modular_commands.api.command.handler.ResultHandler

Handles the result of a command.

handle(AnyCommandContext, CommandResult) - Method in interface dev.sympho.modular_commands.api.command.handler.SlashResultHandler

handle(CommandContext) - Method in interface dev.sympho.modular_commands.api.command.handler.AnyCommandHandler

handle(CommandContext, CommandResult) - Method in interface dev.sympho.modular_commands.api.command.handler.AnyResultHandler

handle(InteractionCommandContext) - Method in interface dev.sympho.modular_commands.api.command.handler.AnyCommandHandler

handle(InteractionCommandContext) - Method in interface dev.sympho.modular_commands.api.command.handler.InteractionInvocationHandler

handle(InteractionCommandContext, CommandResult) - Method in interface dev.sympho.modular_commands.api.command.handler.AnyResultHandler

handle(InteractionCommandContext, CommandResult) - Method in interface dev.sympho.modular_commands.api.command.handler.InteractionResultHandler

handle(MessageCommandContext) - Method in interface dev.sympho.modular_commands.api.command.handler.AnyCommandHandler

handle(MessageCommandContext) - Method in interface dev.sympho.modular_commands.api.command.handler.MessageInvocationHandler

handle(MessageCommandContext, CommandResult) - Method in interface dev.sympho.modular_commands.api.command.handler.AnyResultHandler

handle(MessageCommandContext, CommandResult) - Method in interface dev.sympho.modular_commands.api.command.handler.MessageResultHandler

handle(SlashCommandContext) - Method in interface dev.sympho.modular_commands.api.command.handler.InteractionInvocationHandler

handle(SlashCommandContext) - Method in interface dev.sympho.modular_commands.api.command.handler.SlashInvocationHandler

handle(SlashCommandContext, CommandResult) - Method in interface dev.sympho.modular_commands.api.command.handler.InteractionResultHandler

handle(SlashCommandContext, CommandResult) - Method in interface dev.sympho.modular_commands.api.command.handler.SlashResultHandler

handle(RH, CTX, CommandResult) - Method in class dev.sympho.modular_commands.execute.PipelineBuilder

Invokes the given handler with the given context and result.

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.ChannelParameter

Returns a hash code value for this object.

hashCode() - Method in record class dev.sympho.modular_commands.api.command.parameter.FloatParameter

Returns a hash code value for this object.

hashCode() - Method in record class dev.sympho.modular_commands.api.command.parameter.IntegerParameter

Returns a hash code value for this object.

hashCode() - Method in record class dev.sympho.modular_commands.api.command.parameter.MessageParameter

Returns a hash code value for this object.

hashCode() - Method in record class dev.sympho.modular_commands.api.command.parameter.RoleParameter

Returns a hash code value for this object.

hashCode() - Method in record class dev.sympho.modular_commands.api.command.parameter.StringParameter

Returns a hash code value for this object.

hashCode() - Method in record class dev.sympho.modular_commands.api.command.parameter.UserParameter

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.UserMissingPermissions

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.StaticPrefix

Returns a hash code value for this object.

hashCode() - Method in record class dev.sympho.modular_commands.impl.command.InteractionCommandImpl

Returns a hash code value for this object.

hashCode() - Method in record class dev.sympho.modular_commands.impl.command.MessageCommandImpl

Returns a hash code value for this object.

hashCode() - Method in record class dev.sympho.modular_commands.impl.command.SlashCommandImpl

Returns a hash code value for this object.

hashCode() - Method in record class dev.sympho.modular_commands.impl.command.TextCommandImpl

Returns a hash code value for this object.

hashCode() - Method in class dev.sympho.modular_commands.utils.builder.parameter.StringParameterBuilder

hashCode() - Method in class dev.sympho.modular_commands.utils.builder.parameter.FloatParameterBuilder

hashCode() - Method in class dev.sympho.modular_commands.utils.builder.parameter.ChannelParameterBuilder

I

IncompleteHandlingException - Exception in dev.sympho.modular_commands.api.exception

Exception type that is triggered when the invocation handling of a command is completed without a non-continue result.

IncompleteHandlingException(List<? extends Command>, Invocation) - Constructor for exception dev.sympho.modular_commands.api.exception.IncompleteHandlingException

Creates a new instance.

inheritSettings - Variable in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Whether to inherit settings from parent.

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).

inheritSettings() - Method in record class dev.sympho.modular_commands.impl.command.InteractionCommandImpl

Returns the value of the inheritSettings record component.

inheritSettings() - Method in record class dev.sympho.modular_commands.impl.command.MessageCommandImpl

Returns the value of the inheritSettings record component.

inheritSettings() - Method in record class dev.sympho.modular_commands.impl.command.SlashCommandImpl

Returns the value of the inheritSettings record component.

inheritSettings() - Method in record class dev.sympho.modular_commands.impl.command.TextCommandImpl

Returns the value of the inheritSettings record component.

IntegerParameter - Record Class in dev.sympho.modular_commands.api.command.parameter

Specification for an integer parameter.

IntegerParameter(String, String, boolean, Long) - Constructor for record class dev.sympho.modular_commands.api.command.parameter.IntegerParameter

Creates a new instance with no value restrictions.

IntegerParameter(String, String, boolean, Long, long, long) - Constructor for record class dev.sympho.modular_commands.api.command.parameter.IntegerParameter

Creates a new instance with no value restrictions.

IntegerParameter(String, String, boolean, Long, Map<String, Long>, Long, Long) - Constructor for record class dev.sympho.modular_commands.api.command.parameter.IntegerParameter

Creates a new instance.

IntegerParameter(String, String, boolean, Long, Map<String, Long>) - Constructor for record class dev.sympho.modular_commands.api.command.parameter.IntegerParameter

Creates a new instance where the value is restricted to a set of values.

IntegerParameterBuilder - Class in dev.sympho.modular_commands.utils.builder.parameter

Builder for an integer parameter.

IntegerParameterBuilder() - Constructor for class dev.sympho.modular_commands.utils.builder.parameter.IntegerParameterBuilder

Constructs a new builder with default values.

IntegerParameterBuilder(IntegerParameter) - Constructor for class dev.sympho.modular_commands.utils.builder.parameter.IntegerParameterBuilder

Constructs a new builder that is initialized to make a copy of the given parameter.

IntegerParameterBuilder(IntegerParameterBuilder) - Constructor for class dev.sympho.modular_commands.utils.builder.parameter.IntegerParameterBuilder

Constructs a new builder that is a copy of the given builder.

InteractionCommand - Interface in dev.sympho.modular_commands.api.command

An interaction-based command.

InteractionCommandContext - Interface in dev.sympho.modular_commands.api.command.context

The execution context of an command invoked through an interaction (application command).

InteractionCommandImpl - Record Class in dev.sympho.modular_commands.impl.command

Default implementation of an interaction-based command.

InteractionCommandImpl(Command.Scope, boolean, Invocation, String, String, String, List<Parameter<?>>, PermissionSet, boolean, boolean, boolean, boolean, boolean, boolean, boolean, InteractionInvocationHandler, List<? extends InteractionResultHandler>) - Constructor for record class dev.sympho.modular_commands.impl.command.InteractionCommandImpl

Initializes a new instance.

InteractionInvocationHandler - Interface in dev.sympho.modular_commands.api.command.handler

A function that handles the execution of an interaction command.

InteractionResultHandler - Interface in dev.sympho.modular_commands.api.command.handler

A function that handles the result of an interaction command.

InvalidArgumentException - Exception in dev.sympho.modular_commands.api.exception

Exception thrown when an argument cannot be parsed due to being invalid.

InvalidArgumentException(Parameter<?>, String) - Constructor for exception dev.sympho.modular_commands.api.exception.InvalidArgumentException

Constructs a new exception.

InvalidArgumentException(Parameter<?>, String, Throwable) - Constructor for exception dev.sympho.modular_commands.api.exception.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.

invocation() - Method in interface dev.sympho.modular_commands.api.command.Command

The invocation that executes this command.

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 - Variable in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

The handler to process invocations with.

invocationHandler() - Method in interface dev.sympho.modular_commands.api.command.Command

The handler to use for processing an invocation of the command.

invocationHandler() - Method in interface dev.sympho.modular_commands.api.command.InteractionCommand

invocationHandler() - Method in interface dev.sympho.modular_commands.api.command.MessageCommand

invocationHandler() - Method in interface dev.sympho.modular_commands.api.command.SlashCommand

invocationHandler() - Method in interface dev.sympho.modular_commands.api.command.TextCommand

invocationHandler() - Method in record class dev.sympho.modular_commands.impl.command.InteractionCommandImpl

Returns the value of the invocationHandler record component.

invocationHandler() - Method in record class dev.sympho.modular_commands.impl.command.MessageCommandImpl

Returns the value of the invocationHandler record component.

invocationHandler() - Method in record class dev.sympho.modular_commands.impl.command.SlashCommandImpl

Returns the value of the invocationHandler record component.

invocationHandler() - Method in record class dev.sympho.modular_commands.impl.command.TextCommandImpl

Returns the value of the invocationHandler record component.

InvocationHandler - 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

invoke(IH, CTX) - Method in class dev.sympho.modular_commands.execute.PipelineBuilder

Invokes the given handler with the given context.

invokeParent - Variable in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Whether to execute the parent.

invokeParent() - Method in interface dev.sympho.modular_commands.api.command.Command

Whether the parent command should be invoked before this command is invoked.

invokeParent() - Method in record class dev.sympho.modular_commands.impl.command.InteractionCommandImpl

Returns the value of the invokeParent record component.

invokeParent() - Method in record class dev.sympho.modular_commands.impl.command.MessageCommandImpl

Returns the value of the invokeParent record component.

invokeParent() - Method in record class dev.sympho.modular_commands.impl.command.SlashCommandImpl

Returns the value of the invokeParent record component.

invokeParent() - Method in record class dev.sympho.modular_commands.impl.command.TextCommandImpl

Returns the value of the invokeParent record component.

L

LazyContext - Interface in dev.sympho.modular_commands.api.command.context

A command context whose values (particularly arguments) are lazy-loaded (that is, are not loaded until requested by LazyContext.load()).

load() - Method in interface dev.sympho.modular_commands.api.command.context.LazyContext

Loads internal state, making the context ready for use.

load() - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl

M

makeChain(Registry, List<String>, Class<? extends C>) - Static method in class dev.sympho.modular_commands.execute.InvocationUtils

Builds an execution chain from a sequence of args by performing lookups on the given registry.

makeContext(E, C, Invocation, List<String>) - Method in class dev.sympho.modular_commands.execute.PipelineBuilder

Creates a command context from a parsed invocation.

maximum - Variable in class dev.sympho.modular_commands.utils.builder.parameter.FloatParameterBuilder

The maximum acceptable value, inclusive.

maximum() - Method in record class dev.sympho.modular_commands.api.command.parameter.FloatParameter

Returns the value of the maximum record component.

maximum() - Method in record class dev.sympho.modular_commands.api.command.parameter.IntegerParameter

Returns the value of the maximum record component.

maximum() - Method in interface dev.sympho.modular_commands.api.command.parameter.NumberParameter

The maximum acceptable value (inclusive).

MentionableParameter<T extends Entity> - Interface in dev.sympho.modular_commands.api.command.parameter

Specification for a parameter that receives Discord entities that can be mentioned.

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.CommandSuccessMessage

Retrieves the message to the user.

message() - Method in record class dev.sympho.modular_commands.api.command.result.UserMissingPermissions

MessageCommand - Interface in dev.sympho.modular_commands.api.command

A message-based command.

MessageCommandBuilder - Class in dev.sympho.modular_commands.utils.builder.command

A builder for a message command.

MessageCommandBuilder() - Constructor for class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Constructs a new builder with default values.

MessageCommandBuilder(MessageCommand) - Constructor for class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Constructs a new builder that is initialized to make a copy of the given command.

MessageCommandBuilder(MessageCommandBuilder) - Constructor for class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Constructs a new builder that is a copy of the given builder.

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, PrefixProvider) - Constructor for class dev.sympho.modular_commands.execute.MessageCommandExecutor

Creates a new instance.

MessageCommandImpl - Record Class in dev.sympho.modular_commands.impl.command

Default implementation of a message-based command.

MessageCommandImpl(Command.Scope, boolean, Invocation, String, String, Set<String>, String, List<Parameter<?>>, PermissionSet, boolean, boolean, boolean, boolean, boolean, boolean, boolean, MessageInvocationHandler, List<? extends MessageResultHandler>) - Constructor for record class dev.sympho.modular_commands.impl.command.MessageCommandImpl

Initializes a new instance.

MessageContextImpl - Class in dev.sympho.modular_commands.impl.context

Context object for invocations performed through text messages.

MessageContextImpl(MessageCreateEvent, Invocation, List<Parameter<?>>, List<String>) - Constructor for class dev.sympho.modular_commands.impl.context.MessageContextImpl

Initializes a new context.

MessageInvocationHandler - Interface in dev.sympho.modular_commands.api.command.handler

A function that handles the execution of a message-based command.

MessageParameter - Record Class in dev.sympho.modular_commands.api.command.parameter

Specification for a parameter that receives a Discord message.

MessageParameter(String, String, boolean, Message) - Constructor for record class dev.sympho.modular_commands.api.command.parameter.MessageParameter

Creates a new instance.

MessageResultHandler - Interface in dev.sympho.modular_commands.api.command.handler

A function that handles the result of a message-based command.

minimum - Variable in class dev.sympho.modular_commands.utils.builder.parameter.FloatParameterBuilder

The minimum acceptable value, inclusive.

minimum() - Method in record class dev.sympho.modular_commands.api.command.parameter.FloatParameter

Returns the value of the minimum record component.

minimum() - Method in record class dev.sympho.modular_commands.api.command.parameter.IntegerParameter

Returns the value of the minimum record component.

minimum() - Method in interface dev.sympho.modular_commands.api.command.parameter.NumberParameter

The minimum acceptable value (inclusive).

missingDiscordPermissions() - Method in record class dev.sympho.modular_commands.api.command.result.UserMissingPermissions

Returns the value of the missingDiscordPermissions record component.

N

name - Variable in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

The command name.

name - Variable in class dev.sympho.modular_commands.utils.builder.parameter.ChannelParameterBuilder

The parameter name.

name() - Method in interface dev.sympho.modular_commands.api.command.Command

The name of the command.

name() - Method in record class dev.sympho.modular_commands.api.command.parameter.ChannelParameter

Returns the value of the name record component.

name() - Method in record class dev.sympho.modular_commands.api.command.parameter.FloatParameter

Returns the value of the name record component.

name() - Method in record class dev.sympho.modular_commands.api.command.parameter.IntegerParameter

Returns the value of the name record component.

name() - Method in record class dev.sympho.modular_commands.api.command.parameter.MessageParameter

Returns the value of the name record component.

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.RoleParameter

Returns the value of the name record component.

name() - Method in record class dev.sympho.modular_commands.api.command.parameter.StringParameter

Returns the value of the name record component.

name() - Method in record class dev.sympho.modular_commands.api.command.parameter.UserParameter

Returns the value of the name record component.

name() - Method in record class dev.sympho.modular_commands.impl.command.InteractionCommandImpl

Returns the value of the name record component.

name() - Method in record class dev.sympho.modular_commands.impl.command.MessageCommandImpl

Returns the value of the name record component.

name() - Method in record class dev.sympho.modular_commands.impl.command.SlashCommandImpl

Returns the value of the name record component.

name() - Method in record class dev.sympho.modular_commands.impl.command.TextCommandImpl

Returns the value of the name record component.

noAliases() - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

noAliases() - Method in class dev.sympho.modular_commands.utils.builder.command.TextCommandBuilder

noChoices() - Method in class dev.sympho.modular_commands.utils.builder.parameter.StringParameterBuilder

Disables restricting the value with choices.

noMaximum() - Method in class dev.sympho.modular_commands.utils.builder.parameter.FloatParameterBuilder

Removes the upper bound on the parameter value.

noMinimum() - Method in class dev.sympho.modular_commands.utils.builder.parameter.FloatParameterBuilder

Removes the lower bound on the parameter value.

noParameters() - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Removes all parameters from the command.

noRange() - Method in class dev.sympho.modular_commands.utils.builder.parameter.FloatParameterBuilder

Removes the range bound on the parameter value.

noResultHandlers() - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Removes all result handlers (set to no handlers).

nsfw - Variable in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Whether the command can only be run in NSFW channels.

nsfw() - Method in interface dev.sympho.modular_commands.api.command.Command

Whether this command can only be invoked in a NSFW channel.

nsfw() - Method in record class dev.sympho.modular_commands.impl.command.InteractionCommandImpl

Returns the value of the nsfw record component.

nsfw() - Method in record class dev.sympho.modular_commands.impl.command.MessageCommandImpl

Returns the value of the nsfw record component.

nsfw() - Method in record class dev.sympho.modular_commands.impl.command.SlashCommandImpl

Returns the value of the nsfw record component.

nsfw() - Method in record class dev.sympho.modular_commands.impl.command.TextCommandImpl

Returns the value of the nsfw record component.

NumberParameter<T extends @NonNull Number & Comparable<T>> - Interface in dev.sympho.modular_commands.api.command.parameter

Specification for a parameter that receives a numeric value.

O

of(String...) - Static method in record class dev.sympho.modular_commands.api.command.Invocation

Constructs an invocation from the given sequence of command names.

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.

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.

parameters - Variable in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

The command parameters.

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.

parameters() - Method in record class dev.sympho.modular_commands.impl.command.InteractionCommandImpl

Returns the value of the parameters record component.

parameters() - Method in record class dev.sympho.modular_commands.impl.command.MessageCommandImpl

Returns the value of the parameters record component.

parameters() - Method in record class dev.sympho.modular_commands.impl.command.SlashCommandImpl

Returns the value of the parameters record component.

parameters() - Method in record class dev.sympho.modular_commands.impl.command.TextCommandImpl

Returns the value of the parameters record component.

ParameterUtils - Class in dev.sympho.modular_commands.utils

Utility functions for Parameter interfaces.

parent - Variable in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

The command parent.

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() - Method in record class dev.sympho.modular_commands.impl.command.InteractionCommandImpl

Returns the value of the parent record component.

parent() - Method in record class dev.sympho.modular_commands.impl.command.MessageCommandImpl

Returns the value of the parent record component.

parent() - Method in record class dev.sympho.modular_commands.impl.command.SlashCommandImpl

Returns the value of the parent record component.

parent() - Method in record class dev.sympho.modular_commands.impl.command.TextCommandImpl

Returns the value of the parent record component.

parse(CommandContext, String) - Method in interface dev.sympho.modular_commands.api.command.parameter.ChoicesParameter

parse(CommandContext, String) - Method in interface dev.sympho.modular_commands.api.command.parameter.EntityParameter

parse(CommandContext, String) - Method in interface dev.sympho.modular_commands.api.command.parameter.Parameter

Parses the given raw argument from the user into the corresponding value.

parse(CommandContext, String) - Method in record class dev.sympho.modular_commands.api.command.parameter.RoleParameter

parse(E) - Method in class dev.sympho.modular_commands.execute.PipelineBuilder

Parses the raw args from the event.

parseArgument(Parameter<?>, String) - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl

parseId(String) - Method in interface dev.sympho.modular_commands.api.command.parameter.EntityParameter

Parses the entity ID from the raw argument.

parseId(String) - Method in interface dev.sympho.modular_commands.api.command.parameter.MentionableParameter

parseMention(String) - Method in record class dev.sympho.modular_commands.api.command.parameter.ChannelParameter

parseMention(String) - Method in interface dev.sympho.modular_commands.api.command.parameter.MentionableParameter

Parses the entity ID from a text mention.

parseMention(String) - Method in record class dev.sympho.modular_commands.api.command.parameter.RoleParameter

parseMention(String) - Method in record class dev.sympho.modular_commands.api.command.parameter.UserParameter

parseMention(String, String) - Static method in interface dev.sympho.modular_commands.api.command.parameter.MentionableParameter

Parses the entity ID from a text mention.

parseNumber(String) - Method in record class dev.sympho.modular_commands.api.command.parameter.FloatParameter

parseNumber(String) - Method in record class dev.sympho.modular_commands.api.command.parameter.IntegerParameter

parseNumber(String) - Method in interface dev.sympho.modular_commands.api.command.parameter.NumberParameter

Parses the given raw argument from the user into the corresponding value.

parseValue(String) - Method in interface dev.sympho.modular_commands.api.command.parameter.ChoicesParameter

Parses the given raw argument from the user into the corresponding value.

parseValue(String) - Method in interface dev.sympho.modular_commands.api.command.parameter.NumberParameter

parseValue(String) - Method in record class dev.sympho.modular_commands.api.command.parameter.StringParameter

PipelineBuilder<E extends Event,C extends Command,CTX extends CommandContext & LazyContext,IH extends InvocationHandler,RH extends ResultHandler> - Class in dev.sympho.modular_commands.execute

Type responsible for building a command processing pipeline.

PipelineBuilder() - Constructor for class dev.sympho.modular_commands.execute.PipelineBuilder

prefix() - Method in record class dev.sympho.modular_commands.execute.StaticPrefix

Returns the value of the prefix record component.

prefixes() - Method in record class dev.sympho.modular_commands.execute.GuildPrefix

Returns the value of the prefixes record component.

PrefixProvider - Interface in dev.sympho.modular_commands.execute

Object that provides the prefix to consider for commands during event handling.

privateReply - Variable in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Whether the command response should only be seen by the caller.

privateReply() - Method in interface dev.sympho.modular_commands.api.command.Command

Whether this command's response is sent in a way that only the invoking user can see.

privateReply() - Method in record class dev.sympho.modular_commands.impl.command.InteractionCommandImpl

Returns the value of the privateReply record component.

privateReply() - Method in record class dev.sympho.modular_commands.impl.command.MessageCommandImpl

Returns the value of the privateReply record component.

privateReply() - Method in record class dev.sympho.modular_commands.impl.command.SlashCommandImpl

Returns the value of the privateReply record component.

privateReply() - Method in record class dev.sympho.modular_commands.impl.command.TextCommandImpl

Returns the value of the privateReply record component.

R

rawToString(String) - Method in class dev.sympho.modular_commands.impl.context.MessageContextImpl

Converts a raw argument into a string.

registerCommand(String, Command) - Method in interface dev.sympho.modular_commands.api.registry.Registry

Registers a command into this registry.

registerCommand(String, Command) - Method in class dev.sympho.modular_commands.impl.registry.SimpleRegistry

Registries - Class in dev.sympho.modular_commands.utils

Provides instances of default registry implementations.

Registry - Interface in dev.sympho.modular_commands.api.registry

A registry that stores commands that may be invoked by users.

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

requireArgument(String, Class<? extends T>) - Method in interface dev.sympho.modular_commands.api.command.context.CommandContext

Retrieves one of the arguments to the command, assuming it is non-null (so either required or with a default value).

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 - Variable in class dev.sympho.modular_commands.utils.builder.parameter.ChannelParameterBuilder

Whether the parameter is required.

required() - Method in record class dev.sympho.modular_commands.api.command.parameter.ChannelParameter

Returns the value of the required record component.

required() - Method in record class dev.sympho.modular_commands.api.command.parameter.FloatParameter

Returns the value of the required record component.

required() - Method in record class dev.sympho.modular_commands.api.command.parameter.IntegerParameter

Returns the value of the required record component.

required() - Method in record class dev.sympho.modular_commands.api.command.parameter.MessageParameter

Returns the value of the required record component.

required() - Method in interface dev.sympho.modular_commands.api.command.parameter.Parameter

Whether the parameter must be specified to invoke the command.

required() - Method in record class dev.sympho.modular_commands.api.command.parameter.RoleParameter

Returns the value of the required record component.

required() - Method in record class dev.sympho.modular_commands.api.command.parameter.StringParameter

Returns the value of the required record component.

required() - Method in record class dev.sympho.modular_commands.api.command.parameter.UserParameter

Returns the value of the required record component.

requiredDiscordPermissions - Variable in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

The required built-in permissions for the user.

requiredDiscordPermissions() - Method in interface dev.sympho.modular_commands.api.command.Command

The built-in permissions that a user should have in order to execute the command.

requiredDiscordPermissions() - Method in record class dev.sympho.modular_commands.impl.command.InteractionCommandImpl

Returns the value of the requiredDiscordPermissions record component.

requiredDiscordPermissions() - Method in record class dev.sympho.modular_commands.impl.command.MessageCommandImpl

Returns the value of the requiredDiscordPermissions record component.

requiredDiscordPermissions() - Method in record class dev.sympho.modular_commands.impl.command.SlashCommandImpl

Returns the value of the requiredDiscordPermissions record component.

requiredDiscordPermissions() - Method in record class dev.sympho.modular_commands.impl.command.TextCommandImpl

Returns the value of the requiredDiscordPermissions record component.

requireDiscordPermissions(PermissionSet) - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Sets the built-in permissions that the caller should have.

requireParentPermissions - Variable in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Whether to also require the parent command's permissions.

requireParentPermissions() - Method in interface dev.sympho.modular_commands.api.command.Command

Whether a user invoking this command must also have the permissions to invoke its parent command.

requireParentPermissions() - Method in record class dev.sympho.modular_commands.impl.command.InteractionCommandImpl

Returns the value of the requireParentPermissions record component.

requireParentPermissions() - Method in record class dev.sympho.modular_commands.impl.command.MessageCommandImpl

Returns the value of the requireParentPermissions record component.

requireParentPermissions() - Method in record class dev.sympho.modular_commands.impl.command.SlashCommandImpl

Returns the value of the requireParentPermissions record component.

requireParentPermissions() - Method in record class dev.sympho.modular_commands.impl.command.TextCommandImpl

Returns the value of the requireParentPermissions record component.

ResultException - Exception in dev.sympho.modular_commands.execute

Exception type that indicates that command execution has completed.

ResultException(CommandResult) - Constructor for exception dev.sympho.modular_commands.execute.ResultException

Creates a new instance.

ResultHandler - Interface in dev.sympho.modular_commands.api.command.handler

A function that handles the result of a command.

resultHandlers - Variable in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

The handlers to process results with.

resultHandlers() - Method in interface dev.sympho.modular_commands.api.command.Command

The handlers to use for processing the result, in order.

resultHandlers() - Method in interface dev.sympho.modular_commands.api.command.InteractionCommand

resultHandlers() - Method in interface dev.sympho.modular_commands.api.command.MessageCommand

resultHandlers() - Method in interface dev.sympho.modular_commands.api.command.SlashCommand

resultHandlers() - Method in interface dev.sympho.modular_commands.api.command.TextCommand

resultHandlers() - Method in record class dev.sympho.modular_commands.impl.command.InteractionCommandImpl

Returns the value of the resultHandlers record component.

resultHandlers() - Method in record class dev.sympho.modular_commands.impl.command.MessageCommandImpl

Returns the value of the resultHandlers record component.

resultHandlers() - Method in record class dev.sympho.modular_commands.impl.command.SlashCommandImpl

Returns the value of the resultHandlers record component.

resultHandlers() - Method in record class dev.sympho.modular_commands.impl.command.TextCommandImpl

Returns the value of the resultHandlers record component.

Results - Class in dev.sympho.modular_commands.api.command.result

Utilities for generating results from handlers.

RoleParameter - Record Class in dev.sympho.modular_commands.api.command.parameter

Specification for a parameter that receives a Discord role.

RoleParameter(String, String, boolean, Role) - Constructor for record class dev.sympho.modular_commands.api.command.parameter.RoleParameter

Creates a new instance.

RoleParameterBuilder - Class in dev.sympho.modular_commands.utils.builder.parameter

Builder for a role parameter.

RoleParameterBuilder() - Constructor for class dev.sympho.modular_commands.utils.builder.parameter.RoleParameterBuilder

Constructs a new builder with default values.

RoleParameterBuilder(RoleParameter) - Constructor for class dev.sympho.modular_commands.utils.builder.parameter.RoleParameterBuilder

Constructs a new builder that is initialized to make a copy of the given parameter.

RoleParameterBuilder(RoleParameterBuilder) - Constructor for class dev.sympho.modular_commands.utils.builder.parameter.RoleParameterBuilder

Constructs a new builder that is a copy of the given builder.

S

scope - Variable in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

The command scope.

scope() - Method in interface dev.sympho.modular_commands.api.command.Command

The scope that the command is defined in.

scope() - Method in record class dev.sympho.modular_commands.impl.command.InteractionCommandImpl

Returns the value of the scope record component.

scope() - Method in record class dev.sympho.modular_commands.impl.command.MessageCommandImpl

Returns the value of the scope record component.

scope() - Method in record class dev.sympho.modular_commands.impl.command.SlashCommandImpl

Returns the value of the scope record component.

scope() - Method in record class dev.sympho.modular_commands.impl.command.TextCommandImpl

Returns the value of the scope record component.

self() - Method in interface dev.sympho.modular_commands.utils.builder.Builder

Retrieves this cast to the self type.

serverOwnerOnly - Variable in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Whether the command can only be run by the server's owner.

serverOwnerOnly() - Method in interface dev.sympho.modular_commands.api.command.Command

Whether this command can only be invoked by the owner of the server.

serverOwnerOnly() - Method in record class dev.sympho.modular_commands.impl.command.InteractionCommandImpl

Returns the value of the serverOwnerOnly record component.

serverOwnerOnly() - Method in record class dev.sympho.modular_commands.impl.command.MessageCommandImpl

Returns the value of the serverOwnerOnly record component.

serverOwnerOnly() - Method in record class dev.sympho.modular_commands.impl.command.SlashCommandImpl

Returns the value of the serverOwnerOnly record component.

serverOwnerOnly() - Method in record class dev.sympho.modular_commands.impl.command.TextCommandImpl

Returns the value of the serverOwnerOnly record component.

setBotOwnerOnly(boolean) - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Sets whether the command can only be run by the bot owner.

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 class dev.sympho.modular_commands.api.command.context.AnyCommandContext

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

setInheritSettings(boolean) - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Sets whether the command should inherit settings from the parent command.

setInvokeParent(boolean) - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Sets whether the command should also invoke the parent's handler.

setNsfw(boolean) - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Sets whether the command can only be run in channels marked as NSFW.

setPrefix(Snowflake, String) - Method in record class dev.sympho.modular_commands.execute.GuildPrefix

Sets a prefix override for a guild.

setPrivateReply(boolean) - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Sets whether the command response should be sent privately to the caller.

setRequireParentPermissions(boolean) - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Sets whether the command also require its parent command's permissions.

setServerOwnerOnly(boolean) - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Sets whether the command can only be run by the server owner.

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.

SlashCommand - Interface in dev.sympho.modular_commands.api.command

A slash command.

SlashCommandBuilder - Class in dev.sympho.modular_commands.utils.builder.command

A builder for a slash command.

SlashCommandBuilder() - Constructor for class dev.sympho.modular_commands.utils.builder.command.SlashCommandBuilder

Constructs a new builder with default values.

SlashCommandBuilder(SlashCommand) - Constructor for class dev.sympho.modular_commands.utils.builder.command.SlashCommandBuilder

Constructs a new builder that is initialized to make a copy of the given command.

SlashCommandBuilder(SlashCommandBuilder) - Constructor for class dev.sympho.modular_commands.utils.builder.command.SlashCommandBuilder

Constructs a new builder that is a copy of the given builder.

SlashCommandContext - Interface in dev.sympho.modular_commands.api.command.context

The execution context of an command invoked through a slash command.

SlashCommandImpl - Record Class in dev.sympho.modular_commands.impl.command

Default implementation of a slash command.

SlashCommandImpl(Command.Scope, boolean, Invocation, String, String, String, List<Parameter<?>>, PermissionSet, boolean, boolean, boolean, boolean, boolean, boolean, boolean, SlashInvocationHandler, List<? extends SlashResultHandler>) - Constructor for record class dev.sympho.modular_commands.impl.command.SlashCommandImpl

Initializes a new instance.

SlashInvocationHandler - Interface in dev.sympho.modular_commands.api.command.handler

A function that handles the execution of a slash command.

SlashResultHandler - Interface in dev.sympho.modular_commands.api.command.handler

A function that handles the result of a slash command.

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.

StringParameter - Record Class in dev.sympho.modular_commands.api.command.parameter

Specification for a string parameter.

StringParameter(String, String, boolean, String) - Constructor for record class dev.sympho.modular_commands.api.command.parameter.StringParameter

Creates a new instance with no value restrictions.

StringParameter(String, String, boolean, String, Map<String, String>) - Constructor for record class dev.sympho.modular_commands.api.command.parameter.StringParameter

Creates a new instance where the value is restricted to a set of values.

StringParameterBuilder - Class in dev.sympho.modular_commands.utils.builder.parameter

Builder for a string parameter.

StringParameterBuilder() - Constructor for class dev.sympho.modular_commands.utils.builder.parameter.StringParameterBuilder

Constructs a new builder with default values.

StringParameterBuilder(StringParameter) - Constructor for class dev.sympho.modular_commands.utils.builder.parameter.StringParameterBuilder

Constructs a new builder that is initialized to make a copy of the given parameter.

StringParameterBuilder(StringParameterBuilder) - Constructor for class dev.sympho.modular_commands.utils.builder.parameter.StringParameterBuilder

Constructs a new builder that is a copy of the given builder.

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.

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.

T

TextCommand - Interface in dev.sympho.modular_commands.api.command

A command that is invoked through any form of text (as opposed to a GUI element like a button).

TextCommandBuilder - Class in dev.sympho.modular_commands.utils.builder.command

A builder for a message command.

TextCommandBuilder() - Constructor for class dev.sympho.modular_commands.utils.builder.command.TextCommandBuilder

Constructs a new builder with default values.

TextCommandBuilder(TextCommand) - Constructor for class dev.sympho.modular_commands.utils.builder.command.TextCommandBuilder

Constructs a new builder that is initialized to make a copy of the given command.

TextCommandBuilder(TextCommandBuilder) - Constructor for class dev.sympho.modular_commands.utils.builder.command.TextCommandBuilder

Constructs a new builder that is a copy of the given builder.

TextCommandImpl - Record Class in dev.sympho.modular_commands.impl.command

Default implementation of a flexible command.

TextCommandImpl(Command.Scope, boolean, Invocation, String, String, Set<String>, String, List<Parameter<?>>, PermissionSet, boolean, boolean, boolean, boolean, boolean, boolean, boolean, AnyCommandHandler, List<? extends AnyResultHandler>) - Constructor for record class dev.sympho.modular_commands.impl.command.TextCommandImpl

Initializes a new instance.

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.ChannelParameter

Returns a string representation of this record class.

toString() - Method in record class dev.sympho.modular_commands.api.command.parameter.FloatParameter

Returns a string representation of this record class.

toString() - Method in record class dev.sympho.modular_commands.api.command.parameter.IntegerParameter

Returns a string representation of this record class.

toString() - Method in record class dev.sympho.modular_commands.api.command.parameter.MessageParameter

Returns a string representation of this record class.

toString() - Method in record class dev.sympho.modular_commands.api.command.parameter.RoleParameter

Returns a string representation of this record class.

toString() - Method in record class dev.sympho.modular_commands.api.command.parameter.StringParameter

Returns a string representation of this record class.

toString() - Method in record class dev.sympho.modular_commands.api.command.parameter.UserParameter

Returns a string representation of this record class.

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.UserMissingPermissions

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.StaticPrefix

Returns a string representation of this record class.

toString() - Method in record class dev.sympho.modular_commands.impl.command.InteractionCommandImpl

Returns a string representation of this record class.

toString() - Method in record class dev.sympho.modular_commands.impl.command.MessageCommandImpl

Returns a string representation of this record class.

toString() - Method in record class dev.sympho.modular_commands.impl.command.SlashCommandImpl

Returns a string representation of this record class.

toString() - Method in record class dev.sympho.modular_commands.impl.command.TextCommandImpl

Returns a string representation of this record class.

U

UserMissingPermissions - Record Class in dev.sympho.modular_commands.api.command.result

A failure result due to the user having insufficient permissions.

UserMissingPermissions(PermissionSet) - Constructor for record class dev.sympho.modular_commands.api.command.result.UserMissingPermissions

Creates an instance of a UserMissingPermissions record class.

UserParameter - Record Class in dev.sympho.modular_commands.api.command.parameter

Specification for a parameter that receives a Discord role.

UserParameter(String, String, boolean, User) - Constructor for record class dev.sympho.modular_commands.api.command.parameter.UserParameter

Creates a new instance.

UserParameterBuilder - Class in dev.sympho.modular_commands.utils.builder.parameter

Builder for a user parameter.

UserParameterBuilder() - Constructor for class dev.sympho.modular_commands.utils.builder.parameter.UserParameterBuilder

Constructs a new builder with default values.

UserParameterBuilder(UserParameter) - Constructor for class dev.sympho.modular_commands.utils.builder.parameter.UserParameterBuilder

Constructs a new builder that is initialized to make a copy of the given parameter.

UserParameterBuilder(UserParameterBuilder) - Constructor for class dev.sympho.modular_commands.utils.builder.parameter.UserParameterBuilder

Constructs a new builder that is a copy of the given builder.

V

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.

validateChoices(Map<String, T>) - Static method in class dev.sympho.modular_commands.utils.ParameterUtils

Validates the choices specified for a parameter, and returns them as a new, unmodifiable map.

validateCommand(C) - 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.

validateDiscordPermissions(PermissionSet) - Static method in class dev.sympho.modular_commands.utils.CommandUtils

Validates the required built-in permissions of a command.

validateDiscordPermissions(E, List<? extends Command>) - Method in class dev.sympho.modular_commands.execute.InvocationValidator

Validates that the user that invoked a command has sufficient built-in permissions to do so.

validateDisplayName(String) - Static method in class dev.sympho.modular_commands.utils.CommandUtils

Validates the display name of a command.

validateInvocationHandler(H) - 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.

validateResultHandlers(List<? extends H>) - 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.

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.

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.

W

withAliases(Set<String>) - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

withAliases(Set<String>) - Method in class dev.sympho.modular_commands.utils.builder.command.TextCommandBuilder

withCallable(boolean) - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Sets whether the command can be invoked directly.

withChoices(Map<String, ? extends String>) - Method in class dev.sympho.modular_commands.utils.builder.parameter.StringParameterBuilder

Sets the possible choices of the parameter to build.

withChoices(Map<String, ? extends Double>) - Method in class dev.sympho.modular_commands.utils.builder.parameter.FloatParameterBuilder

Sets the possible choices of the parameter to build.

withDefault(Channel) - Method in class dev.sympho.modular_commands.utils.builder.parameter.ChannelParameterBuilder

Sets the default value of the parameter to build.

withDescription(String) - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Sets the description of the command.

withDescription(String) - Method in class dev.sympho.modular_commands.utils.builder.parameter.ChannelParameterBuilder

Sets the description of the parameter to build.

withDisplayName(String) - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Sets the display name of the command.

withInvocationHandler(MessageInvocationHandler) - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Sets the invocation handler of the command.

withMaximum(Double) - Method in class dev.sympho.modular_commands.utils.builder.parameter.FloatParameterBuilder

Sets the maximum value of the parameter to build.

withMinimum(Double) - Method in class dev.sympho.modular_commands.utils.builder.parameter.FloatParameterBuilder

Sets the minimum value of the parameter to build.

withName(String) - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Sets the name of the command.

withName(String) - Method in class dev.sympho.modular_commands.utils.builder.parameter.ChannelParameterBuilder

Sets the name of the parameter to build.

withParameters(List<Parameter<?>>) - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Sets the parameters that a user should provide.

withParent(Invocation) - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Sets the parent command.

withRange(Double, Double) - Method in class dev.sympho.modular_commands.utils.builder.parameter.FloatParameterBuilder

Sets the valid range of the parameter to build.

withRequired(boolean) - Method in class dev.sympho.modular_commands.utils.builder.parameter.ChannelParameterBuilder

Sets the required flag of the parameter to build.

withResultHandlers(List<? extends MessageResultHandler>) - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Sets the handlers that should process the command result before any registry-defined ones.

withScope(Command.Scope) - Method in class dev.sympho.modular_commands.utils.builder.command.MessageCommandBuilder

Sets the command scope.

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