Index (command-core 0.3.1 API)

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

A

accepted() - Static method in record class io.github.hanielcota.commandframework.core.CommandResult: Creates an accepted result for asynchronous dispatch.
accepted() - Method in record class io.github.hanielcota.commandframework.core.cooldown.CooldownClaim: Returns the value of the accepted record component.
ACCEPTED - Enum constant in enum class io.github.hanielcota.commandframework.core.CommandStatus
actor() - Method in record class io.github.hanielcota.commandframework.core.CommandContext: Returns the value of the actor record component.
actor() - Method in record class io.github.hanielcota.commandframework.core.ParameterSuggestionContext: Returns the value of the actor record component.
actor() - Method in record class io.github.hanielcota.commandframework.core.SuggestionContext: Returns the value of the actor record component.
actorId() - Method in record class io.github.hanielcota.commandframework.core.cooldown.CooldownKey: Returns the value of the actorId record component.
ActorKind - Enum Class in io.github.hanielcota.commandframework.core: Classifies a CommandActor by its origin.
ActorMessageDebouncer - Class in io.github.hanielcota.commandframework.core.safety
ActorMessageDebouncer(Duration) - Constructor for class io.github.hanielcota.commandframework.core.safety.ActorMessageDebouncer
ActorMessageDebouncer(Duration, Clock) - Constructor for class io.github.hanielcota.commandframework.core.safety.ActorMessageDebouncer
ActorParameterResolver - Class in io.github.hanielcota.commandframework.core.argument
ActorParameterResolver() - Constructor for class io.github.hanielcota.commandframework.core.argument.ActorParameterResolver
after(CommandContext, CommandResult) - Method in interface io.github.hanielcota.commandframework.core.CommandInterceptor: Called after the executor runs.
aliases() - Method in record class io.github.hanielcota.commandframework.core.CommandRoot: Returns the value of the aliases record component.
aliases() - Method in class io.github.hanielcota.commandframework.core.CommandRoute
aliases(Set<String>) - Method in class io.github.hanielcota.commandframework.core.CommandRoute.Builder
allowed() - Static method in record class io.github.hanielcota.commandframework.core.cooldown.CooldownClaim
ALLOWED - Enum constant in enum class io.github.hanielcota.commandframework.core.rate.ThrottleDecision
allows(CommandActor) - Method in enum class io.github.hanielcota.commandframework.core.SenderRequirement: Checks whether the given actor satisfies this requirement.
ANY - Enum constant in enum class io.github.hanielcota.commandframework.core.SenderRequirement
apply(CommandRoute) - Method in class io.github.hanielcota.commandframework.core.config.ConfigurationOverlay: Returns a new route with configuration overrides applied.
ArgumentInput - Record Class in io.github.hanielcota.commandframework.core
ArgumentInput(String, String) - Constructor for record class io.github.hanielcota.commandframework.core.ArgumentInput: Creates an instance of a ArgumentInput record class.
ArgumentResolver<T> - Interface in io.github.hanielcota.commandframework.core: Resolves a single argument token into a typed value.
arguments() - Method in record class io.github.hanielcota.commandframework.core.CommandContext: Returns the value of the arguments record component.
arguments() - Method in record class io.github.hanielcota.commandframework.core.ParameterParseContext: Returns the value of the arguments record component.
arguments() - Method in record class io.github.hanielcota.commandframework.core.ParameterSuggestionContext: Returns the value of the arguments record component.
arguments() - Method in record class io.github.hanielcota.commandframework.core.RouteMatch: Returns the value of the arguments record component.
arguments() - Method in record class io.github.hanielcota.commandframework.core.safety.SanitizedInput: Returns the value of the arguments record component.
arguments() - Method in record class io.github.hanielcota.commandframework.core.SuggestionContext: Returns the value of the arguments record component.
arguments() - Method in record class io.github.hanielcota.commandframework.core.ValidationResult: Returns the value of the arguments record component.
async() - Method in class io.github.hanielcota.commandframework.core.CommandRoute: Whether this route should be executed asynchronously.
async(boolean) - Method in class io.github.hanielcota.commandframework.core.CommandRoute.Builder
asyncExecutor(Executor) - Method in class io.github.hanielcota.commandframework.core.CommandDispatcher.Builder
AutoHelpCommand - Class in io.github.hanielcota.commandframework.core.help: Auto-generated help command that lists available routes for an actor.

B

before(CommandContext) - Method in interface io.github.hanielcota.commandframework.core.CommandInterceptor: Called before the executor runs.
bool(String, String) - Method in interface io.github.hanielcota.commandframework.core.config.CommandConfiguration: Reads a boolean property for the given route key.
BooleanArgumentResolver - Record Class in io.github.hanielcota.commandframework.core.argument
BooleanArgumentResolver(Class<Boolean>) - Constructor for record class io.github.hanielcota.commandframework.core.argument.BooleanArgumentResolver: Creates an instance of a BooleanArgumentResolver record class.
build() - Method in class io.github.hanielcota.commandframework.core.CommandDispatcher.Builder
build() - Method in class io.github.hanielcota.commandframework.core.CommandRoute.Builder
builder() - Static method in class io.github.hanielcota.commandframework.core.CommandDispatcher
builder(String, CommandExecutor) - Static method in class io.github.hanielcota.commandframework.core.CommandRoute
Builder() - Constructor for class io.github.hanielcota.commandframework.core.CommandDispatcher.Builder

C

canonicalPath() - Method in class io.github.hanielcota.commandframework.core.CommandRoute
child(String) - Method in class io.github.hanielcota.commandframework.core.CommandNode
childLiteralsStartingWith(String) - Method in class io.github.hanielcota.commandframework.core.CommandNode
childOrCreate(String) - Method in class io.github.hanielcota.commandframework.core.CommandNode
claim(CommandActor, CommandRoute) - Method in class io.github.hanielcota.commandframework.core.cooldown.RouteCooldownStore
claim(String) - Method in class io.github.hanielcota.commandframework.core.rate.DispatchThrottle
clean(String) - Method in class io.github.hanielcota.commandframework.core.safety.SafeLogText
clearDefaultRoute() - Method in class io.github.hanielcota.commandframework.core.CommandNode
clearRoute() - Method in class io.github.hanielcota.commandframework.core.CommandNode
CommandActor - Interface in io.github.hanielcota.commandframework.core: Represents the entity executing a command.
CommandConfiguration - Interface in io.github.hanielcota.commandframework.core.config: Read-only view of external configuration that can override annotation defaults.
commandContext() - Method in record class io.github.hanielcota.commandframework.core.ParameterParseContext: Returns the value of the commandContext record component.
CommandContext - Record Class in io.github.hanielcota.commandframework.core: Immutable context available during command execution.
CommandContext(CommandActor, CommandRoute, String, List<String>) - Constructor for record class io.github.hanielcota.commandframework.core.CommandContext: Creates a context without parsed parameters (used before parsing).
CommandContext(CommandActor, CommandRoute, String, List<String>, Map<String, ParsedParameter<?>>) - Constructor for record class io.github.hanielcota.commandframework.core.CommandContext: Creates an instance of a CommandContext record class.
CommandDispatcher - Class in io.github.hanielcota.commandframework.core: Central entry-point for command registration, dispatch and tab-completion.
CommandDispatcher.Builder - Class in io.github.hanielcota.commandframework.core
CommandDispatchStage - Interface in io.github.hanielcota.commandframework.core.pipeline: A single stage in the command dispatch pipeline.
CommandException - Exception Class in io.github.hanielcota.commandframework.core: Base exception for all framework-specific runtime failures.
CommandException(String) - Constructor for exception class io.github.hanielcota.commandframework.core.CommandException
CommandException(String, Throwable) - Constructor for exception class io.github.hanielcota.commandframework.core.CommandException
CommandExecutor - Interface in io.github.hanielcota.commandframework.core: Functional interface for the business logic of a command route.
CommandInterceptor - Interface in io.github.hanielcota.commandframework.core: Interceptor that hooks into the command dispatch pipeline.
CommandLiteralNormalizer - Class in io.github.hanielcota.commandframework.core.route
CommandLiteralNormalizer() - Constructor for class io.github.hanielcota.commandframework.core.route.CommandLiteralNormalizer
CommandLogger - Interface in io.github.hanielcota.commandframework.core: Lightweight logging abstraction used by the framework.
CommandMessageProvider - Interface in io.github.hanielcota.commandframework.core: Provides human-readable messages for every dispatch outcome.
CommandMessenger - Class in io.github.hanielcota.commandframework.core: Encapsulates message formatting and debounced delivery to actors.
CommandMessenger(CommandMessageProvider, ActorMessageDebouncer) - Constructor for class io.github.hanielcota.commandframework.core.CommandMessenger
CommandMetrics - Interface in io.github.hanielcota.commandframework.core.metrics: Lightweight metrics abstraction for command dispatch observability.
CommandNode - Class in io.github.hanielcota.commandframework.core
CommandNode(String) - Constructor for class io.github.hanielcota.commandframework.core.CommandNode
CommandParameter<T> - Record Class in io.github.hanielcota.commandframework.core: Describes a single parameter of a command route.
CommandParameter(String, Class<T>, ParameterResolver<T>, boolean) - Constructor for record class io.github.hanielcota.commandframework.core.CommandParameter: Creates an instance of a CommandParameter record class.
CommandParameterParser - Class in io.github.hanielcota.commandframework.core.dispatch
CommandParameterParser() - Constructor for class io.github.hanielcota.commandframework.core.dispatch.CommandParameterParser
CommandResult - Record Class in io.github.hanielcota.commandframework.core: Immutable result of a command execution or pipeline stage.
CommandResult(CommandStatus, String, Duration) - Constructor for record class io.github.hanielcota.commandframework.core.CommandResult: Creates an instance of a CommandResult record class.
CommandRoot - Record Class in io.github.hanielcota.commandframework.core: Represents a registered root command together with its aliases and the root CommandNode of the literal tree.
CommandRoot(String, Set<String>, CommandNode) - Constructor for record class io.github.hanielcota.commandframework.core.CommandRoot: Creates an instance of a CommandRoot record class.
CommandRoute - Class in io.github.hanielcota.commandframework.core: Immutable definition of a command route.
CommandRoute.Builder - Class in io.github.hanielcota.commandframework.core
CommandRouteRegistry - Class in io.github.hanielcota.commandframework.core
CommandRouteRegistry() - Constructor for class io.github.hanielcota.commandframework.core.CommandRouteRegistry
CommandStatus - Enum Class in io.github.hanielcota.commandframework.core: Outcome status of a command dispatch.
CommandSuggestionEngine - Record Class in io.github.hanielcota.commandframework.core.suggestion
CommandSuggestionEngine(RouteResolver) - Constructor for record class io.github.hanielcota.commandframework.core.suggestion.CommandSuggestionEngine: Creates an instance of a CommandSuggestionEngine record class.
configuration(CommandConfiguration) - Method in class io.github.hanielcota.commandframework.core.CommandDispatcher.Builder
ConfigurationOverlay - Class in io.github.hanielcota.commandframework.core.config: Applies CommandConfiguration overrides to a CommandRoute.
ConfigurationOverlay(CommandConfiguration) - Constructor for class io.github.hanielcota.commandframework.core.config.ConfigurationOverlay
CONSOLE - Enum constant in enum class io.github.hanielcota.commandframework.core.ActorKind
CONSOLE - Enum constant in enum class io.github.hanielcota.commandframework.core.SenderRequirement
consumedLiterals() - Method in record class io.github.hanielcota.commandframework.core.RouteCursor: Returns the value of the consumedLiterals record component.
consumedLiterals() - Method in record class io.github.hanielcota.commandframework.core.RouteMatch: Returns the value of the consumedLiterals record component.
consumedTokens() - Method in interface io.github.hanielcota.commandframework.core.ParseResult
consumedTokens() - Method in record class io.github.hanielcota.commandframework.core.ParseResult.Success: Returns the value of the consumedTokens record component.
consumesInput() - Method in class io.github.hanielcota.commandframework.core.argument.ActorParameterResolver
consumesInput() - Method in class io.github.hanielcota.commandframework.core.argument.DefaultValueResolver
consumesInput() - Method in class io.github.hanielcota.commandframework.core.argument.GreedyStringParameterResolver
consumesInput() - Method in class io.github.hanielcota.commandframework.core.argument.RawArgumentsParameterResolver
consumesInput() - Method in record class io.github.hanielcota.commandframework.core.argument.SingleArgumentParameterResolver
consumesInput() - Method in record class io.github.hanielcota.commandframework.core.CommandParameter: Whether this parameter consumes tokens from the argument list.
consumesInput() - Method in interface io.github.hanielcota.commandframework.core.ParameterResolver: Whether this resolver consumes tokens from the argument list.
cooldown() - Method in class io.github.hanielcota.commandframework.core.CommandRoute
cooldown(CommandContext, Duration) - Method in interface io.github.hanielcota.commandframework.core.CommandMessageProvider
cooldown(CommandContext, Duration) - Method in class io.github.hanielcota.commandframework.core.CommandMessenger
cooldown(CommandContext, Duration) - Method in class io.github.hanielcota.commandframework.core.message.DefaultCommandMessageProvider
cooldown(Duration) - Static method in record class io.github.hanielcota.commandframework.core.CommandResult: Creates a cooldown result with the remaining duration.
cooldown(Duration) - Method in class io.github.hanielcota.commandframework.core.CommandRoute.Builder
COOLDOWN - Enum constant in enum class io.github.hanielcota.commandframework.core.CommandStatus
CooldownClaim - Record Class in io.github.hanielcota.commandframework.core.cooldown
CooldownClaim(boolean, Duration) - Constructor for record class io.github.hanielcota.commandframework.core.cooldown.CooldownClaim: Creates an instance of a CooldownClaim record class.
CooldownKey - Record Class in io.github.hanielcota.commandframework.core.cooldown
CooldownKey(String, String) - Constructor for record class io.github.hanielcota.commandframework.core.cooldown.CooldownKey: Creates an instance of a CooldownKey record class.
cooldownStore(RouteCooldownStore) - Method in class io.github.hanielcota.commandframework.core.CommandDispatcher.Builder
create(String, RouteResolver) - Static method in class io.github.hanielcota.commandframework.core.help.AutoHelpCommand: Creates a help route for the given root label.
currentInput() - Method in record class io.github.hanielcota.commandframework.core.ParameterSuggestionContext: Returns the value of the currentInput record component.
currentInput() - Method in record class io.github.hanielcota.commandframework.core.SuggestionContext: Returns the value of the currentInput record component.

D

debug(String) - Method in interface io.github.hanielcota.commandframework.core.CommandLogger: Logs a debug message (useful for development).
DefaultCommandMessageProvider - Class in io.github.hanielcota.commandframework.core.message
DefaultCommandMessageProvider() - Constructor for class io.github.hanielcota.commandframework.core.message.DefaultCommandMessageProvider
defaultRoute() - Method in class io.github.hanielcota.commandframework.core.CommandNode
DefaultValueResolver<T> - Class in io.github.hanielcota.commandframework.core.argument: Wraps another resolver and returns a default value when the caller omits the argument.
DefaultValueResolver(ParameterResolver<T>, String) - Constructor for class io.github.hanielcota.commandframework.core.argument.DefaultValueResolver
denied(Duration) - Static method in record class io.github.hanielcota.commandframework.core.cooldown.CooldownClaim
DENIED - Enum constant in enum class io.github.hanielcota.commandframework.core.rate.ThrottleDecision
description() - Method in class io.github.hanielcota.commandframework.core.CommandRoute: Returns the human-readable description, or empty string if none.
description(String) - Method in class io.github.hanielcota.commandframework.core.CommandRoute.Builder
detail() - Method in record class io.github.hanielcota.commandframework.core.CommandResult: Returns the detail text if non-blank.
detailText() - Method in record class io.github.hanielcota.commandframework.core.CommandResult: Returns the value of the detailText record component.
dispatch(CommandActor, String, String[]) - Method in class io.github.hanielcota.commandframework.core.CommandDispatcher
dispatch(CommandActor, String, List<String>) - Method in class io.github.hanielcota.commandframework.core.CommandDispatcher
DispatchContinuation - Interface in io.github.hanielcota.commandframework.core.pipeline: Represents the remaining stages in the dispatch pipeline.
DispatchThrottle - Class in io.github.hanielcota.commandframework.core.rate
DispatchThrottle(int, Duration) - Constructor for class io.github.hanielcota.commandframework.core.rate.DispatchThrottle
DispatchThrottle(int, Duration, Clock) - Constructor for class io.github.hanielcota.commandframework.core.rate.DispatchThrottle
DoubleArgumentResolver - Record Class in io.github.hanielcota.commandframework.core.argument
DoubleArgumentResolver(Class<Double>) - Constructor for record class io.github.hanielcota.commandframework.core.argument.DoubleArgumentResolver: Creates an instance of a DoubleArgumentResolver record class.
duration(String, String) - Method in interface io.github.hanielcota.commandframework.core.config.CommandConfiguration: Reads a duration property for the given route key.

E

empty() - Static method in interface io.github.hanielcota.commandframework.core.config.CommandConfiguration: Returns a configuration that yields empty for every query.
EnumArgumentResolver<T> - Record Class in io.github.hanielcota.commandframework.core
EnumArgumentResolver(Class<T>) - Constructor for record class io.github.hanielcota.commandframework.core.EnumArgumentResolver: Creates an instance of a EnumArgumentResolver record class.
enumType() - Method in record class io.github.hanielcota.commandframework.core.EnumArgumentResolver: Returns the value of the enumType record component.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.argument.BooleanArgumentResolver: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.argument.DoubleArgumentResolver: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.argument.IntegerArgumentResolver: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.argument.LongArgumentResolver: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.argument.SingleArgumentParameterResolver: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.ArgumentInput: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.CommandContext: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.CommandParameter: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.CommandResult: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.CommandRoot: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.cooldown.CooldownClaim: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.cooldown.CooldownKey: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.dispatch.ParameterParseFailure: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.dispatch.ParameterParseOutcome.Failure: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.dispatch.ParameterParseOutcome.Success: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.EnumArgumentResolver: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.ParameterParseContext: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.ParameterSuggestionContext: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.ParsedParameter: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.ParseResult.Failure: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.ParseResult.Success: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.RouteCursor: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.RouteMatch: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.RouteResolution.Found: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.RouteResolution.NotFound: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.safety.InputSanitizer: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.safety.SanitizedInput: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.suggestion.CommandSuggestionEngine: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.SuggestionContext: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.hanielcota.commandframework.core.ValidationResult: Indicates whether some other object is "equal to" this one.
ERROR - Enum constant in enum class io.github.hanielcota.commandframework.core.CommandStatus
execute(CommandContext, List<ParsedParameter<?>>) - Method in interface io.github.hanielcota.commandframework.core.CommandExecutor: Executes the command logic.
execute(CommandContext, List<ParsedParameter<?>>) - Method in class io.github.hanielcota.commandframework.core.help.AutoHelpCommand
ExecutionStage - Class in io.github.hanielcota.commandframework.core.pipeline: Parses parameters and invokes the executor, including interceptors.
ExecutionStage(CommandParameterParser, UsageFormatter, CommandMessenger, List<CommandInterceptor>, CommandLogger, SafeLogText) - Constructor for class io.github.hanielcota.commandframework.core.pipeline.ExecutionStage
executor() - Method in class io.github.hanielcota.commandframework.core.CommandRoute
expectedValue() - Method in record class io.github.hanielcota.commandframework.core.dispatch.ParameterParseFailure: Returns the value of the expectedValue record component.
expectedValue() - Method in interface io.github.hanielcota.commandframework.core.ParseResult
expectedValue() - Method in record class io.github.hanielcota.commandframework.core.ParseResult.Failure: Returns the value of the expectedValue record component.
expectedValue() - Method in interface io.github.hanielcota.commandframework.core.RouteResolution
expectedValue() - Method in record class io.github.hanielcota.commandframework.core.RouteResolution.NotFound: Returns the value of the expectedValue record component.
expectedValue() - Method in record class io.github.hanielcota.commandframework.core.safety.SanitizedInput: Returns the value of the expectedValue record component.
expectedValue() - Method in record class io.github.hanielcota.commandframework.core.ValidationResult: Returns the value of the expectedValue record component.

F

failure() - Method in interface io.github.hanielcota.commandframework.core.dispatch.ParameterParseOutcome
failure() - Method in record class io.github.hanielcota.commandframework.core.dispatch.ParameterParseOutcome.Failure
failure(CommandStatus) - Static method in record class io.github.hanielcota.commandframework.core.CommandResult: Creates a failure result without detail text.
failure(CommandStatus, String) - Static method in record class io.github.hanielcota.commandframework.core.CommandResult: Creates a failure result with detail text.
failure(String, String) - Static method in interface io.github.hanielcota.commandframework.core.dispatch.ParameterParseOutcome
failure(String, String) - Static method in interface io.github.hanielcota.commandframework.core.ParseResult
Failure(ParameterParseFailure) - Constructor for record class io.github.hanielcota.commandframework.core.dispatch.ParameterParseOutcome.Failure: Creates an instance of a Failure record class.
Failure(String, String) - Constructor for record class io.github.hanielcota.commandframework.core.ParseResult.Failure: Creates an instance of a Failure record class.
FAILURE - Enum constant in enum class io.github.hanielcota.commandframework.core.CommandStatus
failureValue() - Method in record class io.github.hanielcota.commandframework.core.dispatch.ParameterParseOutcome.Failure: Returns the value of the failureValue record component.
find(Class<T>) - Method in class io.github.hanielcota.commandframework.core.ParameterResolverRegistry
format(CommandRoute) - Method in class io.github.hanielcota.commandframework.core.usage.UsageFormatter
found(RouteMatch) - Static method in interface io.github.hanielcota.commandframework.core.RouteResolution
Found(RouteMatch) - Constructor for record class io.github.hanielcota.commandframework.core.RouteResolution.Found: Creates an instance of a Found record class.
fromDefault(CommandNode) - Static method in record class io.github.hanielcota.commandframework.core.RouteCursor

G

GreedyStringParameterResolver - Class in io.github.hanielcota.commandframework.core.argument: Resolves a String by consuming all remaining argument tokens joined by a single space.
GreedyStringParameterResolver() - Constructor for class io.github.hanielcota.commandframework.core.argument.GreedyStringParameterResolver
GuardStage - Class in io.github.hanielcota.commandframework.core.pipeline: Guards the dispatch: permission, sender requirement, cooldown.
GuardStage(RouteCooldownStore, CommandMessenger, CommandLogger) - Constructor for class io.github.hanielcota.commandframework.core.pipeline.GuardStage

H

hasCooldown() - Method in class io.github.hanielcota.commandframework.core.CommandRoute
hashCode() - Method in record class io.github.hanielcota.commandframework.core.argument.BooleanArgumentResolver: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.argument.DoubleArgumentResolver: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.argument.IntegerArgumentResolver: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.argument.LongArgumentResolver: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.argument.SingleArgumentParameterResolver: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.ArgumentInput: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.CommandContext: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.CommandParameter: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.CommandResult: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.CommandRoot: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.cooldown.CooldownClaim: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.cooldown.CooldownKey: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.dispatch.ParameterParseFailure: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.dispatch.ParameterParseOutcome.Failure: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.dispatch.ParameterParseOutcome.Success: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.EnumArgumentResolver: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.ParameterParseContext: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.ParameterSuggestionContext: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.ParsedParameter: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.ParseResult.Failure: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.ParseResult.Success: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.RouteCursor: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.RouteMatch: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.RouteResolution.Found: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.RouteResolution.NotFound: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.safety.InputSanitizer: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.safety.SanitizedInput: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.suggestion.CommandSuggestionEngine: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.SuggestionContext: Returns a hash code value for this object.
hashCode() - Method in record class io.github.hanielcota.commandframework.core.ValidationResult: Returns a hash code value for this object.
hasPermission() - Method in class io.github.hanielcota.commandframework.core.CommandRoute
hasPermission(String) - Method in interface io.github.hanielcota.commandframework.core.CommandActor: Checks whether this actor has the given permission.

I

increment(String, Map<String, String>) - Method in interface io.github.hanielcota.commandframework.core.metrics.CommandMetrics: Increments a counter by one.
index() - Method in record class io.github.hanielcota.commandframework.core.ParameterParseContext: Returns the value of the index record component.
InputSanitizer - Record Class in io.github.hanielcota.commandframework.core.safety
InputSanitizer(int, int) - Constructor for record class io.github.hanielcota.commandframework.core.safety.InputSanitizer: Creates an instance of a InputSanitizer record class.
INSTANCE - Static variable in class io.github.hanielcota.commandframework.core.pipeline.TerminalContinuation
IntegerArgumentResolver - Record Class in io.github.hanielcota.commandframework.core.argument
IntegerArgumentResolver(Class<Integer>) - Constructor for record class io.github.hanielcota.commandframework.core.argument.IntegerArgumentResolver: Creates an instance of a IntegerArgumentResolver record class.
interceptor(CommandInterceptor) - Method in class io.github.hanielcota.commandframework.core.CommandDispatcher.Builder
interceptor(CommandInterceptor) - Method in class io.github.hanielcota.commandframework.core.CommandRoute.Builder
interceptors() - Method in class io.github.hanielcota.commandframework.core.CommandRoute: Returns interceptors scoped to this route.
internalError(CommandContext) - Method in interface io.github.hanielcota.commandframework.core.CommandMessageProvider
internalError(CommandContext) - Method in class io.github.hanielcota.commandframework.core.CommandMessenger
internalError(CommandContext) - Method in class io.github.hanielcota.commandframework.core.message.DefaultCommandMessageProvider
invalid(String, String) - Static method in record class io.github.hanielcota.commandframework.core.safety.SanitizedInput
invalid(String, String) - Static method in record class io.github.hanielcota.commandframework.core.ValidationResult
INVALID_SENDER - Enum constant in enum class io.github.hanielcota.commandframework.core.CommandStatus
INVALID_USAGE - Enum constant in enum class io.github.hanielcota.commandframework.core.CommandStatus
invalidInput(CommandActor, String, String) - Method in interface io.github.hanielcota.commandframework.core.CommandMessageProvider
invalidInput(CommandActor, String, String) - Method in class io.github.hanielcota.commandframework.core.CommandMessenger
invalidInput(CommandActor, String, String) - Method in class io.github.hanielcota.commandframework.core.message.DefaultCommandMessageProvider
invalidSender(CommandContext) - Method in class io.github.hanielcota.commandframework.core.CommandMessenger
invalidSender(CommandContext, SenderRequirement) - Method in interface io.github.hanielcota.commandframework.core.CommandMessageProvider
invalidSender(CommandContext, SenderRequirement) - Method in class io.github.hanielcota.commandframework.core.message.DefaultCommandMessageProvider
invalidUsage(CommandContext, String) - Method in interface io.github.hanielcota.commandframework.core.CommandMessageProvider
invalidUsage(CommandContext, String) - Method in class io.github.hanielcota.commandframework.core.CommandMessenger
invalidUsage(CommandContext, String) - Method in class io.github.hanielcota.commandframework.core.message.DefaultCommandMessageProvider
invalidValue() - Method in record class io.github.hanielcota.commandframework.core.dispatch.ParameterParseFailure: Returns the value of the invalidValue record component.
invalidValue() - Method in record class io.github.hanielcota.commandframework.core.ParseResult.Failure: Returns the value of the invalidValue record component.
invalidValue() - Method in interface io.github.hanielcota.commandframework.core.ParseResult
invalidValue() - Method in interface io.github.hanielcota.commandframework.core.RouteResolution
invalidValue() - Method in record class io.github.hanielcota.commandframework.core.RouteResolution.NotFound: Returns the value of the invalidValue record component.
invalidValue() - Method in record class io.github.hanielcota.commandframework.core.safety.SanitizedInput: Returns the value of the invalidValue record component.
invalidValue() - Method in record class io.github.hanielcota.commandframework.core.ValidationResult: Returns the value of the invalidValue record component.
io.github.hanielcota.commandframework.core - module io.github.hanielcota.commandframework.core
io.github.hanielcota.commandframework.core - package io.github.hanielcota.commandframework.core: Platform-agnostic command core.
io.github.hanielcota.commandframework.core.argument - package io.github.hanielcota.commandframework.core.argument
io.github.hanielcota.commandframework.core.config - package io.github.hanielcota.commandframework.core.config
io.github.hanielcota.commandframework.core.cooldown - package io.github.hanielcota.commandframework.core.cooldown
io.github.hanielcota.commandframework.core.dispatch - package io.github.hanielcota.commandframework.core.dispatch
io.github.hanielcota.commandframework.core.help - package io.github.hanielcota.commandframework.core.help
io.github.hanielcota.commandframework.core.message - package io.github.hanielcota.commandframework.core.message
io.github.hanielcota.commandframework.core.metrics - package io.github.hanielcota.commandframework.core.metrics
io.github.hanielcota.commandframework.core.pipeline - package io.github.hanielcota.commandframework.core.pipeline
io.github.hanielcota.commandframework.core.rate - package io.github.hanielcota.commandframework.core.rate
io.github.hanielcota.commandframework.core.route - package io.github.hanielcota.commandframework.core.route
io.github.hanielcota.commandframework.core.safety - package io.github.hanielcota.commandframework.core.safety
io.github.hanielcota.commandframework.core.suggestion - package io.github.hanielcota.commandframework.core.suggestion
io.github.hanielcota.commandframework.core.usage - package io.github.hanielcota.commandframework.core.usage
isAllowed() - Method in record class io.github.hanielcota.commandframework.core.cooldown.CooldownClaim
isConsole() - Method in interface io.github.hanielcota.commandframework.core.CommandActor: Convenience method equivalent to kind() == ActorKind.CONSOLE.
isEmpty() - Method in class io.github.hanielcota.commandframework.core.CommandNode
isFound() - Method in record class io.github.hanielcota.commandframework.core.RouteResolution.Found
isFound() - Method in interface io.github.hanielcota.commandframework.core.RouteResolution
isFound() - Method in record class io.github.hanielcota.commandframework.core.RouteResolution.NotFound
isPlayer() - Method in interface io.github.hanielcota.commandframework.core.CommandActor: Convenience method equivalent to kind() == ActorKind.PLAYER.
isRateLimited() - Method in record class io.github.hanielcota.commandframework.core.ValidationResult
isSuccess() - Method in record class io.github.hanielcota.commandframework.core.CommandResult: Whether this result represents a successful execution.
isSuccess() - Method in record class io.github.hanielcota.commandframework.core.dispatch.ParameterParseOutcome.Failure
isSuccess() - Method in interface io.github.hanielcota.commandframework.core.dispatch.ParameterParseOutcome
isSuccess() - Method in record class io.github.hanielcota.commandframework.core.dispatch.ParameterParseOutcome.Success
isSuccess() - Method in record class io.github.hanielcota.commandframework.core.ParseResult.Failure
isSuccess() - Method in interface io.github.hanielcota.commandframework.core.ParseResult
isSuccess() - Method in record class io.github.hanielcota.commandframework.core.ParseResult.Success
isValid() - Method in record class io.github.hanielcota.commandframework.core.safety.SanitizedInput
isValid() - Method in record class io.github.hanielcota.commandframework.core.ValidationResult

K

kind() - Method in interface io.github.hanielcota.commandframework.core.CommandActor: Returns the kind of actor (player, console, or other).

L

label() - Method in record class io.github.hanielcota.commandframework.core.CommandContext: Returns the value of the label record component.
label() - Method in record class io.github.hanielcota.commandframework.core.CommandRoot: Returns the value of the label record component.
literal() - Method in class io.github.hanielcota.commandframework.core.CommandNode
logger() - Method in class io.github.hanielcota.commandframework.core.CommandDispatcher
logger(CommandLogger) - Method in class io.github.hanielcota.commandframework.core.CommandDispatcher.Builder
LongArgumentResolver - Record Class in io.github.hanielcota.commandframework.core.argument
LongArgumentResolver(Class<Long>) - Constructor for record class io.github.hanielcota.commandframework.core.argument.LongArgumentResolver: Creates an instance of a LongArgumentResolver record class.

M

match() - Method in record class io.github.hanielcota.commandframework.core.RouteResolution.Found
match() - Method in interface io.github.hanielcota.commandframework.core.RouteResolution
matchValue() - Method in record class io.github.hanielcota.commandframework.core.RouteResolution.Found: Returns the value of the matchValue record component.
maxArgumentLength() - Method in record class io.github.hanielcota.commandframework.core.safety.InputSanitizer: Returns the value of the maxArgumentLength record component.
maxArguments() - Method in record class io.github.hanielcota.commandframework.core.safety.InputSanitizer: Returns the value of the maxArguments record component.
messageProvider(CommandMessageProvider) - Method in class io.github.hanielcota.commandframework.core.CommandDispatcher.Builder
metrics(CommandMetrics) - Method in class io.github.hanielcota.commandframework.core.CommandDispatcher.Builder

N

name() - Method in interface io.github.hanielcota.commandframework.core.CommandActor: Returns the display name of this actor.
name() - Method in record class io.github.hanielcota.commandframework.core.CommandParameter: Returns the value of the name record component.
next(CommandNode, int) - Method in record class io.github.hanielcota.commandframework.core.RouteCursor
NO_PERMISSION - Enum constant in enum class io.github.hanielcota.commandframework.core.CommandStatus
node() - Method in record class io.github.hanielcota.commandframework.core.CommandRoot: Returns the value of the node record component.
noop() - Static method in interface io.github.hanielcota.commandframework.core.CommandLogger: Returns a logger that discards all output.
noop() - Static method in interface io.github.hanielcota.commandframework.core.metrics.CommandMetrics: Returns a metrics instance that discards all recordings.
noPermission(CommandContext) - Method in class io.github.hanielcota.commandframework.core.CommandMessenger
noPermission(CommandContext, String) - Method in interface io.github.hanielcota.commandframework.core.CommandMessageProvider
noPermission(CommandContext, String) - Method in class io.github.hanielcota.commandframework.core.message.DefaultCommandMessageProvider
normalize(String) - Method in class io.github.hanielcota.commandframework.core.route.CommandLiteralNormalizer
NOT_FOUND - Enum constant in enum class io.github.hanielcota.commandframework.core.CommandStatus
notFound(String, String) - Static method in interface io.github.hanielcota.commandframework.core.RouteResolution
NotFound(String, String) - Constructor for record class io.github.hanielcota.commandframework.core.RouteResolution.NotFound: Creates an instance of a NotFound record class.
notifyParseFailure(CommandContext, String, String) - Method in class io.github.hanielcota.commandframework.core.CommandMessenger

O

OTHER - Enum constant in enum class io.github.hanielcota.commandframework.core.ActorKind

P

parameter() - Method in record class io.github.hanielcota.commandframework.core.ParameterParseContext: Returns the value of the parameter record component.
parameter() - Method in record class io.github.hanielcota.commandframework.core.ParameterSuggestionContext: Returns the value of the parameter record component.
parameter() - Method in record class io.github.hanielcota.commandframework.core.ParsedParameter: Returns the value of the parameter record component.
parameterName() - Method in record class io.github.hanielcota.commandframework.core.ArgumentInput: Returns the value of the parameterName record component.
ParameterParseContext - Record Class in io.github.hanielcota.commandframework.core
ParameterParseContext(CommandContext, CommandParameter<?>, List<String>, int) - Constructor for record class io.github.hanielcota.commandframework.core.ParameterParseContext: Creates an instance of a ParameterParseContext record class.
ParameterParseFailure - Record Class in io.github.hanielcota.commandframework.core.dispatch
ParameterParseFailure(String, String) - Constructor for record class io.github.hanielcota.commandframework.core.dispatch.ParameterParseFailure: Creates an instance of a ParameterParseFailure record class.
ParameterParseOutcome - Interface in io.github.hanielcota.commandframework.core.dispatch
ParameterParseOutcome.Failure - Record Class in io.github.hanielcota.commandframework.core.dispatch
ParameterParseOutcome.Success - Record Class in io.github.hanielcota.commandframework.core.dispatch
ParameterResolver<T> - Interface in io.github.hanielcota.commandframework.core: Resolves a method parameter from the raw command arguments.
ParameterResolverRegistry - Class in io.github.hanielcota.commandframework.core
ParameterResolverRegistry() - Constructor for class io.github.hanielcota.commandframework.core.ParameterResolverRegistry
parameters() - Method in class io.github.hanielcota.commandframework.core.CommandRoute
parameters() - Method in interface io.github.hanielcota.commandframework.core.dispatch.ParameterParseOutcome
parameters() - Method in record class io.github.hanielcota.commandframework.core.dispatch.ParameterParseOutcome.Success: Returns the value of the parameters record component.
parameters(List<CommandParameter<?>>) - Method in class io.github.hanielcota.commandframework.core.CommandRoute.Builder
ParameterSuggestionContext - Record Class in io.github.hanielcota.commandframework.core
ParameterSuggestionContext(CommandActor, CommandRoute, CommandParameter<?>, String, List<String>) - Constructor for record class io.github.hanielcota.commandframework.core.ParameterSuggestionContext: Creates an instance of a ParameterSuggestionContext record class.
parse(ArgumentInput) - Method in record class io.github.hanielcota.commandframework.core.argument.BooleanArgumentResolver
parse(ArgumentInput) - Method in record class io.github.hanielcota.commandframework.core.argument.DoubleArgumentResolver
parse(ArgumentInput) - Method in record class io.github.hanielcota.commandframework.core.argument.IntegerArgumentResolver
parse(ArgumentInput) - Method in record class io.github.hanielcota.commandframework.core.argument.LongArgumentResolver
parse(ArgumentInput) - Method in class io.github.hanielcota.commandframework.core.argument.StringArgumentResolver
parse(ArgumentInput) - Method in interface io.github.hanielcota.commandframework.core.ArgumentResolver: Parses a single raw argument token.
parse(ArgumentInput) - Method in record class io.github.hanielcota.commandframework.core.EnumArgumentResolver
parse(CommandContext) - Method in class io.github.hanielcota.commandframework.core.dispatch.CommandParameterParser
parsedParameter(String) - Method in record class io.github.hanielcota.commandframework.core.CommandContext: Looks up a parsed parameter by its declared name.
ParsedParameter<T> - Record Class in io.github.hanielcota.commandframework.core
ParsedParameter(CommandParameter<T>, T) - Constructor for record class io.github.hanielcota.commandframework.core.ParsedParameter: Creates an instance of a ParsedParameter record class.
parsedParameters() - Method in record class io.github.hanielcota.commandframework.core.CommandContext: Returns the value of the parsedParameters record component.
parseFailure(CommandContext, String, String) - Method in interface io.github.hanielcota.commandframework.core.CommandMessageProvider
parseFailure(CommandContext, String, String) - Method in class io.github.hanielcota.commandframework.core.message.DefaultCommandMessageProvider
ParseResult<T> - Interface in io.github.hanielcota.commandframework.core
ParseResult.Failure<T> - Record Class in io.github.hanielcota.commandframework.core
ParseResult.Success<T> - Record Class in io.github.hanielcota.commandframework.core
path() - Method in class io.github.hanielcota.commandframework.core.CommandRoute
path(List<String>) - Method in class io.github.hanielcota.commandframework.core.CommandRoute.Builder
permission() - Method in class io.github.hanielcota.commandframework.core.CommandRoute
permission(String) - Method in class io.github.hanielcota.commandframework.core.CommandRoute.Builder
PLAYER - Enum constant in enum class io.github.hanielcota.commandframework.core.ActorKind
PLAYER - Enum constant in enum class io.github.hanielcota.commandframework.core.SenderRequirement
PreDispatchValidator - Class in io.github.hanielcota.commandframework.core
PreDispatchValidator(DispatchThrottle, InputSanitizer) - Constructor for class io.github.hanielcota.commandframework.core.PreDispatchValidator
proceed(CommandContext) - Method in interface io.github.hanielcota.commandframework.core.pipeline.DispatchContinuation
proceed(CommandContext) - Method in class io.github.hanielcota.commandframework.core.pipeline.TerminalContinuation
process(CommandContext, DispatchContinuation) - Method in interface io.github.hanielcota.commandframework.core.pipeline.CommandDispatchStage: Processes the context and either returns a result or delegates to the next stage.
process(CommandContext, DispatchContinuation) - Method in class io.github.hanielcota.commandframework.core.pipeline.ExecutionStage
process(CommandContext, DispatchContinuation) - Method in class io.github.hanielcota.commandframework.core.pipeline.GuardStage

R

RATE_LIMITED - Enum constant in enum class io.github.hanielcota.commandframework.core.CommandStatus
rateLimited() - Method in record class io.github.hanielcota.commandframework.core.ValidationResult: Returns the value of the rateLimited record component.
rateLimited(CommandActor) - Method in interface io.github.hanielcota.commandframework.core.CommandMessageProvider
rateLimited(CommandActor) - Method in class io.github.hanielcota.commandframework.core.CommandMessenger
rateLimited(CommandActor) - Method in class io.github.hanielcota.commandframework.core.message.DefaultCommandMessageProvider
RawArgumentsParameterResolver - Class in io.github.hanielcota.commandframework.core.argument
RawArgumentsParameterResolver() - Constructor for class io.github.hanielcota.commandframework.core.argument.RawArgumentsParameterResolver
rawValue() - Method in record class io.github.hanielcota.commandframework.core.ArgumentInput: Returns the value of the rawValue record component.
record(String, Map<String, String>, Duration) - Method in interface io.github.hanielcota.commandframework.core.metrics.CommandMetrics: Records a timer value.
register(CommandRoute) - Method in class io.github.hanielcota.commandframework.core.CommandDispatcher
register(CommandRoute) - Method in class io.github.hanielcota.commandframework.core.CommandRouteRegistry
register(ParameterResolver<T>) - Method in class io.github.hanielcota.commandframework.core.ParameterResolverRegistry
registerArgument(ArgumentResolver<T>) - Method in class io.github.hanielcota.commandframework.core.ParameterResolverRegistry
remaining() - Method in record class io.github.hanielcota.commandframework.core.cooldown.CooldownClaim: Returns the value of the remaining record component.
removeChild(String) - Method in class io.github.hanielcota.commandframework.core.CommandNode
resolve(ParameterParseContext) - Method in class io.github.hanielcota.commandframework.core.argument.ActorParameterResolver
resolve(ParameterParseContext) - Method in class io.github.hanielcota.commandframework.core.argument.DefaultValueResolver
resolve(ParameterParseContext) - Method in class io.github.hanielcota.commandframework.core.argument.GreedyStringParameterResolver
resolve(ParameterParseContext) - Method in class io.github.hanielcota.commandframework.core.argument.RawArgumentsParameterResolver
resolve(ParameterParseContext) - Method in record class io.github.hanielcota.commandframework.core.argument.SingleArgumentParameterResolver
resolve(ParameterParseContext) - Method in record class io.github.hanielcota.commandframework.core.CommandParameter: Delegates to the underlying ParameterResolver.
resolve(ParameterParseContext) - Method in interface io.github.hanielcota.commandframework.core.ParameterResolver: Attempts to resolve the value from the current parse context.
resolve(String, List<String>) - Method in class io.github.hanielcota.commandframework.core.CommandRouteRegistry: Resolves a command route by label and arguments.
resolve(String, List<String>) - Method in interface io.github.hanielcota.commandframework.core.RouteResolver: Resolves a route given a label and arguments.
resolver() - Method in record class io.github.hanielcota.commandframework.core.argument.SingleArgumentParameterResolver: Returns the value of the resolver record component.
resolver() - Method in record class io.github.hanielcota.commandframework.core.CommandParameter: Returns the value of the resolver record component.
resolver() - Method in record class io.github.hanielcota.commandframework.core.suggestion.CommandSuggestionEngine: Returns the value of the resolver record component.
retryAfter() - Method in record class io.github.hanielcota.commandframework.core.CommandResult: Returns the value of the retryAfter record component.
root() - Method in class io.github.hanielcota.commandframework.core.CommandRoute
root(String) - Method in class io.github.hanielcota.commandframework.core.CommandRouteRegistry
root(String) - Method in interface io.github.hanielcota.commandframework.core.RouteResolver: Finds a root by its label or alias.
roots() - Method in class io.github.hanielcota.commandframework.core.CommandDispatcher
roots() - Method in class io.github.hanielcota.commandframework.core.CommandRouteRegistry
roots() - Method in interface io.github.hanielcota.commandframework.core.RouteResolver: Returns all registered roots sorted by label.
rootSuggestions(String) - Method in class io.github.hanielcota.commandframework.core.CommandRouteRegistry
rootSuggestions(String) - Method in interface io.github.hanielcota.commandframework.core.RouteResolver: Returns root labels that start with the given prefix.
route() - Method in record class io.github.hanielcota.commandframework.core.CommandContext: Returns the value of the route record component.
route() - Method in class io.github.hanielcota.commandframework.core.CommandNode
route() - Method in record class io.github.hanielcota.commandframework.core.ParameterSuggestionContext: Returns the value of the route record component.
route() - Method in record class io.github.hanielcota.commandframework.core.RouteCursor
route() - Method in record class io.github.hanielcota.commandframework.core.RouteMatch: Returns the value of the route record component.
route() - Method in record class io.github.hanielcota.commandframework.core.SuggestionContext: Returns the value of the route record component.
RouteConfigurationException - Exception Class in io.github.hanielcota.commandframework.core: Thrown when a command route is configured incorrectly.
RouteConfigurationException(String) - Constructor for exception class io.github.hanielcota.commandframework.core.RouteConfigurationException
RouteConfigurationException(String, Throwable) - Constructor for exception class io.github.hanielcota.commandframework.core.RouteConfigurationException
RouteCooldownStore - Class in io.github.hanielcota.commandframework.core.cooldown
RouteCooldownStore() - Constructor for class io.github.hanielcota.commandframework.core.cooldown.RouteCooldownStore
RouteCooldownStore(Clock) - Constructor for class io.github.hanielcota.commandframework.core.cooldown.RouteCooldownStore
RouteCursor - Record Class in io.github.hanielcota.commandframework.core: Tracks the current position while walking the command tree.
RouteCursor(CommandRoute, int) - Constructor for record class io.github.hanielcota.commandframework.core.RouteCursor: Creates an instance of a RouteCursor record class.
RouteMatch - Record Class in io.github.hanielcota.commandframework.core
RouteMatch(CommandRoute, List<String>, int) - Constructor for record class io.github.hanielcota.commandframework.core.RouteMatch: Creates an instance of a RouteMatch record class.
routePath() - Method in record class io.github.hanielcota.commandframework.core.cooldown.CooldownKey: Returns the value of the routePath record component.
RouteResolution - Interface in io.github.hanielcota.commandframework.core
RouteResolution.Found - Record Class in io.github.hanielcota.commandframework.core
RouteResolution.NotFound - Record Class in io.github.hanielcota.commandframework.core
RouteResolver - Interface in io.github.hanielcota.commandframework.core: Read-only operations for resolving command routes.
routeValue() - Method in record class io.github.hanielcota.commandframework.core.RouteCursor: Returns the value of the routeValue record component.

S

SafeLogText - Class in io.github.hanielcota.commandframework.core.safety
SafeLogText() - Constructor for class io.github.hanielcota.commandframework.core.safety.SafeLogText
sanitize(String[]) - Method in record class io.github.hanielcota.commandframework.core.safety.InputSanitizer
sanitize(List<String>) - Method in class io.github.hanielcota.commandframework.core.PreDispatchValidator
sanitize(List<String>) - Method in record class io.github.hanielcota.commandframework.core.safety.InputSanitizer
SanitizedInput - Record Class in io.github.hanielcota.commandframework.core.safety
SanitizedInput(List<String>, String, String, boolean) - Constructor for record class io.github.hanielcota.commandframework.core.safety.SanitizedInput: Creates an instance of a SanitizedInput record class.
sanitizer(InputSanitizer) - Method in class io.github.hanielcota.commandframework.core.CommandDispatcher.Builder
send(CommandActor, String) - Method in class io.github.hanielcota.commandframework.core.CommandMessenger
senderRequirement() - Method in class io.github.hanielcota.commandframework.core.CommandRoute
senderRequirement(SenderRequirement) - Method in class io.github.hanielcota.commandframework.core.CommandRoute.Builder
SenderRequirement - Enum Class in io.github.hanielcota.commandframework.core: Restricts which kind of CommandActor may execute a route.
sendMessage(String) - Method in interface io.github.hanielcota.commandframework.core.CommandActor: Sends a plain-text message to this actor.
setDefaultRoute(CommandRoute) - Method in class io.github.hanielcota.commandframework.core.CommandNode
setRoute(CommandRoute) - Method in class io.github.hanielcota.commandframework.core.CommandNode
shouldSend(String, String) - Method in class io.github.hanielcota.commandframework.core.safety.ActorMessageDebouncer
SingleArgumentParameterResolver<T> - Record Class in io.github.hanielcota.commandframework.core.argument
SingleArgumentParameterResolver(ArgumentResolver<T>) - Constructor for record class io.github.hanielcota.commandframework.core.argument.SingleArgumentParameterResolver: Creates an instance of a SingleArgumentParameterResolver record class.
status() - Method in record class io.github.hanielcota.commandframework.core.CommandResult: Returns the value of the status record component.
string(String, String) - Method in interface io.github.hanielcota.commandframework.core.config.CommandConfiguration: Reads a string property for the given route key.
StringArgumentResolver - Class in io.github.hanielcota.commandframework.core.argument
StringArgumentResolver() - Constructor for class io.github.hanielcota.commandframework.core.argument.StringArgumentResolver
stringList(String, String) - Method in interface io.github.hanielcota.commandframework.core.config.CommandConfiguration: Reads a string list property for the given route key.
success() - Static method in record class io.github.hanielcota.commandframework.core.CommandResult: A shared successful result instance.
success(List<ParsedParameter<?>>) - Static method in interface io.github.hanielcota.commandframework.core.dispatch.ParameterParseOutcome
success(T, int) - Static method in interface io.github.hanielcota.commandframework.core.ParseResult
Success(List<ParsedParameter<?>>) - Constructor for record class io.github.hanielcota.commandframework.core.dispatch.ParameterParseOutcome.Success: Creates an instance of a Success record class.
Success(T, int) - Constructor for record class io.github.hanielcota.commandframework.core.ParseResult.Success: Creates an instance of a Success record class.
SUCCESS - Enum constant in enum class io.github.hanielcota.commandframework.core.CommandStatus
suggest(CommandActor, String, String[]) - Method in class io.github.hanielcota.commandframework.core.CommandDispatcher
suggest(CommandActor, String, String[]) - Method in record class io.github.hanielcota.commandframework.core.suggestion.CommandSuggestionEngine
suggest(CommandActor, String, List<String>) - Method in class io.github.hanielcota.commandframework.core.CommandDispatcher
suggest(CommandActor, String, List<String>) - Method in record class io.github.hanielcota.commandframework.core.suggestion.CommandSuggestionEngine
suggest(ParameterSuggestionContext) - Method in record class io.github.hanielcota.commandframework.core.argument.SingleArgumentParameterResolver
suggest(ParameterSuggestionContext) - Method in record class io.github.hanielcota.commandframework.core.CommandParameter: Delegates to the underlying ParameterResolver.
suggest(ParameterSuggestionContext) - Method in interface io.github.hanielcota.commandframework.core.ParameterResolver: Returns tab-completion suggestions for this parameter.
suggest(SuggestionContext) - Method in record class io.github.hanielcota.commandframework.core.argument.BooleanArgumentResolver
suggest(SuggestionContext) - Method in interface io.github.hanielcota.commandframework.core.ArgumentResolver: Returns tab-completion suggestions for this argument type.
suggest(SuggestionContext) - Method in record class io.github.hanielcota.commandframework.core.EnumArgumentResolver
suggest(SuggestionContext) - Method in interface io.github.hanielcota.commandframework.core.SuggestionProvider: Returns suggestions for the current input.
SuggestionContext - Record Class in io.github.hanielcota.commandframework.core
SuggestionContext(CommandActor, CommandRoute, String, List<String>) - Constructor for record class io.github.hanielcota.commandframework.core.SuggestionContext: Creates an instance of a SuggestionContext record class.
SuggestionProvider - Interface in io.github.hanielcota.commandframework.core: Functional interface for custom tab-completion logic.
syntax() - Method in class io.github.hanielcota.commandframework.core.CommandRoute: Returns the explicit usage syntax, or empty string if auto-derived.
syntax(String) - Method in class io.github.hanielcota.commandframework.core.CommandRoute.Builder

T

tags(String...) - Static method in interface io.github.hanielcota.commandframework.core.metrics.CommandMetrics: Creates an immutable tag map from alternating key-value strings.
terminal() - Static method in interface io.github.hanielcota.commandframework.core.pipeline.DispatchContinuation
TerminalContinuation - Class in io.github.hanielcota.commandframework.core.pipeline: Terminal continuation that returns a success result.
throttle(DispatchThrottle) - Method in class io.github.hanielcota.commandframework.core.CommandDispatcher.Builder
throttled() - Static method in record class io.github.hanielcota.commandframework.core.ValidationResult
ThrottleDecision - Enum Class in io.github.hanielcota.commandframework.core.rate
toMatch(List<String>) - Method in record class io.github.hanielcota.commandframework.core.RouteCursor
toString() - Method in record class io.github.hanielcota.commandframework.core.argument.BooleanArgumentResolver: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.argument.DoubleArgumentResolver: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.argument.IntegerArgumentResolver: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.argument.LongArgumentResolver: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.argument.SingleArgumentParameterResolver: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.ArgumentInput: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.CommandContext: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.CommandParameter: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.CommandResult: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.CommandRoot: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.cooldown.CooldownClaim: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.cooldown.CooldownKey: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.dispatch.ParameterParseFailure: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.dispatch.ParameterParseOutcome.Failure: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.dispatch.ParameterParseOutcome.Success: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.EnumArgumentResolver: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.ParameterParseContext: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.ParameterSuggestionContext: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.ParsedParameter: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.ParseResult.Failure: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.ParseResult.Success: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.RouteCursor: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.RouteMatch: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.RouteResolution.Found: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.RouteResolution.NotFound: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.safety.InputSanitizer: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.safety.SanitizedInput: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.suggestion.CommandSuggestionEngine: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.SuggestionContext: Returns a string representation of this record class.
toString() - Method in record class io.github.hanielcota.commandframework.core.ValidationResult: Returns a string representation of this record class.
trace(String) - Method in interface io.github.hanielcota.commandframework.core.CommandLogger: Logs a trace message (very verbose, usually disabled in production).
type() - Method in class io.github.hanielcota.commandframework.core.argument.ActorParameterResolver
type() - Method in record class io.github.hanielcota.commandframework.core.argument.BooleanArgumentResolver: Returns the value of the type record component.
type() - Method in class io.github.hanielcota.commandframework.core.argument.DefaultValueResolver
type() - Method in record class io.github.hanielcota.commandframework.core.argument.DoubleArgumentResolver: Returns the value of the type record component.
type() - Method in class io.github.hanielcota.commandframework.core.argument.GreedyStringParameterResolver
type() - Method in record class io.github.hanielcota.commandframework.core.argument.IntegerArgumentResolver: Returns the value of the type record component.
type() - Method in record class io.github.hanielcota.commandframework.core.argument.LongArgumentResolver: Returns the value of the type record component.
type() - Method in class io.github.hanielcota.commandframework.core.argument.RawArgumentsParameterResolver
type() - Method in record class io.github.hanielcota.commandframework.core.argument.SingleArgumentParameterResolver
type() - Method in class io.github.hanielcota.commandframework.core.argument.StringArgumentResolver
type() - Method in interface io.github.hanielcota.commandframework.core.ArgumentResolver: The Java type produced by this resolver.
type() - Method in record class io.github.hanielcota.commandframework.core.CommandParameter: Returns the value of the type record component.
type() - Method in record class io.github.hanielcota.commandframework.core.EnumArgumentResolver
type() - Method in interface io.github.hanielcota.commandframework.core.ParameterResolver: The Java type produced by this resolver.

U

uniqueId() - Method in interface io.github.hanielcota.commandframework.core.CommandActor: Returns a stable identifier for this actor.
unknownCommand(CommandActor, String) - Method in class io.github.hanielcota.commandframework.core.CommandMessenger
unknownCommand(String) - Method in interface io.github.hanielcota.commandframework.core.CommandMessageProvider
unknownCommand(String) - Method in class io.github.hanielcota.commandframework.core.message.DefaultCommandMessageProvider
unregister(CommandRoute) - Method in class io.github.hanielcota.commandframework.core.CommandDispatcher
unregister(CommandRoute) - Method in class io.github.hanielcota.commandframework.core.CommandRouteRegistry
UsageFormatter - Class in io.github.hanielcota.commandframework.core.usage
UsageFormatter() - Constructor for class io.github.hanielcota.commandframework.core.usage.UsageFormatter

V

valid() - Method in record class io.github.hanielcota.commandframework.core.safety.SanitizedInput: Returns the value of the valid record component.
valid() - Method in record class io.github.hanielcota.commandframework.core.ValidationResult: Returns the value of the valid record component.
valid(List<String>) - Static method in record class io.github.hanielcota.commandframework.core.safety.SanitizedInput
valid(List<String>) - Static method in record class io.github.hanielcota.commandframework.core.ValidationResult
validate(CommandActor, List<String>) - Method in class io.github.hanielcota.commandframework.core.PreDispatchValidator
ValidationResult - Record Class in io.github.hanielcota.commandframework.core: Result of pre-dispatch validation.
ValidationResult(boolean, List<String>, String, String, boolean) - Constructor for record class io.github.hanielcota.commandframework.core.ValidationResult: Creates an instance of a ValidationResult record class.
value() - Method in record class io.github.hanielcota.commandframework.core.ParsedParameter: Returns the value of the value record component.
value() - Method in record class io.github.hanielcota.commandframework.core.ParseResult.Success: Returns the value of the value record component.
value() - Method in interface io.github.hanielcota.commandframework.core.ParseResult
valueOf(String) - Static method in enum class io.github.hanielcota.commandframework.core.ActorKind: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.github.hanielcota.commandframework.core.CommandStatus: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.github.hanielcota.commandframework.core.rate.ThrottleDecision: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.github.hanielcota.commandframework.core.SenderRequirement: Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.github.hanielcota.commandframework.core.ActorKind: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.github.hanielcota.commandframework.core.CommandStatus: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.github.hanielcota.commandframework.core.rate.ThrottleDecision: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.github.hanielcota.commandframework.core.SenderRequirement: Returns an array containing the constants of this enum class, in the order they are declared.
visibleInUsage() - Method in record class io.github.hanielcota.commandframework.core.CommandParameter: Returns the value of the visibleInUsage record component.

W

warn(String, Throwable) - Method in interface io.github.hanielcota.commandframework.core.CommandLogger: Logs a warning together with an optional stack trace.
withDefaults() - Static method in class io.github.hanielcota.commandframework.core.ParameterResolverRegistry
withParsedParameters(List<ParsedParameter<?>>) - Method in record class io.github.hanielcota.commandframework.core.CommandContext: Returns a new context with the given parsed parameters attached.

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