Index

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

A

accept(CommandClassParser<S, R>) - Method in class studio.mevera.imperat.annotations.base.element.ClassElement
 
accept(T) - Method in interface studio.mevera.imperat.events.EventListenerConsumer
 
acceptCommandsParsing(CommandClassParser<S, Set<Command<S>>>) - Method in interface studio.mevera.imperat.annotations.base.AnnotationReader
 
acceptsInput(String) - Method in interface studio.mevera.imperat.context.FlagData
 
acceptThrowableResolversParsing(CommandClassParser<S, Set<MethodCommandExceptionHandler<?, S>>>) - Method in interface studio.mevera.imperat.annotations.base.AnnotationReader
 
add(E) - Method in class studio.mevera.imperat.util.priority.PriorityList
Adds an element with the specified priority.
add(Argument<S>) - Method in class studio.mevera.imperat.command.arguments.StrictArgumentList
 
add(HelpEntry<S>) - Method in class studio.mevera.imperat.command.tree.help.HelpEntryList
Adds an entry if it's not already present.
addAliases(String...) - Method in interface studio.mevera.imperat.command.Command
Adds aliases for the command using an array of alias strings.
addAliases(List<String>) - Method in interface studio.mevera.imperat.command.Command
Sets the aliases of a command
addAll(Collection<? extends Argument<S>>) - Method in class studio.mevera.imperat.command.arguments.StrictArgumentList
 
addAll(HelpEntryList<S>) - Method in class studio.mevera.imperat.command.tree.help.HelpEntryList
Adds all entries from another HelpEntryList.
addAll(Registry<K, V>) - Method in class studio.mevera.imperat.util.Registry
 
addArguments(List<Argument<S>>) - Method in interface studio.mevera.imperat.command.CommandPathway
Adds parameters to the usage
addArguments(Argument<S>...) - Method in interface studio.mevera.imperat.command.CommandPathway
Adds parameters to the usage
addChild(ParseElement<?>) - Method in class studio.mevera.imperat.annotations.base.element.ClassElement
 
addChild(CommandNode<S, ?>) - Method in class studio.mevera.imperat.command.tree.CommandNode
 
addContextPlaceholders() - Method in class studio.mevera.imperat.responses.Response
 
addExample(String) - Method in interface studio.mevera.imperat.command.CommandPathway
Adds an example to the usage
addExamples(List<String>) - Method in interface studio.mevera.imperat.command.CommandPathway
 
addFirst(Argument<S>) - Method in class studio.mevera.imperat.command.arguments.StrictArgumentList
 
addFlag(Argument<S>) - Method in interface studio.mevera.imperat.command.CommandPathway
 
addFlag(FlagArgument<S>) - Method in interface studio.mevera.imperat.command.CommandPathway
Adds a free flag to the usage
addPathway(CommandPathway.Builder<S>) - Method in interface studio.mevera.imperat.command.Command
 
addPathway(CommandPathway<S>) - Method in interface studio.mevera.imperat.command.Command
Adds a usage to the command
addPermissions(String...) - Method in class studio.mevera.imperat.permissions.PermissionsData
 
addPlaceholder(String) - Method in class studio.mevera.imperat.responses.Response
 
addPostProcessor(CommandPostProcessor<S>) - Method in interface studio.mevera.imperat.command.Command
Sets a post-processor for the command
addPreProcessor(CommandPreProcessor<S>) - Method in interface studio.mevera.imperat.command.Command
Sets a pre-processor for the command
addRule(Rule<E>) - Method in interface studio.mevera.imperat.annotations.base.element.selector.ElementSelector
 
addShortcut(Command<S>) - Method in interface studio.mevera.imperat.command.Command
Adds a shortcut to this command.
addStaticSuggestions(String...) - Method in class studio.mevera.imperat.command.arguments.type.ArgumentType
Adds the provided suggestions to the current list of suggestions for this parameter type.
addSubCommand(Command<S>, String) - Method in interface studio.mevera.imperat.command.Command
Injects a created-subcommand directly into the parent's command usages.
addValidator(ArgValidator<S>) - Method in interface studio.mevera.imperat.command.arguments.Argument
 
addValidator(ArgValidator<S>) - Method in class studio.mevera.imperat.command.arguments.InputArgument
 
aliases() - Method in interface studio.mevera.imperat.command.Command
 
aliases() - Method in interface studio.mevera.imperat.context.FlagData
 
aliases() - Method in record class studio.mevera.imperat.context.FlagData.FlagDataImpl
Returns the value of the aliases record component.
aliases(String...) - Method in class studio.mevera.imperat.command.arguments.FlagArgumentBuilder
 
aliases(String...) - Method in class studio.mevera.imperat.command.Command.Builder
 
aliases(List<String>) - Method in class studio.mevera.imperat.command.arguments.FlagArgumentBuilder
 
aliases(List<String>) - Method in class studio.mevera.imperat.command.Command.Builder
 
all() - Static method in class studio.mevera.imperat.command.tree.help.HelpFilters
Creates a filter that always passes (includes all pathways).
all(String...) - Static method in class studio.mevera.imperat.permissions.CommandPermissionCondition
 
all(List<String>) - Static method in class studio.mevera.imperat.permissions.CommandPermissionCondition
 
all(CommandPermissionCondition...) - Static method in class studio.mevera.imperat.permissions.CommandPermissionCondition
 
ALL - Enum constant in enum class studio.mevera.imperat.context.internal.ShiftTarget
 
allOf(HelpFilter<S>...) - Static method in class studio.mevera.imperat.command.tree.help.HelpFilters
Creates a composite filter from multiple filters (AND logic).
allOr(String...) - Static method in class studio.mevera.imperat.permissions.CommandPermissionCondition
 
allOr(List<String>) - Static method in class studio.mevera.imperat.permissions.CommandPermissionCondition
 
allOr(CommandPermissionCondition...) - Static method in class studio.mevera.imperat.permissions.CommandPermissionCondition
 
allowVariants() - Method in class studio.mevera.imperat.command.arguments.type.BooleanArgument
 
AmbiguousCommandException - Exception in studio.mevera.imperat.exception
 
AmbiguousCommandException(String) - Constructor for exception studio.mevera.imperat.exception.AmbiguousCommandException
 
AmbiguousCommandException(Command<S>, Command<S>) - Constructor for exception studio.mevera.imperat.exception.AmbiguousCommandException
Thrown when a root command with the same name/alias already exists in the command mapping.
AmbiguousCommandException(Command<S>, CommandNode<S, ?>, Collection<CommandNode<S, ?>>) - Constructor for exception studio.mevera.imperat.exception.AmbiguousCommandException
Thrown when a root command has two or more command usages with the same syntax at any parameter.
and(Rule<T>) - Method in interface studio.mevera.imperat.annotations.base.element.selector.Rule
 
and(Rule<T>) - Method in class studio.mevera.imperat.annotations.base.element.selector.Rule.SimpleRule
 
and(String...) - Method in class studio.mevera.imperat.permissions.CommandPermissionCondition
 
and(RuleCondition<E>) - Method in interface studio.mevera.imperat.annotations.base.element.selector.RuleCondition
 
and(HelpFilter<S>) - Method in interface studio.mevera.imperat.command.tree.help.HelpFilter
Creates a composite filter that requires both this and another filter to pass.
and(CommandPermissionCondition...) - Method in class studio.mevera.imperat.permissions.CommandPermissionCondition
 
AnnotatedArgument<S extends CommandSource> - Interface in studio.mevera.imperat.annotations.parameters
Represents an annotated parameter from using annotation parser
AnnotationArgumentDecorator<S extends CommandSource> - Class in studio.mevera.imperat.annotations.parameters
 
AnnotationFactory - Class in studio.mevera.imperat.annotations.base
A class that is responsible for creating dynamic instances of annotations of certain types useful while implementing/using AnnotationReplacer
AnnotationFactory() - Constructor for class studio.mevera.imperat.annotations.base.AnnotationFactory
 
AnnotationHelper - Class in studio.mevera.imperat.annotations.base
 
AnnotationHelper() - Constructor for class studio.mevera.imperat.annotations.base.AnnotationHelper
 
AnnotationInjector<S extends CommandSource> - Interface in studio.mevera.imperat
This interface provides mechanisms for injecting and managing annotations within a command parsing and execution framework.
AnnotationMap - Class in studio.mevera.imperat.util
 
AnnotationMap() - Constructor for class studio.mevera.imperat.util.AnnotationMap
 
AnnotationParser<S extends CommandSource> - Class in studio.mevera.imperat.annotations.base
Represents a class with a single responsibility of parsing annotated command classes and translating/converting them into Command POJOs then registering them using Imperat
AnnotationReader<S extends CommandSource> - Interface in studio.mevera.imperat.annotations.base
Represents a class that has a single responsibility of reading the annotation components of an annotated command class
annotationReplacer(Class<A>, AnnotationReplacer<A>) - Method in class studio.mevera.imperat.ConfigBuilder
Registers a custom annotation replacer for the specified annotation type.
AnnotationReplacer<A extends Annotation> - Interface in studio.mevera.imperat.annotations.base
Replaces a custom annotation made by the user, with annotations made from the basic pre-made annotations such as RootCommand
annotations - Variable in class studio.mevera.imperat.annotations.base.element.ParseElement
 
anyOf(HelpFilter<S>...) - Static method in class studio.mevera.imperat.command.tree.help.HelpFilters
Creates a composite filter from multiple filters (OR logic).
append(PermissionsData) - Method in class studio.mevera.imperat.permissions.PermissionsData
 
append(C) - Method in class studio.mevera.imperat.command.tree.help.theme.HelpComponent
 
append(String) - Method in class studio.mevera.imperat.command.tree.help.theme.StringHelpComponent
 
append(HelpComponent<S, C>) - Method in class studio.mevera.imperat.command.tree.help.theme.HelpComponent
 
appendParameterFormat(Argument<S>) - Method in class studio.mevera.imperat.command.tree.help.theme.HelpComponent
 
appendText(String) - Method in class studio.mevera.imperat.command.tree.help.theme.HelpComponent
 
appendText(String) - Method in class studio.mevera.imperat.command.tree.help.theme.StringHelpComponent
 
appendText(HelpComponent<S, String>) - Method in class studio.mevera.imperat.command.tree.help.theme.HelpComponent
 
applyAnnotationReplacers(Imperat<S>) - Method in interface studio.mevera.imperat.ImperatConfig
Apply annotation replacers.
applyOnConfig(Consumer<ImperatConfig<S>>) - Method in class studio.mevera.imperat.ConfigBuilder
Applies a consumer function to the current configuration, allowing modifications to be performed directly on the ImperatConfig instance.
applyPlaceholders(String) - Method in class studio.mevera.imperat.placeholders.PlaceholderRegistry
 
areRelatedTypes(Type, Type) - Static method in class studio.mevera.imperat.util.TypeUtility
 
areTrueFlagsOfSameInputType(Set<FlagArgument<S>>) - Static method in class studio.mevera.imperat.util.TypeUtility
 
argBuilders(List<? extends ArgumentBuilder<S, ?>>) - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
argType(Type, ArgumentType<S, T>) - Method in class studio.mevera.imperat.ConfigBuilder
Registers a parameter type and its associated resolver for parsing command arguments.
ArgType - Annotation Interface in studio.mevera.imperat.annotations.types
Sets the argument type for a parameter/argument.
argTypeHandler(ArgumentTypeHandler<S>) - Method in class studio.mevera.imperat.ConfigBuilder
Registers an ArgumentTypeHandler to the configuration, allowing for custom handling of argument types during command processing.
Argument<S extends CommandSource> - Interface in studio.mevera.imperat.command.arguments
Represents the command parameter required by the usage of the command itself
ArgumentBuilder<S extends CommandSource,T> - Class in studio.mevera.imperat.command.arguments
 
ArgumentHandler<S extends CommandSource> - Interface in studio.mevera.imperat.context.internal
 
ArgumentInput - Interface in studio.mevera.imperat.context
Represents a custom data structure made specifically for handling the arguments entered by the CommandSource
ArgumentNode<S extends CommandSource> - Class in studio.mevera.imperat.command.tree
 
argumentParsedValue - Variable in class studio.mevera.imperat.context.ParsedArgument
 
ArgumentParseException - Exception in studio.mevera.imperat.exception
Thrown when a raw argument string cannot be parsed into the expected type.
ArgumentParseException(ResponseKey, String) - Constructor for exception studio.mevera.imperat.exception.ArgumentParseException
 
arguments() - Method in interface studio.mevera.imperat.context.CommandContext
 
arguments(List<Argument<S>>) - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
arguments(Argument<S>...) - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
arguments(ArgumentBuilder<S, ?>...) - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
ArgumentType<S extends CommandSource,T> - Class in studio.mevera.imperat.command.arguments.type
Base class for defining parameter types in a command processing framework.
ArgumentType() - Constructor for class studio.mevera.imperat.command.arguments.type.ArgumentType
Constructs a new BaseArgumentType with an automated TypeWrap
ArgumentType(Class<T>) - Constructor for class studio.mevera.imperat.command.arguments.type.ArgumentType
Constructs a new BaseArgumentType with the given TypeWrap.
ArgumentType(Type) - Constructor for class studio.mevera.imperat.command.arguments.type.ArgumentType
Constructs a new BaseArgumentType with the given TypeWrap.
ArgumentTypeHandler<S extends CommandSource> - Interface in studio.mevera.imperat.command.arguments.type
Handler for resolving ArgumentType instances for complex or specialized types.
ArgumentTypeLookup<S extends CommandSource> - Interface in studio.mevera.imperat.command.arguments.type
Functional interface for resolving nested/component types during argument type resolution.
ArgumentTypeRegistry<S extends CommandSource> - Class in studio.mevera.imperat.context
Registry for ArgumentType instances, managing type resolution through a chain of handlers.
ArgumentTypes - Class in studio.mevera.imperat.command.arguments.type
 
ArgValidator<S extends CommandSource> - Interface in studio.mevera.imperat.command.arguments.validator
Validates a parsed command argument.
array(TypeWrap<E[]>, Function<Integer, Object[]>, ArgumentType<S, E>) - Static method in class studio.mevera.imperat.command.arguments.type.ArgumentTypes
 
ArrayArgument<S extends CommandSource,E> - Class in studio.mevera.imperat.command.arguments.type
 
ArrayArgument(TypeWrap<E[]>, Function<Integer, Object[]>, ArgumentType<S, E>) - Constructor for class studio.mevera.imperat.command.arguments.type.ArrayArgument
 
ArrayArgumentTypeHandler<S extends CommandSource> - Class in studio.mevera.imperat.command.arguments.type.handlers
Handler for resolving ArgumentType instances for array types.
ArrayArgumentTypeHandler() - Constructor for class studio.mevera.imperat.command.arguments.type.handlers.ArrayArgumentTypeHandler
Creates a new ArrayArgumentTypeHandler with default initializers.
as(Class<T>) - Method in interface studio.mevera.imperat.context.CommandSource
 
asAnnotatedArgument() - Method in interface studio.mevera.imperat.command.arguments.Argument
Casts the parameter to a parameter with annotations
asAnnotatedArgument() - Method in interface studio.mevera.imperat.command.Command
 
asCommand() - Method in interface studio.mevera.imperat.command.arguments.Argument
Casts the parameter to a subcommand/command
asCommand() - Method in class studio.mevera.imperat.command.arguments.InputArgument
 
asCommand() - Method in interface studio.mevera.imperat.command.Command
 
asFlagParameter() - Method in class studio.mevera.imperat.annotations.parameters.AnnotationArgumentDecorator
Casts the parameter to a flag parameter
asFlagParameter() - Method in interface studio.mevera.imperat.command.arguments.Argument
Casts the parameter to a flag parameter
asFlagParameter() - Method in class studio.mevera.imperat.command.arguments.InputArgument
Casts the parameter to a flag parameter
asNumeric() - Method in class studio.mevera.imperat.annotations.parameters.AnnotationArgumentDecorator
 
asNumeric() - Method in interface studio.mevera.imperat.command.arguments.Argument
 
asUnmodifiable() - Method in class studio.mevera.imperat.util.priority.PriorityList
Returns an immutable view of this PriorityList.
async() - Static method in interface studio.mevera.imperat.responses.ResponseContentFetcher
 
async(ExecutorService) - Static method in interface studio.mevera.imperat.command.CommandCoordinator
 
Async - Annotation Interface in studio.mevera.imperat.annotations.types
Marks a command handling method to be executed asynchronously.
ASYNC - Enum constant in enum class studio.mevera.imperat.events.ExecutionStrategy
Handler executes asynchronously in a separate thread.
attachTo() - Element in annotation interface studio.mevera.imperat.annotations.types.SubCommand
The format of the node/argument to attach this subcommand to.
autoComplete(S, String) - Method in class studio.mevera.imperat.BaseImperat
 
autoComplete(S, String) - Method in interface studio.mevera.imperat.Imperat
 
autoComplete(SuggestionContext<S>) - Method in class studio.mevera.imperat.command.suggestions.AutoCompleter
Autocompletes an argument from the whole position of the argument-raw input
autoComplete(Imperat<S>, S, String, String[]) - Method in class studio.mevera.imperat.command.suggestions.AutoCompleter
Autocompletes an argument from the whole position of the argument-raw input
autoCompleter() - Method in interface studio.mevera.imperat.command.Command
 
AutoCompleter<S extends CommandSource> - Class in studio.mevera.imperat.command.suggestions
Represents a class that's responsible for Handling all auto-completion processes during tab-completion per one command, regardless of the sender valueType
AutoCompleter(Command<S>) - Constructor for class studio.mevera.imperat.command.suggestions.AutoCompleter
 

B

BaseHelpTheme<S extends CommandSource,C> - Class in studio.mevera.imperat.command.tree.help.theme
 
BaseHelpTheme(Function<C, HelpComponent<S, C>>) - Constructor for class studio.mevera.imperat.command.tree.help.theme.BaseHelpTheme
 
BaseImperat<S extends CommandSource> - Class in studio.mevera.imperat
 
BaseImperat(ImperatConfig<S>) - Constructor for class studio.mevera.imperat.BaseImperat
 
BaseReturnResolver<S extends CommandSource,T> - Class in studio.mevera.imperat.command.returns
 
BaseReturnResolver(Type) - Constructor for class studio.mevera.imperat.command.returns.BaseReturnResolver
 
BaseReturnResolver(TypeWrap<T>) - Constructor for class studio.mevera.imperat.command.returns.BaseReturnResolver
 
BaseThrowableHandler<S extends CommandSource> - Interface in studio.mevera.imperat
A base implementation of ThrowableHandler that provides intelligent exception chain traversal and resolution logic.
betweenIn(int, int, int) - Static method in class studio.mevera.imperat.util.Preconditions
 
bindTo(Object) - Method in interface studio.mevera.imperat.util.asm.MethodCaller
Binds this caller to the specified instance.
blocking() - Static method in interface studio.mevera.imperat.responses.ResponseContentFetcher
 
bool() - Static method in class studio.mevera.imperat.command.arguments.type.ArgumentTypes
 
BooleanArgument<S extends CommandSource> - Class in studio.mevera.imperat.command.arguments.type
 
box() - Static method in interface studio.mevera.imperat.ThrowablePrinter
Returns a printer that formats the throwable into a decorative box and logs it using the IMPERAT logger.
boxedToPrimative(Type) - Static method in class studio.mevera.imperat.util.TypeUtility
 
build() - Method in class studio.mevera.imperat.annotations.base.element.selector.Rule.Builder
 
build() - Method in class studio.mevera.imperat.command.arguments.ArgumentBuilder
 
build() - Method in class studio.mevera.imperat.command.arguments.FlagArgumentBuilder
 
build() - Method in class studio.mevera.imperat.command.Command.Builder
 
build() - Method in class studio.mevera.imperat.command.tree.help.HelpQuery.Builder
Builds an immutable HelpQuery instance with the configured parameters.
build() - Method in class studio.mevera.imperat.ConfigBuilder
Builds and returns the final configuration object based on the provided settings and definitions within the builder.
build() - Method in class studio.mevera.imperat.events.EventBus.Builder
Builds and returns a configured EventBus.
build() - Method in class studio.mevera.imperat.placeholders.Placeholder.Builder
 
build(Command<S>) - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
builder() - Static method in interface studio.mevera.imperat.annotations.base.element.selector.Rule
 
builder() - Static method in interface studio.mevera.imperat.command.CommandPathway
 
builder() - Static method in class studio.mevera.imperat.command.tree.help.HelpQuery
Creates a new builder for constructing a HelpQuery.
builder() - Static method in interface studio.mevera.imperat.events.EventBus
Returns a new EventBus.Builder for configuring an EventBus.
builder(MethodElement) - Static method in interface studio.mevera.imperat.command.CommandPathway
 
builder(String) - Static method in interface studio.mevera.imperat.placeholders.Placeholder
 
buildForMethod() - Static method in interface studio.mevera.imperat.annotations.base.element.selector.Rule
 

C

call(Object...) - Method in interface studio.mevera.imperat.util.asm.MethodCaller.BoundMethodCaller
Calls the method of this caller
call(Object, Object...) - Method in interface studio.mevera.imperat.util.asm.MethodCaller
Calls the method of this caller
canBeSelected(Imperat<?>, AnnotationParser<?>, E, boolean) - Method in interface studio.mevera.imperat.annotations.base.element.selector.ElementSelector
 
canBeSender(Type) - Method in class studio.mevera.imperat.BaseImperat
Checks whether the valueType can be a command sender
canBeSender(Type) - Method in interface studio.mevera.imperat.SourceWrapper
Checks whether the valueType can be a command sender
CancellableEvent - Interface in studio.mevera.imperat.events
An extension of Event that supports cancellation.
canHandle(Type, TypeWrap<?>) - Method in interface studio.mevera.imperat.command.arguments.type.ArgumentTypeHandler
Determines if this handler can resolve the given type.
canHandle(Type, TypeWrap<?>) - Method in class studio.mevera.imperat.command.arguments.type.handlers.ArrayArgumentTypeHandler
 
canHandle(Type, TypeWrap<?>) - Method in class studio.mevera.imperat.command.arguments.type.handlers.CollectionArgumentTypeHandler
 
canHandle(Type, TypeWrap<?>) - Method in class studio.mevera.imperat.command.arguments.type.handlers.CompletableFutureArgumentTypeHandler
 
canHandle(Type, TypeWrap<?>) - Method in class studio.mevera.imperat.command.arguments.type.handlers.EitherArgumentTypeHandler
 
canHandle(Type, TypeWrap<?>) - Method in class studio.mevera.imperat.command.arguments.type.handlers.EnumArgumentTypeHandler
 
canHandle(Type, TypeWrap<?>) - Method in class studio.mevera.imperat.command.arguments.type.handlers.MapArgumentTypeHandler
 
canHandle(Type, TypeWrap<?>) - Method in class studio.mevera.imperat.command.arguments.type.handlers.NumericArgumentTypeHandler
 
canHandle(Type, TypeWrap<?>) - Method in class studio.mevera.imperat.command.arguments.type.handlers.OptionalArgumentTypeHandler
 
canHandle(Type, TypeWrap<?>) - Method in class studio.mevera.imperat.command.arguments.type.SimpleTypeResolver
 
canReuseInExecution() - Method in class studio.mevera.imperat.command.tree.ParseResult
 
capacity() - Method in class studio.mevera.imperat.command.tree.help.HelpEntryList
Returns the current capacity of the internal array.
caseSensitive() - Element in annotation interface studio.mevera.imperat.annotations.types.Values
Whether the values should be checked upon for being exactly the SAME as the input (including upper and lower case)
cast(double) - Method in class studio.mevera.imperat.command.arguments.type.NumberArgument
 
character() - Static method in class studio.mevera.imperat.command.arguments.type.ArgumentTypes
 
CharacterArgument<S extends CommandSource> - Class in studio.mevera.imperat.command.arguments.type
 
CharacterArgument() - Constructor for class studio.mevera.imperat.command.arguments.type.CharacterArgument
 
check(S, PermissionChecker<S>) - Method in class studio.mevera.imperat.permissions.CommandPermissionCondition
 
checkArgument(boolean, String) - Static method in class studio.mevera.imperat.util.Preconditions
 
checkCallableStatic(Object, Method) - Static method in class studio.mevera.imperat.util.Preconditions
 
checkPermission(S, PermissionHolder) - Method in interface studio.mevera.imperat.permissions.PermissionChecker
 
childrenOnly() - Static method in class studio.mevera.imperat.command.tree.help.HelpFilters
Creates a filter that only includes pathways with more than one parameter (i.e.
ClassElement - Class in studio.mevera.imperat.annotations.base.element
 
ClassElement(AnnotationParser<S>, ClassElement, Class<?>) - Constructor for class studio.mevera.imperat.annotations.base.element.ClassElement
 
ClassElement(AnnotationParser<S>, ClassElement, Class<?>, Object) - Constructor for class studio.mevera.imperat.annotations.base.element.ClassElement
 
clear() - Method in class studio.mevera.imperat.command.tree.help.HelpEntryList
Clears all entries.
clear() - Method in class studio.mevera.imperat.util.priority.PriorityList
Removes all elements from this list.
collectBeforeFirst(char) - Method in interface studio.mevera.imperat.context.internal.Cursor
Collects and returns all characters before the first occurrence of the specified character.
collection(TypeWrap<C>, Supplier<C>, ArgumentType<S, E>) - Static method in class studio.mevera.imperat.command.arguments.type.ArgumentTypes
 
CollectionArgument<S extends CommandSource,E,C extends Collection<E>> - Class in studio.mevera.imperat.command.arguments.type
 
CollectionArgument(TypeWrap<C>, Supplier<C>, ArgumentType<S, E>) - Constructor for class studio.mevera.imperat.command.arguments.type.CollectionArgument
 
CollectionArgumentTypeHandler<S extends CommandSource> - Class in studio.mevera.imperat.command.arguments.type.handlers
Handler for resolving ArgumentType instances for Collection types.
CollectionArgumentTypeHandler() - Constructor for class studio.mevera.imperat.command.arguments.type.handlers.CollectionArgumentTypeHandler
Creates a new CollectionArgumentTypeHandler with default initializers.
collectPermissionsUsedOnConditions() - Method in class studio.mevera.imperat.permissions.CommandPermissionCondition
Recursively collects all permission strings used in this condition and its children.
collectRawArguments(int) - Method in interface studio.mevera.imperat.context.internal.Cursor
Collect a specific number of raw arguments
collectRemainingRaw() - Method in interface studio.mevera.imperat.context.internal.Cursor
Collects and returns the remaining raw input strings from the current cursor position to the end of the input queue.
CombinedFlagsException - Exception in studio.mevera.imperat.exception
 
CombinedFlagsException(String) - Constructor for exception studio.mevera.imperat.exception.CombinedFlagsException
 
command - Variable in class studio.mevera.imperat.command.suggestions.AutoCompleter
 
command - Variable in class studio.mevera.imperat.events.CommandEvent
The command associated with this event.
command() - Method in interface studio.mevera.imperat.context.CommandContext
 
command(Command<S>) - Static method in class studio.mevera.imperat.command.arguments.type.ArgumentTypes
 
Command<S extends CommandSource> - Interface in studio.mevera.imperat.command
Represents a wrapper for the actual command's data
Command.Builder<S extends CommandSource> - Class in studio.mevera.imperat.command
 
CommandArgument<S extends CommandSource> - Class in studio.mevera.imperat.command.arguments.type
 
CommandClassParser<S extends CommandSource,R> - Class in studio.mevera.imperat.annotations.base.parsers
Visits each element in a ClassElement
CommandClassParser(Imperat<S>, AnnotationParser<S>, ElementSelector<MethodElement>) - Constructor for class studio.mevera.imperat.annotations.base.parsers.CommandClassParser
 
CommandContext<S extends CommandSource> - Interface in studio.mevera.imperat.context
Represents the processes context of a command entered by CommandSource
CommandCoordinator<S extends CommandSource> - Interface in studio.mevera.imperat.command
 
CommandCoordinator.UnsafeRunnable - Interface in studio.mevera.imperat.command
 
CommandElementParser<S extends CommandSource> - Class in studio.mevera.imperat.annotations.base.parsers
 
CommandEvent<S extends CommandSource> - Class in studio.mevera.imperat.events
Base class for all command-related events in the Imperat framework.
CommandEvent(Command<S>) - Constructor for class studio.mevera.imperat.events.CommandEvent
Constructs a new command event.
CommandException - Exception in studio.mevera.imperat.exception
 
CommandException() - Constructor for exception studio.mevera.imperat.exception.CommandException
 
CommandException(String, Object...) - Constructor for exception studio.mevera.imperat.exception.CommandException
 
CommandException(String, Throwable, Object...) - Constructor for exception studio.mevera.imperat.exception.CommandException
 
CommandExceptionHandler<E extends Throwable,S extends CommandSource> - Interface in studio.mevera.imperat.exception
A functional interface for handling and resolving exceptions that occur during Imperat's command execution flow.
CommandExecution<S extends CommandSource> - Interface in studio.mevera.imperat.command
This class represents the execution/action of this command that's triggered when the sender asks for this command to be executed.
CommandHelp<S extends CommandSource> - Class in studio.mevera.imperat.command.tree.help
 
CommandNode<S extends CommandSource,T extends Argument<S>> - Class in studio.mevera.imperat.command.tree
 
CommandNode(CommandNode<S, ?>, T, int, CommandPathway<S>) - Constructor for class studio.mevera.imperat.command.tree.CommandNode
 
CommandNode.CompletionCache<S extends CommandSource> - Record Class in studio.mevera.imperat.command.tree
 
CommandParsingMode - Enum Class in studio.mevera.imperat
 
CommandPathway<S extends CommandSource> - Interface in studio.mevera.imperat.command
Represents a usage of a command that can be used in the future during an execution
CommandPathway.Builder<S extends CommandSource> - Class in studio.mevera.imperat.command
 
CommandPermissionCondition - Class in studio.mevera.imperat.permissions
 
CommandPostProcessEvent<S extends CommandSource> - Class in studio.mevera.imperat.events.types
 
CommandPostProcessEvent(Command<S>, ExecutionContext<S>) - Constructor for class studio.mevera.imperat.events.types.CommandPostProcessEvent
Constructs a new command event.
CommandPostProcessor<S extends CommandSource> - Interface in studio.mevera.imperat.command.processors
Defines a functional interface that processes a CommandContext AFTER the resolving of the arguments into values.
CommandPostRegistrationEvent<S extends CommandSource> - Class in studio.mevera.imperat.events.types
Event fired after a command registration attempt completes, whether successful or failed.
CommandPostRegistrationEvent(Command<S>, Throwable) - Constructor for class studio.mevera.imperat.events.types.CommandPostRegistrationEvent
Constructs a new command post-registration event.
commandPrefix() - Method in interface studio.mevera.imperat.ImperatConfig
 
commandPrefix(String) - Method in class studio.mevera.imperat.ConfigBuilder
Sets the command prefix for the command processing chain.
CommandPreProcessEvent<S extends CommandSource> - Class in studio.mevera.imperat.events.types
 
CommandPreProcessEvent(Command<S>, CommandContext<S>) - Constructor for class studio.mevera.imperat.events.types.CommandPreProcessEvent
Constructs a new command event.
CommandPreProcessor<S extends CommandSource> - Interface in studio.mevera.imperat.command.processors
Defines a functional interface that processes a CommandContext BEFORE the resolving of the arguments into values.
CommandPreRegistrationEvent<S extends CommandSource> - Class in studio.mevera.imperat.events.types
Event fired before a command is registered to the command dispatcher.
CommandPreRegistrationEvent(Command<S>) - Constructor for class studio.mevera.imperat.events.types.CommandPreRegistrationEvent
Constructs a new command pre-registration event.
CommandProcessor - Interface in studio.mevera.imperat.command.processors
 
CommandRegistrar<S extends CommandSource> - Interface in studio.mevera.imperat
 
CommandSource - Interface in studio.mevera.imperat.context
Represents the sender/source of a command being executed may be a console, a player in a game, etc...
CommandTree<S extends CommandSource> - Interface in studio.mevera.imperat.command.tree
Represents a tree structure for commands, providing methods for parsing, matching, and tab-completion functionality within a command framework.
CommandTreeVisualizer<S extends CommandSource> - Class in studio.mevera.imperat.command.tree
 
COMPARATORS - Static variable in interface studio.mevera.imperat.command.NumericComparator
 
compareTo(ArgValidator<S>) - Method in interface studio.mevera.imperat.command.arguments.validator.ArgValidator
 
compareTo(CommandNode<S, ?>) - Method in class studio.mevera.imperat.command.tree.CommandNode
 
compareTo(Priority) - Method in class studio.mevera.imperat.util.priority.Priority
 
CompletableFutureArgument<S extends CommandSource,T> - Class in studio.mevera.imperat.command.arguments.type
 
CompletableFutureArgument(TypeWrap<CompletableFuture<T>>, ArgumentType<S, T>) - Constructor for class studio.mevera.imperat.command.arguments.type.CompletableFutureArgument
 
CompletableFutureArgumentTypeHandler<S extends CommandSource> - Class in studio.mevera.imperat.command.arguments.type.handlers
Handler for resolving ArgumentType instances for CompletableFuture types.
CompletableFutureArgumentTypeHandler() - Constructor for class studio.mevera.imperat.command.arguments.type.handlers.CompletableFutureArgumentTypeHandler
 
CompletionArg - Record Class in studio.mevera.imperat.command.suggestions
Represents an argument that's being completed or an argument requested by the command-sender to be completed
CompletionArg(String, int) - Constructor for record class studio.mevera.imperat.command.suggestions.CompletionArg
Creates an instance of a CompletionArg record class.
CompletionCache(SuggestionProvider<S>, List<FlagArgument<S>>, Map<String, FlagArgument<S>>, List<CommandNode<S, ?>>, List<CommandNode<S, ?>>, List<CommandNode<S, ?>>, Map<String, List<CommandNode<S, ?>>>) - Constructor for record class studio.mevera.imperat.command.tree.CommandNode.CompletionCache
Creates an instance of a CompletionCache record class.
componentValue - Variable in class studio.mevera.imperat.command.tree.help.theme.HelpComponent
 
condition() - Method in interface studio.mevera.imperat.annotations.base.element.selector.Rule
 
condition() - Method in class studio.mevera.imperat.annotations.base.element.selector.Rule.SimpleRule
 
condition(RuleCondition<T>) - Method in class studio.mevera.imperat.annotations.base.element.selector.Rule.Builder
 
conditionalRootUsage(Predicate<CommandPathway<S>>) - Method in class studio.mevera.imperat.command.tree.help.HelpQuery.Builder
Sets the condition for including the root's MAINcommand usage.
config - Variable in class studio.mevera.imperat.BaseImperat
 
config - Variable in class studio.mevera.imperat.ConfigBuilder
 
config() - Method in class studio.mevera.imperat.BaseImperat
The config for imperat
config() - Method in interface studio.mevera.imperat.Imperat
The config for imperat
ConfigBuilder<S extends CommandSource,I extends Imperat<S>,B extends ConfigBuilder<S,I,B>> - Class in studio.mevera.imperat
A generic abstract builder class for configuring instances of ImperatConfig and creating implementations of the Imperat interface.
ConfigBuilder() - Constructor for class studio.mevera.imperat.ConfigBuilder
 
CONSOLE_UUID - Static variable in interface studio.mevera.imperat.context.CommandSource
 
ConstrainedValueValidator<S extends CommandSource> - Class in studio.mevera.imperat.command.arguments.validator
 
ConstrainedValueValidator(Set<String>, boolean) - Constructor for class studio.mevera.imperat.command.arguments.validator.ConstrainedValueValidator
 
contains(E) - Method in class studio.mevera.imperat.util.priority.PriorityList
Checks if this list contains the specified element.
contains(Object) - Method in class studio.mevera.imperat.command.arguments.StrictArgumentList
 
contains(HelpEntry<S>) - Method in class studio.mevera.imperat.command.tree.help.HelpEntryList
Checks if an entry exists in the list.
containsSimilar(Argument<?>) - Method in class studio.mevera.imperat.command.arguments.StrictArgumentList
 
Context - Annotation Interface in studio.mevera.imperat.annotations.types
Marks a type or parameter whose value is resolved from the execution context rather than parsed from the command input.
contextArgumentProvider(Type, ContextArgumentProvider<S, T>) - Method in class studio.mevera.imperat.ConfigBuilder
Registers a context resolver for a specified type, allowing you to resolve a default value from the context for that type.
ContextArgumentProvider<S extends CommandSource,T> - Interface in studio.mevera.imperat.providers
Resolves a default non-overridable value for missing required arguments
contextArgumentProviderFactory(Type, ContextArgumentProviderFactory<S, T>) - Method in class studio.mevera.imperat.ConfigBuilder
Registers a context resolver factory for the specified type.
ContextArgumentProviderFactory<S extends CommandSource,T> - Interface in studio.mevera.imperat.command
Represents a context resolver factory that is responsible for creating ContextArgumentProvider
ContextArgumentProviderRegistry<S extends CommandSource> - Class in studio.mevera.imperat.command
 
contextFactory(ContextFactory<S>) - Method in class studio.mevera.imperat.ConfigBuilder
Sets the context factory for creating contexts used in command execution.
ContextFactory<S extends CommandSource> - Class in studio.mevera.imperat.context.internal
Represents a way for defining how the context is created
ContextFactory() - Constructor for class studio.mevera.imperat.context.internal.ContextFactory
 
cooldown(long, TimeUnit) - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
cooldown(long, TimeUnit, String) - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
cooldown(CooldownRecord) - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
Cooldown - Annotation Interface in studio.mevera.imperat.annotations.types
Applies a per-invocation cooldown to a command method.
COOLDOWN - Static variable in interface studio.mevera.imperat.responses.ResponseKey
 
CooldownHandler<S extends CommandSource> - Interface in studio.mevera.imperat.command.cooldown
Cool-down checker and handler for the command usages CommandPathway
CooldownHolder - Interface in studio.mevera.imperat.command
 
cooldownProcessor() - Static method in class studio.mevera.imperat.command.processors.impl.DefaultProcessors
 
CooldownProcessor<S extends CommandSource> - Class in studio.mevera.imperat.command.processors.impl
 
CooldownRecord - Class in studio.mevera.imperat.command.cooldown
Represents a required cooldown of a CommandPathway
CooldownRecord(long, TimeUnit, String) - Constructor for class studio.mevera.imperat.command.cooldown.CooldownRecord
 
coordinate(ExecutionContext<S>, CommandExecution<S>) - Method in interface studio.mevera.imperat.command.CommandCoordinator
 
coordinator(CommandCoordinator<S>) - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
copy() - Method in class studio.mevera.imperat.command.tree.LiteralCommandNode
 
copy() - Method in interface studio.mevera.imperat.context.ArgumentInput
Returns an independent copy of this argument stack.
copy() - Method in interface studio.mevera.imperat.context.internal.Cursor
Creates a deep copy of this command input cursor.
copy() - Method in class studio.mevera.imperat.context.internal.CursorPosition
 
create() - Static method in interface studio.mevera.imperat.annotations.base.element.selector.ElementSelector
 
create() - Static method in class studio.mevera.imperat.command.tree.help.HelpCoordinator
A factory method to create a new HelpCoordinator with default settings.
create(Class<T>) - Static method in class studio.mevera.imperat.annotations.base.AnnotationFactory
Creates a new annotation with no values.
create(Class<T>, Object...) - Static method in class studio.mevera.imperat.annotations.base.AnnotationFactory
Creates a new annotation with the given map values.
create(Class<T>, Map<String, Object>) - Static method in class studio.mevera.imperat.annotations.base.AnnotationFactory
Creates a new annotation with the given map values.
create(Imperat<S>, Command<S>, int, String) - Static method in interface studio.mevera.imperat.command.Command
 
create(Imperat<S>, Command<S>, int, String, ParseElement<?>) - Static method in interface studio.mevera.imperat.command.Command
 
create(Imperat<S>, Command<S>, String) - Static method in interface studio.mevera.imperat.command.Command
 
create(Imperat<S>, Command<S>, String, ParseElement<?>) - Static method in interface studio.mevera.imperat.command.Command
 
create(Imperat<S>, String) - Static method in interface studio.mevera.imperat.command.Command
 
create(Imperat<S>, String, ParseElement<?>) - Static method in interface studio.mevera.imperat.command.Command
 
create(Type, ParameterElement) - Method in interface studio.mevera.imperat.command.ContextArgumentProviderFactory
Creates a context resolver based on the parameter
create(String, List<String>, ArgumentType<S, T>) - Static method in interface studio.mevera.imperat.context.FlagData
 
create(TreeHelpVisitor<S>, HelpLayoutRenderer<S, ?>) - Static method in class studio.mevera.imperat.command.tree.help.HelpCoordinator
A factory method to create a new HelpCoordinator with custom settings.
create(ExecutionContext<S>) - Static method in class studio.mevera.imperat.command.tree.help.CommandHelp
 
create(ImperatConfig<S>, Command<S>) - Static method in interface studio.mevera.imperat.command.tree.CommandTree
 
createArgumentNode(CommandNode<S, ?>, Argument<S>, int, CommandPathway<S>) - Static method in class studio.mevera.imperat.command.tree.CommandNode
 
createCommandNode(CommandNode<S, ?>, Command<S>, int, CommandPathway<S>) - Static method in class studio.mevera.imperat.command.tree.CommandNode
 
createContext(Imperat<S>, S, Command<S>, String, ArgumentInput) - Method in class studio.mevera.imperat.context.internal.ContextFactory
 
createDefault() - Static method in class studio.mevera.imperat.command.ContextArgumentProviderRegistry
 
createDefault() - Static method in class studio.mevera.imperat.command.ReturnResolverRegistry
 
createDefault() - Static method in class studio.mevera.imperat.command.SourceProviderRegistry
 
createDefault() - Static method in class studio.mevera.imperat.context.ArgumentTypeRegistry
Creates a new default ArgumentTypeRegistry with all built-in handlers registered.
createDefault() - Static method in interface studio.mevera.imperat.placeholders.PlaceholderDataProvider
 
createDefault() - Static method in class studio.mevera.imperat.placeholders.PlaceholderRegistry
 
createDefault() - Static method in interface studio.mevera.imperat.responses.ResponseRegistry
 
createDefault(CommandPathway<S>) - Static method in interface studio.mevera.imperat.command.cooldown.CooldownHandler
 
createDummy() - Static method in interface studio.mevera.imperat.events.EventBus
Creates a new EventBus with default configuration.
createDummyContext(Imperat<S>) - Method in class studio.mevera.imperat.context.internal.ContextFactory
 
createDummySender() - Method in interface studio.mevera.imperat.SourceWrapper
 
createEmptyComponent() - Method in class studio.mevera.imperat.command.tree.help.theme.BaseHelpTheme
 
createEmptyComponent() - Method in interface studio.mevera.imperat.command.tree.help.theme.HelpTheme
 
createEmptyContent() - Method in class studio.mevera.imperat.command.tree.help.theme.BaseHelpTheme
 
createEmptyContent() - Method in class studio.mevera.imperat.command.tree.help.theme.TextBasedHelpTheme
 
createEntry(CommandPathway<S>) - Method in interface studio.mevera.imperat.command.tree.help.HelpEntryFactory
Creates a help entry from the given command pathway.
createExecutionContext(CommandContext<S>, CommandPathway<S>, Command<S>) - Method in class studio.mevera.imperat.context.internal.ContextFactory
Creates the execution context from a plain context with the matched pathway and last command.
createFor(Method) - Method in class studio.mevera.imperat.util.asm.DefaultMethodCallerFactory
 
createFor(Method) - Method in interface studio.mevera.imperat.util.asm.MethodCallerFactory
Creates a new MethodCaller for the specified method.
createInstance(ImperatConfig<S>, Class<T>) - Method in interface studio.mevera.imperat.annotations.base.InstanceFactory
Creates an instance of the specified class.
createNative(Command<S>) - Static method in class studio.mevera.imperat.command.suggestions.AutoCompleter
 
createNative(CommandPathway<S>) - Static method in interface studio.mevera.imperat.command.flags.FlagExtractor
 
createSuggestionContext(Imperat<S>, S, Command<S>, String, ArgumentInput) - Method in class studio.mevera.imperat.context.internal.ContextFactory
 
createSwitch(String, List<String>) - Static method in interface studio.mevera.imperat.context.FlagData
 
currentLetter() - Method in interface studio.mevera.imperat.context.internal.Cursor
Retrieves the character at the current cursor position wrapped in an Optional container.
currentLetterIfPresent() - Method in interface studio.mevera.imperat.context.internal.Cursor
Retrieves the character at the current cursor position within the current raw input string without advancing the cursor.
currentParameter() - Method in interface studio.mevera.imperat.context.internal.Cursor
Retrieves the command parameter at the current cursor position wrapped in an Optional container.
currentParameterIfPresent() - Method in interface studio.mevera.imperat.context.internal.Cursor
Retrieves the command parameter at the current cursor position without advancing the cursor.
currentParameterPosition() - Method in interface studio.mevera.imperat.context.internal.Cursor
Retrieves the current position index of the parameter cursor.
currentRaw() - Method in interface studio.mevera.imperat.context.internal.Cursor
Retrieves the raw input string at the current cursor position wrapped in an Optional container.
currentRawIfPresent() - Method in interface studio.mevera.imperat.context.internal.Cursor
Retrieves the raw input string at the current cursor position without advancing the cursor.
currentRawPosition() - Method in interface studio.mevera.imperat.context.internal.Cursor
Retrieves the current position index of the raw input cursor.
Cursor<S extends CommandSource> - Interface in studio.mevera.imperat.context.internal
Represents a cursor of command input that provides sequential access to command arguments, parameters, and individual characters.
CursorPosition<S extends CommandSource> - Class in studio.mevera.imperat.context.internal
 

D

data - Variable in class studio.mevera.imperat.command.tree.CommandNode
 
debug() - Method in class studio.mevera.imperat.BaseImperat
 
debug() - Method in interface studio.mevera.imperat.context.ExecutionContext
Debugs the current resolved arguments cached/mapped.
This requires ImperatDebugger to be enabled.
Example: ImperatDebugger.setEnabled(true)
debug() - Method in interface studio.mevera.imperat.Imperat
Debugs all registered commands and their usages.
debug(String, Object...) - Static method in class studio.mevera.imperat.util.ImperatDebugger
 
debugForTesting(String, Object...) - Static method in class studio.mevera.imperat.util.ImperatDebugger
 
debugParameters(String, List<Argument<S>>) - Static method in class studio.mevera.imperat.util.ImperatDebugger
 
decorate(Argument<S>, NumericRange) - Static method in class studio.mevera.imperat.annotations.parameters.NumericArgumentDecorator
 
decorate(Argument<S>, ParameterElement) - Static method in class studio.mevera.imperat.annotations.parameters.AnnotationArgumentDecorator
 
deduceOptionalValueSupplier(ParameterElement, Default, DefaultProvider, DefaultValueProvider) - Static method in class studio.mevera.imperat.annotations.base.AnnotationHelper
 
Default - Annotation Interface in studio.mevera.imperat.annotations.types
Specifies a literal default value for a parameter when no explicit input is provided.
defaultExecution(CommandExecution<S>) - Method in class studio.mevera.imperat.command.Command.Builder
 
DefaultExecutorServiceProvider - Class in studio.mevera.imperat.annotations.base
 
DefaultExecutorServiceProvider() - Constructor for class studio.mevera.imperat.annotations.base.DefaultExecutorServiceProvider
 
defaultFactory() - Static method in interface studio.mevera.imperat.annotations.base.InstanceFactory
Creates a default instance factory that uses the provided ImperatConfig for dependency resolution.
defaultFactory() - Static method in interface studio.mevera.imperat.command.tree.help.HelpEntryFactory
 
defaultFactory() - Static method in class studio.mevera.imperat.context.internal.ContextFactory
 
DefaultMethodCallerFactory - Class in studio.mevera.imperat.util.asm
 
DefaultMethodCallerFactory() - Constructor for class studio.mevera.imperat.util.asm.DefaultMethodCallerFactory
 
defaultParser(Imperat<S>) - Static method in class studio.mevera.imperat.annotations.base.AnnotationParser
 
DefaultProcessors - Class in studio.mevera.imperat.command.processors.impl
 
DefaultProcessors() - Constructor for class studio.mevera.imperat.command.processors.impl.DefaultProcessors
 
defaultProvider() - Static method in interface studio.mevera.imperat.command.tree.help.TreeHelpVisitor
 
DefaultProvider - Annotation Interface in studio.mevera.imperat.annotations.types
Declares an external class that provides/supplies a default value for a parameter when the user omits an input.
defaultSuggestionProvider(SuggestionProvider<S>) - Method in class studio.mevera.imperat.ConfigBuilder
Sets the default suggestion resolver for providing autocomplete suggestions for command arguments or parameters in the configuration.
defaultValue() - Method in interface studio.mevera.imperat.command.tree.help.theme.HelpTheme.Option
 
defaultValue(DefaultValueProvider) - Method in class studio.mevera.imperat.command.arguments.ArgumentBuilder
 
defaultValue(T) - Method in class studio.mevera.imperat.command.arguments.ArgumentBuilder
 
defaultValueProvider - Variable in class studio.mevera.imperat.command.arguments.InputArgument
 
DefaultValueProvider - Interface in studio.mevera.imperat.command.arguments
 
Dependency - Annotation Interface in studio.mevera.imperat.annotations.types
Marks a field to be injected with a dependency by the underlying framework.
dependencyResolver(Type, DependencySupplier) - Method in class studio.mevera.imperat.ConfigBuilder
Registers a dependency resolver for a specific type and returns the current ConfigBuilder instance.
DependencySupplier - Interface in studio.mevera.imperat.providers
A functional interface that supplies a generic dependency object.
depth(int, int) - Static method in class studio.mevera.imperat.command.tree.help.HelpFilters
Creates a filter based on pathway parameter count (depth).
describe(String) - Method in interface studio.mevera.imperat.command.DescriptionHolder
Sets the description for this entity using a string.
describe(Description) - Method in class studio.mevera.imperat.command.arguments.InputArgument
 
describe(Description) - Method in interface studio.mevera.imperat.command.DescriptionHolder
Sets the description for this entity.
description - Variable in class studio.mevera.imperat.command.arguments.ArgumentBuilder
 
description - Variable in class studio.mevera.imperat.command.arguments.InputArgument
 
description(Description) - Method in class studio.mevera.imperat.command.arguments.ArgumentBuilder
 
description(String) - Method in class studio.mevera.imperat.command.arguments.ArgumentBuilder
 
description(String) - Method in class studio.mevera.imperat.command.Command.Builder
 
description(Description) - Method in class studio.mevera.imperat.command.Command.Builder
 
description(Description) - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
Description - Class in studio.mevera.imperat.command
 
Description - Annotation Interface in studio.mevera.imperat.annotations.types
Attaches a human-readable description to a command, subcommand, or parameter.
DescriptionHolder - Interface in studio.mevera.imperat.command
Represents an entity that can have a description.
display() - Method in class studio.mevera.imperat.command.arguments.type.NumberArgument
 
display(HelpQuery<S>, HelpTheme<S, C>) - Method in class studio.mevera.imperat.command.tree.help.CommandHelp
Displays help using the provided query and theme.
DOUBLE_FLAG - Static variable in class studio.mevera.imperat.util.Patterns
 
DOUBLE_NUMERIC_COMPARATOR - Static variable in interface studio.mevera.imperat.command.NumericComparator
 
DOUBLE_QUOTE - Static variable in class studio.mevera.imperat.util.StringUtils
 

E

either(TypeWrap<Either<A, B>>, TypeWrap<A>, TypeWrap<B>) - Static method in class studio.mevera.imperat.command.arguments.type.ArgumentTypes
 
Either<A,B> - Class in studio.mevera.imperat.command.arguments
 
EitherArgument<S extends CommandSource,A,B> - Class in studio.mevera.imperat.command.arguments.type
 
EitherArgumentTypeHandler<S extends CommandSource> - Class in studio.mevera.imperat.command.arguments.type.handlers
Handler for resolving ArgumentType instances for Either types.
EitherArgumentTypeHandler() - Constructor for class studio.mevera.imperat.command.arguments.type.handlers.EitherArgumentTypeHandler
 
element - Variable in class studio.mevera.imperat.annotations.base.element.ParseElement
 
ElementSelector<E extends ParseElement<?>> - Interface in studio.mevera.imperat.annotations.base.element.selector
Selects a ParseElement based on a specific list of Rule
empty() - Static method in interface studio.mevera.imperat.command.arguments.DefaultValueProvider
 
empty() - Static method in class studio.mevera.imperat.command.arguments.NumericRange
 
empty() - Static method in interface studio.mevera.imperat.command.arguments.validator.ArgValidator
 
empty() - Static method in interface studio.mevera.imperat.command.CommandExecution
 
empty() - Static method in record class studio.mevera.imperat.command.tree.CommandNode.CompletionCache
 
empty() - Static method in class studio.mevera.imperat.command.tree.help.HelpEntryList
 
empty() - Static method in interface studio.mevera.imperat.context.ArgumentInput
 
empty() - Static method in class studio.mevera.imperat.permissions.CommandPermissionCondition
 
empty() - Static method in class studio.mevera.imperat.permissions.PermissionsData
 
EMPTY - Static variable in interface studio.mevera.imperat.command.arguments.DefaultValueProvider
 
EMPTY - Static variable in class studio.mevera.imperat.command.Description
 
EMPTY - Static variable in record class studio.mevera.imperat.command.suggestions.CompletionArg
 
endInput() - Method in interface studio.mevera.imperat.context.internal.Cursor
 
EnumArgument<S extends CommandSource> - Class in studio.mevera.imperat.command.arguments.type
 
EnumArgument(TypeWrap<Enum<?>>) - Constructor for class studio.mevera.imperat.command.arguments.type.EnumArgument
 
EnumArgumentTypeHandler<S extends CommandSource> - Class in studio.mevera.imperat.command.arguments.type.handlers
Handler for resolving ArgumentType instances for enum types.
EnumArgumentTypeHandler() - Constructor for class studio.mevera.imperat.command.arguments.type.handlers.EnumArgumentTypeHandler
 
equals(Object) - Method in class studio.mevera.imperat.annotations.base.element.ParameterElement
 
equals(Object) - Method in class studio.mevera.imperat.annotations.base.element.ParseElement
 
equals(Object) - Method in class studio.mevera.imperat.annotations.base.element.RootCommandClass
 
equals(Object) - Method in class studio.mevera.imperat.command.arguments.FlagArgumentImpl
 
equals(Object) - Method in class studio.mevera.imperat.command.arguments.InputArgument
 
equals(Object) - Method in class studio.mevera.imperat.command.cooldown.CooldownRecord
 
equals(Object) - Method in record class studio.mevera.imperat.command.suggestions.CompletionArg
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class studio.mevera.imperat.command.tree.CommandNode.CompletionCache
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class studio.mevera.imperat.command.tree.CommandNode
 
equals(Object) - Method in class studio.mevera.imperat.command.tree.help.HelpEntry
Compares this HelpEntry to another object for equality.
equals(Object) - Method in class studio.mevera.imperat.command.tree.help.HelpEntryList
 
equals(Object) - Method in record class studio.mevera.imperat.context.FlagData.FlagDataImpl
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class studio.mevera.imperat.context.internal.CursorPosition
 
equals(Object) - Method in class studio.mevera.imperat.context.internal.ParsedFlagArgument
 
equals(Object) - Method in record class studio.mevera.imperat.util.Pair
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class studio.mevera.imperat.util.priority.Priority
 
equals(Object) - Method in class studio.mevera.imperat.util.Registry
 
equalsExactly(Type) - Method in class studio.mevera.imperat.command.arguments.type.ArgumentType
Checks if the given type exactly matches this parameter type.
error(Class<?>, String, Throwable) - Static method in class studio.mevera.imperat.util.ImperatDebugger
 
error(Class<?>, String, Throwable, String) - Static method in class studio.mevera.imperat.util.ImperatDebugger
 
error(String) - Method in interface studio.mevera.imperat.context.CommandSource
Replies to the command sender with a string message formatted specifically for error messages
error(String, Object...) - Static method in class studio.mevera.imperat.util.ImperatDebugger
 
ERROR_HANDLING_METHOD_SELECTOR - Static variable in class studio.mevera.imperat.annotations.base.parsers.CommandClassParser
 
Event - Interface in studio.mevera.imperat.events
Base marker interface for all events that can be handled by the EventBus.
eventBus(EventBus) - Method in class studio.mevera.imperat.ConfigBuilder
Sets the event bus to be used for handling events within the configuration.
EventBus - Interface in studio.mevera.imperat.events
A high-performance, thread-safe event bus system with priority-based handler execution.
EventBus.Builder - Class in studio.mevera.imperat.events
Builder for creating configured EventBus instances.
EventException - Exception in studio.mevera.imperat.events.exception
 
EventException(E, EventSubscription<E>, Throwable) - Constructor for exception studio.mevera.imperat.events.exception.EventException
 
EventExceptionHandler - Interface in studio.mevera.imperat.events
A functional interface for handling exceptions that occur during event handler execution.
EventListener - Interface in studio.mevera.imperat.events
 
EventListenerConsumer<T extends Event> - Interface in studio.mevera.imperat.events
 
EventPublisher - Interface in studio.mevera.imperat.events
 
EventSubscription<T extends Event> - Interface in studio.mevera.imperat.events
Represents a single subscription to a specific event type on an EventBus.
examples() - Element in annotation interface studio.mevera.imperat.annotations.types.Execute
Example command usages to display in help output.
examples(String...) - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
examples(List<String>) - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
exceptionHandler(EventExceptionHandler) - Method in class studio.mevera.imperat.events.EventBus.Builder
Sets the global exception handler.
exceptionHandler(Class<T>, CommandExceptionHandler<T, S>) - Method in class studio.mevera.imperat.ConfigBuilder
Registers a throwable resolver for a specific exception type.
ExceptionHandler - Annotation Interface in studio.mevera.imperat.annotations.types
Declares a method as a handler for a specific Throwable type.
executableUsage - Variable in class studio.mevera.imperat.command.tree.CommandNode
 
execute(CommandContext<S>) - Method in class studio.mevera.imperat.BaseImperat
 
execute(CommandContext<S>) - Method in interface studio.mevera.imperat.Imperat
Dispatches and executes a command using CommandContext only
execute(S, String) - Method in class studio.mevera.imperat.BaseImperat
 
execute(S, String) - Method in interface studio.mevera.imperat.Imperat
Dispatches the full command-line
execute(S, String, String) - Method in class studio.mevera.imperat.BaseImperat
 
execute(S, String, String) - Method in interface studio.mevera.imperat.Imperat
Dispatches and executes a command with certain raw arguments
execute(S, String, String[]) - Method in interface studio.mevera.imperat.Imperat
Dispatches and executes a command with certain raw arguments
execute(S, String, String[]) - Method in class studio.mevera.imperat.BaseImperat
 
execute(S, Command<S>, String, String...) - Method in interface studio.mevera.imperat.Imperat
Dispatches and executes a command with certain raw arguments using Command
execute(S, Command<S>, String, String[]) - Method in class studio.mevera.imperat.BaseImperat
 
execute(S, ExecutionContext<S>) - Method in class studio.mevera.imperat.annotations.base.MethodCommandExecutor
Executes the command's actions
execute(S, ExecutionContext<S>) - Method in interface studio.mevera.imperat.command.CommandExecution
Executes the command's actions
execute(CommandExecution<S>) - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
execute(ExecutionContext<S>) - Method in interface studio.mevera.imperat.command.Command
Traverses the CommandTree linked to this command object, directly executing the most suitable pathway that matches the context input by the user.
execute(ExecutionContext<S>, ArgumentInput) - Method in interface studio.mevera.imperat.command.tree.CommandTree
Directly traverses the tree and executes the matching pathway in one step.
execute(Imperat<S>, S, ExecutionContext<S>) - Method in interface studio.mevera.imperat.command.CommandPathway
Executes the usage's actions using the supplied CommandCoordinator
Execute - Annotation Interface in studio.mevera.imperat.annotations.types
Declares a command usage method and provides example invocations for help output.
ExecutionContext<S extends CommandSource> - Interface in studio.mevera.imperat.context
Represents the execution context for a command, responsible for resolving and managing command arguments, flags, and their values during command execution.
ExecutionResult<S extends CommandSource> - Class in studio.mevera.imperat.context
Represents the result of a command execution operation in the Imperat framework.
ExecutionStrategy - Enum Class in studio.mevera.imperat.events
Defines the execution strategy for event handlers registered with the EventBus.
executorService(ExecutorService) - Method in class studio.mevera.imperat.events.EventBus.Builder
Sets a custom ExecutorService for async handler execution.
ExecutorServiceProvider - Interface in studio.mevera.imperat.annotations.base
 
exemptParameter(Argument<S>) - Method in interface studio.mevera.imperat.context.internal.Cursor
Marks the specified parameter as exempt from normal processing.
ExplicitReturnResolver - Annotation Interface in studio.mevera.imperat.annotations.types
Annotation to mark a method as a return value resolver for a command.
ExternalSubCommand - Annotation Interface in studio.mevera.imperat.annotations.types
Declares external subcommand classes that should be attached to the annotated command container.
extract(String) - Method in interface studio.mevera.imperat.command.flags.FlagExtractor
Extracts all flags used from a single string with no spaces.
extractType(int) - Method in class studio.mevera.imperat.util.TypeCapturer
Extract generic parameter type from this class's direct superclass.
extractType(Class<?>, int) - Method in class studio.mevera.imperat.util.TypeCapturer
Extract generic parameter type from a specific superclass/interface in the hierarchy.

F

failed(Throwable) - Static method in class studio.mevera.imperat.command.tree.ParseResult
 
failure(Throwable, CommandContext<S>) - Static method in class studio.mevera.imperat.context.ExecutionResult
Creates a failed execution result with the provided error information.
failure(BiConsumer<AnnotationParser<?>, T>) - Method in class studio.mevera.imperat.annotations.base.element.selector.Rule.Builder
 
failure(CommandContext<S>) - Static method in class studio.mevera.imperat.context.ExecutionResult
Creates a failed execution result without specific error information.
fallbackOrMapPrimary(Function<A, B>) - Method in class studio.mevera.imperat.command.arguments.Either
 
fetch(Supplier<String>) - Method in interface studio.mevera.imperat.responses.ResponseContentFetcher
 
FieldAccessor<T> - Interface in studio.mevera.imperat.util.reflection
An interface for retrieving the field content.
filter(HelpFilter<S>) - Method in class studio.mevera.imperat.command.tree.help.HelpQuery.Builder
Adds a filter to the queue of filters.
filter(CommandPathway<S>) - Method in interface studio.mevera.imperat.command.tree.help.HelpFilter
Determines whether a pathway should be included in help results.
findClass(String...) - Static method in class studio.mevera.imperat.util.reflection.Reflections
Finds any Class of the provided paths
findClass(Supplier<Class<?>>) - Static method in class studio.mevera.imperat.util.reflection.Reflections
 
findNode(Predicate<CommandNode<S, ?>>) - Method in class studio.mevera.imperat.command.tree.CommandNode
 
findNodeForPathway(CommandPathway<S>) - Method in class studio.mevera.imperat.command.tree.LiteralCommandNode
 
flag - Variable in class studio.mevera.imperat.command.arguments.InputArgument
 
flag(String, ArgumentType<S, T>) - Static method in interface studio.mevera.imperat.command.arguments.Argument
 
flag(FlagData<S>) - Static method in class studio.mevera.imperat.command.arguments.type.ArgumentTypes
 
Flag - Annotation Interface in studio.mevera.imperat.annotations.types
Declares one or more flag names for a parameter or type.
FLAG_OUTSIDE_SCOPE - Static variable in interface studio.mevera.imperat.responses.ResponseKey
 
FlagArgument<S extends CommandSource> - Interface in studio.mevera.imperat.command.arguments
 
FlagArgumentBuilder<S extends CommandSource,T> - Class in studio.mevera.imperat.command.arguments
 
FlagArgumentImpl<S extends CommandSource> - Class in studio.mevera.imperat.command.arguments
 
FlagArgumentType<S extends CommandSource> - Class in studio.mevera.imperat.command.arguments.type
 
FlagArgumentType(FlagData<S>) - Constructor for class studio.mevera.imperat.command.arguments.type.FlagArgumentType
 
flagData() - Method in interface studio.mevera.imperat.command.arguments.FlagArgument
 
flagData() - Method in class studio.mevera.imperat.command.arguments.FlagArgumentImpl
 
FlagData<S extends CommandSource> - Interface in studio.mevera.imperat.context
Represents a flag that has been parsed/read/loaded from a context of a command entered by the CommandSource
FlagData.FlagDataImpl<S extends CommandSource> - Record Class in studio.mevera.imperat.context
 
FlagDataImpl(String, List<String>, ArgumentType<S, ?>) - Constructor for record class studio.mevera.imperat.context.FlagData.FlagDataImpl
Creates an instance of a FlagDataImpl record class.
flagDefaultInputValue(DefaultValueProvider) - Method in class studio.mevera.imperat.command.arguments.FlagArgumentBuilder
 
FlagExtractor<S extends CommandSource> - Interface in studio.mevera.imperat.command.flags
A class that extracts flags from a single string/argument.
flagLookup() - Method in record class studio.mevera.imperat.command.tree.CommandNode.CompletionCache
Returns the value of the flagLookup record component.
FlagRegistrar<S extends CommandSource> - Interface in studio.mevera.imperat
The FlagRegistrar interface is responsible for managing the registration and retrieval of free flags in the Imperat command framework.
flagSwitch(String) - Static method in interface studio.mevera.imperat.command.arguments.Argument
 
FLOAT_NUMERIC_COMPARATOR - Static variable in interface studio.mevera.imperat.command.NumericComparator
 
forCommand(Command<S>) - Static method in interface studio.mevera.imperat.providers.SuggestionProvider
 
forDefaultFlag(FlagArgument<S>, String, Object) - Static method in class studio.mevera.imperat.context.internal.ParsedFlagArgument
 
forDefaultSwitch(FlagArgument<S>) - Static method in class studio.mevera.imperat.context.internal.ParsedFlagArgument
 
forEach(Consumer<? super E>) - Method in class studio.mevera.imperat.util.priority.PriorityList
Performs the given action for each element in priority order.
forFlag(FlagArgument<S>, String, String, int, int, Object) - Static method in class studio.mevera.imperat.context.internal.ParsedFlagArgument
 
format - Variable in class studio.mevera.imperat.command.arguments.InputArgument
 
format() - Method in class studio.mevera.imperat.annotations.parameters.AnnotationArgumentDecorator
Formats the usage parameter*
format() - Method in class studio.mevera.imperat.annotations.parameters.NumericArgumentDecorator
Formats the usage parameter using the command
format() - Method in interface studio.mevera.imperat.command.arguments.Argument
Formats the usage parameter, the default value is the name of the parameter
format() - Method in class studio.mevera.imperat.command.arguments.FlagArgumentImpl
 
format() - Method in class studio.mevera.imperat.command.arguments.InputArgument
 
format() - Method in interface studio.mevera.imperat.command.Command
Formats the usage parameter
format() - Method in class studio.mevera.imperat.command.tree.ArgumentNode
 
format() - Method in class studio.mevera.imperat.command.tree.CommandNode
 
format() - Method in class studio.mevera.imperat.command.tree.LiteralCommandNode
 
format() - Method in interface studio.mevera.imperat.context.FlagData
 
format(String, CommandPathway<S>) - Static method in interface studio.mevera.imperat.command.CommandPathway
 
format(Command<S>, CommandPathway<S>) - Static method in interface studio.mevera.imperat.command.CommandPathway
 
format(Command<S>, CommandPathway<S>, ExecutionContext<S>, HelpTheme<S, C>) - Method in interface studio.mevera.imperat.command.tree.help.renderers.UsageFormatter
Formats a command usage pathway into a help component.
Format - Annotation Interface in studio.mevera.imperat.annotations.types
Specifies a format string for parsing and displaying the annotated parameter.
formatClosestUsage(String, String, CommandPathway<S>) - Static method in class studio.mevera.imperat.util.UsageFormatting
 
formatInput(String, String, String) - Static method in class studio.mevera.imperat.util.UsageFormatting
 
formatted() - Method in interface studio.mevera.imperat.command.CommandPathway
 
formattedId() - Method in interface studio.mevera.imperat.placeholders.Placeholder
 
formatWithTypes(Command<S>, CommandPathway<S>) - Static method in interface studio.mevera.imperat.command.CommandPathway
 
forSwitch(FlagArgument<S>, String, int) - Static method in class studio.mevera.imperat.context.internal.ParsedFlagArgument
 
fromText(String) - Static method in class studio.mevera.imperat.permissions.CommandPermissionCondition
 
fromText(String) - Static method in class studio.mevera.imperat.permissions.PermissionsData
 
future(TypeWrap<CompletableFuture<T>>, ArgumentType<S, T>) - Static method in class studio.mevera.imperat.command.arguments.type.ArgumentTypes
 

G

get(int) - Method in class studio.mevera.imperat.command.tree.help.HelpEntryList
Gets an entry by index.
get(Object) - Method in interface studio.mevera.imperat.util.reflection.FieldAccessor
Retrieve the content of a field.
get(String) - Method in interface studio.mevera.imperat.placeholders.PlaceholderDataProvider
 
getAll() - Method in class studio.mevera.imperat.util.Registry
 
getAllShortcuts() - Method in interface studio.mevera.imperat.command.Command
 
getAnnotatedElement() - Method in interface studio.mevera.imperat.command.Command
 
getAnnotation(Class<T>) - Method in class studio.mevera.imperat.annotations.base.element.ParseElement
Returns this element's annotation for the specified valueType if such an annotation is present, else null.
getAnnotation(Class<A>) - Method in interface studio.mevera.imperat.annotations.parameters.AnnotatedArgument
Get the instance of specific annotation
getAnnotation(Class<A>) - Method in class studio.mevera.imperat.annotations.parameters.AnnotationArgumentDecorator
Get the instance of specific annotation
getAnnotationParser() - Method in interface studio.mevera.imperat.AnnotationInjector
Fetches the annotation parser
getAnnotationParser() - Method in class studio.mevera.imperat.BaseImperat
 
getAnnotationReplacer(Class<A>) - Method in class studio.mevera.imperat.annotations.base.AnnotationParser
Fetches the AnnotationReplacer mapped to the entered annotation valueType.
getAnnotations() - Method in class studio.mevera.imperat.annotations.base.element.ParseElement
Returns annotations that are present on this element.
getAnnotations() - Method in interface studio.mevera.imperat.annotations.parameters.AnnotatedArgument
 
getAnnotations() - Method in class studio.mevera.imperat.annotations.parameters.AnnotationArgumentDecorator
 
getArgToComplete() - Method in interface studio.mevera.imperat.context.SuggestionContext
 
getArgument() - Method in class studio.mevera.imperat.command.tree.ParseResult
 
getArgument(String) - Method in interface studio.mevera.imperat.context.ExecutionContext
Gets a resolved command argument by its parameter name.
getArgumentAt(int) - Method in interface studio.mevera.imperat.command.CommandPathway
Fetches the parameter at the index
getArgumentAt(Predicate<Argument<S>>) - Method in interface studio.mevera.imperat.command.CommandPathway
 
getArgumentName() - Method in class studio.mevera.imperat.context.ParsedArgument
 
getArgumentOr(String, T) - Method in interface studio.mevera.imperat.context.ExecutionContext
Gets a resolved argument or returns a default value if not present.
getArgumentParsedValue() - Method in class studio.mevera.imperat.context.ParsedArgument
 
getArgumentRawInput() - Method in class studio.mevera.imperat.context.internal.ParsedFlagArgument
The raw input for this flag argument, e.g.
getArgumentRawInput() - Method in class studio.mevera.imperat.context.ParsedArgument
 
getArguments() - Method in interface studio.mevera.imperat.command.CommandPathway
 
getArgumentType(Type) - Method in interface studio.mevera.imperat.ImperatConfig
Fetches ArgumentType for a certain value
getArgumentTypeRegistry() - Method in interface studio.mevera.imperat.ResolverRegistrar
Retrieves the ArgumentTypeRegistry associated with this registrar.
getArrayHandler() - Method in class studio.mevera.imperat.context.ArgumentTypeRegistry
 
getBoundMethodCaller() - Method in class studio.mevera.imperat.annotations.base.MethodCommandExecutor
 
getChild(Predicate<CommandNode<S, ?>>) - Method in class studio.mevera.imperat.command.tree.CommandNode
 
getChildElement(Predicate<ParseElement<?>>) - Method in class studio.mevera.imperat.annotations.base.element.ClassElement
 
getChildren() - Method in class studio.mevera.imperat.annotations.base.element.ClassElement
 
getChildren() - Method in class studio.mevera.imperat.command.tree.CommandNode
 
getClass(String) - Static method in class studio.mevera.imperat.util.reflection.Reflections
A nullable Class.forName(String) instead of throwing exceptions
getClosestUsage() - Method in class studio.mevera.imperat.command.tree.TreeExecutionResult
 
getClosestUsage() - Method in exception studio.mevera.imperat.exception.InvalidSyntaxException
 
getCollectionHandler() - Method in class studio.mevera.imperat.context.ArgumentTypeRegistry
 
getCommand() - Method in class studio.mevera.imperat.events.CommandEvent
Gets the command associated with this event.
getCommand() - Method in exception studio.mevera.imperat.exception.UnknownCommandException
 
getCommand(String) - Method in class studio.mevera.imperat.BaseImperat
 
getCommand(String) - Method in interface studio.mevera.imperat.CommandRegistrar
 
getCommand(Argument<S>) - Method in interface studio.mevera.imperat.CommandRegistrar
 
getCommandCoordinator() - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
getCommandParsingMode() - Method in interface studio.mevera.imperat.ImperatConfig
 
getCommandsUsed() - Method in interface studio.mevera.imperat.context.ExecutionContext
Gets all commands in the resolution path.
getCompletionCache() - Method in class studio.mevera.imperat.command.tree.CommandNode
 
getComponentType() - Method in class studio.mevera.imperat.util.TypeWrap
 
getComponentType(Type) - Static method in class studio.mevera.imperat.util.TypeUtility
 
getCondition() - Method in class studio.mevera.imperat.permissions.PermissionsData
 
getConstructor(Class<?>, Class<?>...) - Static method in class studio.mevera.imperat.util.reflection.Reflections
A nullable Class.getDeclaredConstructor(Class[]) instead of throwing exceptions
getContentFetcher() - Method in class studio.mevera.imperat.responses.Response
 
getContext() - Method in class studio.mevera.imperat.command.tree.help.CommandHelp
 
getContext() - Method in class studio.mevera.imperat.context.ExecutionResult
 
getContext() - Method in class studio.mevera.imperat.events.types.CommandPostProcessEvent
 
getContext() - Method in class studio.mevera.imperat.events.types.CommandPreProcessEvent
 
getContextArgument(Class<T>) - Method in interface studio.mevera.imperat.context.ExecutionContext
Gets an argument resolved by the context resolver system.
getContextArgumentProvider(Type) - Method in interface studio.mevera.imperat.ImperatConfig
Fetches ContextArgumentProvider for a certain valueType
getContextArgumentProvider(Type, ParameterElement) - Method in class studio.mevera.imperat.command.ContextArgumentProviderRegistry
 
getContextArgumentProvider(Argument<S>) - Method in interface studio.mevera.imperat.ImperatConfig
Fetches the ContextArgumentProvider suitable for the Argument
getContextArgumentProviderFactory(Type) - Method in interface studio.mevera.imperat.ImperatConfig
 
getContextArgumentProviderFor(ParameterElement) - Method in interface studio.mevera.imperat.ImperatConfig
Fetches the context resolver for ParameterElement of a method
getContextArgumentWithoutParameterElement(Type) - Method in class studio.mevera.imperat.command.ContextArgumentProviderRegistry
 
getContextFactory() - Method in interface studio.mevera.imperat.ImperatConfig
 
getCooldown() - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
getCooldown() - Method in interface studio.mevera.imperat.command.CooldownHolder
 
getCooldownHandler() - Method in interface studio.mevera.imperat.command.CommandPathway
 
getCoordinator() - Method in interface studio.mevera.imperat.command.CommandPathway
 
getCoordinator() - Method in class studio.mevera.imperat.command.tree.help.CommandHelp
 
getCoroutineScope() - Method in interface studio.mevera.imperat.ImperatConfig
 
getData() - Method in class studio.mevera.imperat.command.tree.CommandNode
 
getData(K) - Method in class studio.mevera.imperat.util.Registry
 
getDeclaredAnnotations() - Method in class studio.mevera.imperat.annotations.base.element.ParseElement
Returns annotations that are directly present on this element.
getDedicatedPathways() - Method in interface studio.mevera.imperat.command.Command
 
getDefaultPathway() - Method in interface studio.mevera.imperat.command.Command
 
getDefaultSuggestionResolver() - Method in interface studio.mevera.imperat.ResolverRegistrar
Retrieves the default suggestion resolver associated with this registrar.
getDefaultValueProvider() - Method in class studio.mevera.imperat.command.arguments.type.ArgumentType
Returns the default value supplier for the given source and command parameter.
getDefaultValueProvider() - Method in class studio.mevera.imperat.command.arguments.type.CompletableFutureArgument
 
getDefaultValueProvider() - Method in class studio.mevera.imperat.command.arguments.type.OptionalArgument
 
getDefaultValueSupplier() - Method in interface studio.mevera.imperat.command.arguments.Argument
 
getDefaultValueSupplier() - Method in class studio.mevera.imperat.command.arguments.FlagArgumentImpl
 
getDefaultValueSupplier() - Method in class studio.mevera.imperat.command.arguments.InputArgument
 
getDefaultValueSupplier() - Method in interface studio.mevera.imperat.command.Command
 
getDeniedPermissionHolder() - Method in class studio.mevera.imperat.command.tree.TreeExecutionResult
 
getDepth() - Method in class studio.mevera.imperat.command.tree.CommandNode
 
getDescription() - Method in class studio.mevera.imperat.command.arguments.InputArgument
 
getDescription() - Method in interface studio.mevera.imperat.command.Command
 
getDescription() - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
getDescription() - Method in interface studio.mevera.imperat.command.DescriptionHolder
Retrieves the current description associated with this entity.
getDetectedPathway() - Method in interface studio.mevera.imperat.context.ExecutionContext
Gets the command usage pattern that matched the input.
getElement() - Method in class studio.mevera.imperat.annotations.base.element.ParseElement
 
getError() - Method in class studio.mevera.imperat.context.ExecutionResult
Returns the error that caused the command execution to fail, if any.
getErrorHandlerFor(Class<T>) - Method in interface studio.mevera.imperat.ThrowableHandler
Retrieves the CommandExceptionHandler responsible for handling the specified valueType of throwable.
getEventBus() - Method in interface studio.mevera.imperat.ImperatConfig
 
getExamples() - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
getExamples() - Method in interface studio.mevera.imperat.command.CommandPathway
The pre-defined syntax examples for this usage.
getExceptionType() - Method in class studio.mevera.imperat.annotations.base.parsers.MethodCommandExceptionHandler
 
getExecutableUsage() - Method in class studio.mevera.imperat.command.tree.CommandNode
 
getExecutingPathway() - Method in exception studio.mevera.imperat.exception.PermissionDeniedException
 
getExecution() - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
getExecution() - Method in interface studio.mevera.imperat.command.CommandPathway
 
getExecutionContext() - Method in class studio.mevera.imperat.command.tree.TreeExecutionResult
 
getExecutionContext() - Method in class studio.mevera.imperat.context.ExecutionResult
Returns the execution context containing command execution data and environment.
getFactoryFor(Type) - Method in class studio.mevera.imperat.command.ContextArgumentProviderRegistry
 
getFailureCause() - Method in class studio.mevera.imperat.events.types.CommandPostRegistrationEvent
Gets the exception that caused the registration to fail.
getFallback() - Method in class studio.mevera.imperat.command.arguments.Either
 
getField(Class<?>, Class<T>) - Static method in class studio.mevera.imperat.util.reflection.Reflections
Retrieve a field accessor for a specific field valueType and name.
getField(Class<?>, Class<T>, int) - Static method in class studio.mevera.imperat.util.reflection.Reflections
Retrieve a field accessor for a specific field valueType and name.
getField(Class<?>, String, Class<T>) - Static method in class studio.mevera.imperat.util.reflection.Reflections
Retrieve a field accessor for a specific field valueType and name.
getField(String, Class<T>, int) - Static method in class studio.mevera.imperat.util.reflection.Reflections
Retrieve a field accessor for a specific field valueType and name.
getField(String, String, Class<T>) - Static method in class studio.mevera.imperat.util.reflection.Reflections
Retrieve a field accessor for a specific field valueType and name.
getFilters() - Method in class studio.mevera.imperat.command.tree.help.HelpQuery
Gets the queue of filters to apply to the help entries.
getFlag(String) - Method in interface studio.mevera.imperat.context.ExecutionContext
Retrieves a flag by its name if it was provided in the command input.
getFlagArguments() - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
getFlagExtractor() - Method in interface studio.mevera.imperat.command.CommandPathway
Retrieves the flag extractor instance for parsing command flags from input strings.
getFlagParameterFromRaw(String) - Method in interface studio.mevera.imperat.command.CommandPathway
Fetches the flag from the input
getFlagPosition() - Method in class studio.mevera.imperat.context.internal.ParsedFlagArgument
The position of the flag in the raw-input arguments from ArgumentInput
getFlagRawInput() - Method in class studio.mevera.imperat.context.internal.ParsedFlagArgument
The raw input for the flag, e.g.
getFlagValue(String) - Method in interface studio.mevera.imperat.context.ExecutionContext
Gets the resolved value of a command flag.
getFooter(ExecutionContext<S>) - Method in class studio.mevera.imperat.command.tree.help.theme.BaseHelpTheme
 
getFooter(ExecutionContext<S>) - Method in interface studio.mevera.imperat.command.tree.help.theme.HelpTheme
 
getFooterContent(ExecutionContext<S>) - Method in class studio.mevera.imperat.command.tree.help.theme.BaseHelpTheme
 
getGlobalCommandCoordinator() - Method in interface studio.mevera.imperat.ImperatConfig
 
getGlobalDefaultPathway() - Method in interface studio.mevera.imperat.ImperatConfig
 
getHeader(ExecutionContext<S>) - Method in class studio.mevera.imperat.command.tree.help.theme.BaseHelpTheme
 
getHeader(ExecutionContext<S>) - Method in interface studio.mevera.imperat.command.tree.help.theme.HelpTheme
 
getHeaderContent(ExecutionContext<S>) - Method in class studio.mevera.imperat.command.tree.help.theme.BaseHelpTheme
 
getHelpCoordinator() - Method in interface studio.mevera.imperat.ImperatConfig
 
getHighest(int, int) - Static method in class studio.mevera.imperat.util.Preconditions
 
getImperat() - Method in class studio.mevera.imperat.annotations.base.AnnotationParser
 
getInnerClassesInSourceOrder(Class<?>) - Static method in class studio.mevera.imperat.annotations.base.SourceOrderHelper
Gets inner classes (both static and non-static) based on @Priority annotations.
getInput() - Method in exception studio.mevera.imperat.exception.ArgumentParseException
 
getInputCount() - Method in class studio.mevera.imperat.annotations.base.element.MethodElement
 
getInputPosition() - Method in class studio.mevera.imperat.command.tree.ParseResult
 
getInputPosition() - Method in class studio.mevera.imperat.context.internal.ParsedFlagArgument
The position of the input value for this flag, or -1 if this flag is a switch
getInputPosition() - Method in class studio.mevera.imperat.context.ParsedArgument
 
getInsideGeneric(Type, Type) - Static method in class studio.mevera.imperat.util.TypeUtility
 
getInstanceFactory() - Method in interface studio.mevera.imperat.ImperatConfig
The factory for creating instances of types to be dependency injected.
getInvalidUsage() - Method in exception studio.mevera.imperat.exception.InvalidSyntaxException
 
getKey() - Method in class studio.mevera.imperat.responses.Response
 
getKey() - Method in interface studio.mevera.imperat.util.Keyed
 
getKeys() - Method in class studio.mevera.imperat.util.Registry
 
getLabel() - Method in exception studio.mevera.imperat.exception.PermissionDeniedException
 
getLastArg(ArgumentInput) - Static method in class studio.mevera.imperat.command.suggestions.AutoCompleter
 
getLastArgument() - Method in interface studio.mevera.imperat.command.CommandPathway
 
getLastCommand() - Method in class studio.mevera.imperat.command.tree.TreeExecutionResult
 
getLastTimeExecuted(S) - Method in interface studio.mevera.imperat.command.cooldown.CooldownHandler
Fetches the last time the command source executed a specific command usage
getLastUsedCommand() - Method in interface studio.mevera.imperat.context.ExecutionContext
Gets the most specific command that was resolved in this context.
getLeast(int, int) - Static method in class studio.mevera.imperat.util.Preconditions
 
getLevel() - Method in class studio.mevera.imperat.util.priority.Priority
 
getLimit() - Method in class studio.mevera.imperat.command.tree.help.HelpQuery
Gets the maximum number of help entries to return.
getMap() - Method in class studio.mevera.imperat.util.Registry
 
getMapHandler() - Method in class studio.mevera.imperat.context.ArgumentTypeRegistry
 
getMatchedPathway() - Method in class studio.mevera.imperat.command.tree.TreeExecutionResult
 
getMax() - Method in class studio.mevera.imperat.command.arguments.NumericRange
 
getMaxDepth() - Method in class studio.mevera.imperat.command.tree.help.HelpQuery
Gets the maximum depth to traverse the command tree when searching for help entries.
getMaxLength() - Method in interface studio.mevera.imperat.command.CommandPathway
 
getMethodElement() - Method in class studio.mevera.imperat.annotations.base.MethodCommandExecutor
 
getMethodElement() - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
getMethodElement() - Method in interface studio.mevera.imperat.command.CommandPathway
 
getMethodsInSourceOrder(Class<?>) - Static method in class studio.mevera.imperat.annotations.base.SourceOrderHelper
Gets methods in order based on @Priority value (lowest = first), and includes all methods if no annotation is present.
getMin() - Method in class studio.mevera.imperat.command.arguments.NumericRange
 
getMinLength() - Method in interface studio.mevera.imperat.command.CommandPathway
 
getModifiers() - Method in class studio.mevera.imperat.annotations.base.element.MethodElement
 
getName() - Method in class studio.mevera.imperat.annotations.base.element.ClassElement
 
getName() - Method in class studio.mevera.imperat.annotations.base.element.MethodElement
 
getName() - Method in class studio.mevera.imperat.annotations.base.element.ParameterElement
 
getName() - Method in class studio.mevera.imperat.annotations.base.element.ParseElement
 
getName() - Method in interface studio.mevera.imperat.command.arguments.Argument
 
getName() - Method in class studio.mevera.imperat.command.arguments.InputArgument
 
getName() - Method in class studio.mevera.imperat.command.arguments.type.CommandArgument
 
getName() - Method in interface studio.mevera.imperat.command.Command
 
getNearestExecutableUsage() - Method in class studio.mevera.imperat.command.tree.CommandNode
 
getNextCommandChild() - Method in class studio.mevera.imperat.command.tree.CommandNode
 
getNextDepth() - Method in class studio.mevera.imperat.command.tree.ParseResult
 
getNextParameterChild() - Method in class studio.mevera.imperat.command.tree.CommandNode
 
getNumberOfParametersToConsume() - Method in class studio.mevera.imperat.command.tree.CommandNode
 
getNumberOfParametersToConsume(Argument<S>) - Method in class studio.mevera.imperat.command.arguments.type.ArgumentType
Returns the number of arguments consumed by this parameter type.
getNumberOfParametersToConsume(Argument<S>) - Method in class studio.mevera.imperat.command.arguments.type.FlagArgumentType
 
getNumberOfParametersToConsume(Argument<S>) - Method in class studio.mevera.imperat.command.arguments.type.StringArgument
 
getObjectInstance() - Method in class studio.mevera.imperat.annotations.base.element.ClassElement
 
getOptionalValueSupplier(Class<? extends DefaultValueProvider>) - Static method in class studio.mevera.imperat.annotations.base.AnnotationHelper
 
getOptionValue(HelpTheme.Option<T>) - Method in class studio.mevera.imperat.command.tree.help.theme.BaseHelpTheme
 
getOptionValue(HelpTheme.Option<T>) - Method in interface studio.mevera.imperat.command.tree.help.theme.HelpTheme
 
getOr(int, String) - Method in interface studio.mevera.imperat.context.ArgumentInput
Fetches the element at the specified index
getOriginalArgument() - Method in class studio.mevera.imperat.context.ParsedArgument
 
getOriginalRaw() - Method in interface studio.mevera.imperat.context.ArgumentInput
 
getOwningClass() - Method in class studio.mevera.imperat.annotations.base.element.ParameterElement
 
getOwningCommand() - Method in exception studio.mevera.imperat.exception.ProcessorException
 
getParameter() - Method in class studio.mevera.imperat.context.internal.CursorPosition
 
getParameterAt(int) - Method in class studio.mevera.imperat.annotations.base.element.MethodElement
 
getParameterizedTypes() - Method in class studio.mevera.imperat.util.TypeWrap
 
getParameters() - Method in class studio.mevera.imperat.annotations.base.element.MethodElement
 
getParameters() - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
getParametersList() - Method in interface studio.mevera.imperat.context.internal.Cursor
Retrieves the complete list of command parameters associated with this cursor.
getParameterSuggestionResolver(Argument<S>) - Method in interface studio.mevera.imperat.ResolverRegistrar
Fetches the suggestion provider/resolver for a specific valueType of argument or parameter.
getParametersWithFlags() - Method in interface studio.mevera.imperat.command.CommandPathway
 
getParamName(ImperatConfig<S>, ParameterElement) - Static method in class studio.mevera.imperat.annotations.base.AnnotationHelper
 
getParamName(ImperatConfig<S>, ParameterElement, Named, Flag, Switch) - Static method in class studio.mevera.imperat.annotations.base.AnnotationHelper
 
getParent() - Method in class studio.mevera.imperat.annotations.base.element.MethodElement
 
getParent() - Method in class studio.mevera.imperat.annotations.base.element.ParseElement
 
getParent() - Method in interface studio.mevera.imperat.command.arguments.Argument
 
getParent() - Method in class studio.mevera.imperat.command.arguments.InputArgument
 
getParent() - Method in class studio.mevera.imperat.command.tree.CommandNode
 
getParsedArgument(String) - Method in interface studio.mevera.imperat.context.ExecutionContext
 
getParsedArgument(Command<S>, String) - Method in interface studio.mevera.imperat.context.ExecutionContext
Gets a resolved argument by its owning command and parameter name.
getParsedArguments() - Method in class studio.mevera.imperat.command.tree.TreeExecutionResult
 
getParsedArguments() - Method in interface studio.mevera.imperat.context.ExecutionContext
Gets all resolved arguments in input order.
getParsedArguments(Command<S>) - Method in interface studio.mevera.imperat.context.ExecutionContext
Gets all resolved arguments for a specific command.
getParsedClass() - Method in interface studio.mevera.imperat.annotations.base.AnnotationReader
 
getParsedElement() - Method in interface studio.mevera.imperat.annotations.parameters.AnnotatedArgument
 
getParsedElement() - Method in class studio.mevera.imperat.annotations.parameters.AnnotationArgumentDecorator
 
getParsedPathwayCommands() - Method in class studio.mevera.imperat.annotations.base.parsers.PathwaySyntaxParser
 
getParsedValue() - Method in class studio.mevera.imperat.command.tree.ParseResult
 
getPathway() - Method in class studio.mevera.imperat.command.tree.help.HelpEntry
Retrieves the command usage pathway associated with this help entry.
getPermission() - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
getPermissionChecker() - Method in interface studio.mevera.imperat.ImperatConfig
 
getPermissionIssuer() - Method in exception studio.mevera.imperat.exception.PermissionDeniedException
 
getPermissions() - Method in class studio.mevera.imperat.permissions.PermissionsData
 
getPermissionsData() - Method in class studio.mevera.imperat.command.arguments.InputArgument
 
getPermissionsData() - Method in class studio.mevera.imperat.command.tree.CommandNode
 
getPermissionsData() - Method in interface studio.mevera.imperat.permissions.PermissionHolder
 
getPlaceHolder(String) - Method in interface studio.mevera.imperat.ImperatConfig
The id/format of this placeholder, must be unique and lowercase
getPlaceholderDataProvider() - Method in exception studio.mevera.imperat.exception.ResponseException
 
getPlatform() - Method in interface studio.mevera.imperat.Imperat
 
getPosition() - Method in interface studio.mevera.imperat.command.arguments.Argument
 
getPosition() - Method in class studio.mevera.imperat.command.arguments.InputArgument
 
getPostProcessors() - Method in interface studio.mevera.imperat.command.Command
 
getPreProcessors() - Method in interface studio.mevera.imperat.command.Command
 
getPrimary() - Method in class studio.mevera.imperat.command.arguments.Either
 
getPrimaryPermission() - Method in interface studio.mevera.imperat.permissions.PermissionHolder
 
getPriority() - Method in class studio.mevera.imperat.command.arguments.type.ArgumentType
 
getPriority() - Method in class studio.mevera.imperat.command.arguments.type.BooleanArgument
 
getPriority() - Method in class studio.mevera.imperat.command.arguments.type.handlers.ArrayArgumentTypeHandler
 
getPriority() - Method in class studio.mevera.imperat.command.arguments.type.handlers.CollectionArgumentTypeHandler
 
getPriority() - Method in class studio.mevera.imperat.command.arguments.type.handlers.CompletableFutureArgumentTypeHandler
 
getPriority() - Method in class studio.mevera.imperat.command.arguments.type.handlers.EitherArgumentTypeHandler
 
getPriority() - Method in class studio.mevera.imperat.command.arguments.type.handlers.EnumArgumentTypeHandler
 
getPriority() - Method in class studio.mevera.imperat.command.arguments.type.handlers.MapArgumentTypeHandler
 
getPriority() - Method in class studio.mevera.imperat.command.arguments.type.handlers.NumericArgumentTypeHandler
 
getPriority() - Method in class studio.mevera.imperat.command.arguments.type.handlers.OptionalArgumentTypeHandler
 
getPriority() - Method in class studio.mevera.imperat.command.arguments.type.SimpleTypeResolver
 
getPriority() - Method in class studio.mevera.imperat.command.arguments.type.StringArgument
 
getPriority() - Method in interface studio.mevera.imperat.command.arguments.validator.ArgValidator
 
getPriority() - Method in class studio.mevera.imperat.command.arguments.validator.ConstrainedValueValidator
 
getPriority() - Method in interface studio.mevera.imperat.command.processors.CommandProcessor
Returns the priority of the command processor.
getPriority() - Method in class studio.mevera.imperat.command.tree.ArgumentNode
 
getPriority() - Method in class studio.mevera.imperat.command.tree.LiteralCommandNode
 
getPriority() - Method in interface studio.mevera.imperat.util.priority.Prioritizable
 
getProcessorType() - Method in exception studio.mevera.imperat.exception.ProcessorException
 
getRange() - Method in class studio.mevera.imperat.annotations.parameters.NumericArgumentDecorator
 
getRange() - Method in interface studio.mevera.imperat.command.arguments.NumericArgument
 
getRaw() - Method in class studio.mevera.imperat.context.internal.CursorPosition
 
getRawArgument(int) - Method in interface studio.mevera.imperat.context.ExecutionContext
Gets the raw string input for an argument by its position.
getRawInput() - Method in class studio.mevera.imperat.command.tree.ParseResult
 
getRawQueue() - Method in interface studio.mevera.imperat.context.internal.Cursor
Retrieves the underlying queue containing all raw input strings.
getRawType() - Method in class studio.mevera.imperat.util.TypeWrap
 
getRegisteredCommands() - Method in class studio.mevera.imperat.BaseImperat
Gets all registered commands
getRegisteredCommands() - Method in interface studio.mevera.imperat.CommandRegistrar
Gets all registered commands
getRegisteredFlags() - Method in interface studio.mevera.imperat.FlagRegistrar
Retrieves all registered flags in the system.
getResolvedFlags() - Method in interface studio.mevera.imperat.context.ExecutionContext
Gets all flags that were resolved from the command input.
getResolver(Type) - Method in class studio.mevera.imperat.context.ArgumentTypeRegistry
Resolves an ArgumentType for the given type.
getResponse(ResponseKey) - Method in interface studio.mevera.imperat.responses.ResponseRegistry
 
getResponseKey() - Method in exception studio.mevera.imperat.exception.ResponseException
Guaranteed non-null — every ResponseException must carry a key.
getResponseRegistry() - Method in interface studio.mevera.imperat.ResolverRegistrar
Retrieves the ResponseRegistry associated with this registrar.
getReturnResolver(Type) - Method in class studio.mevera.imperat.command.ReturnResolverRegistry
 
getReturnResolver(MethodElement) - Method in interface studio.mevera.imperat.ResolverRegistrar
Fetches the ReturnResolver from an internal registry.
getReturnType() - Method in class studio.mevera.imperat.annotations.base.element.MethodElement
 
getRootClass() - Method in interface studio.mevera.imperat.annotations.base.AnnotationReader
 
getRootCommandLabelUsed() - Method in interface studio.mevera.imperat.context.CommandContext
 
getRootUsagePredicate() - Method in class studio.mevera.imperat.command.tree.help.HelpQuery
 
getRules() - Method in interface studio.mevera.imperat.annotations.base.element.selector.ElementSelector
 
getShortcut(String) - Method in interface studio.mevera.imperat.command.Command
 
getShortcuts() - Method in interface studio.mevera.imperat.command.Command
 
getSimpleName() - Method in class studio.mevera.imperat.annotations.base.element.ClassElement
 
getSnowflake(String) - Static method in class studio.mevera.imperat.util.StringUtils
 
getSourceProviderFor(Type) - Method in interface studio.mevera.imperat.ResolverRegistrar
Fetches the SourceProvider from an internal registry.
getSpecificReturnResolver() - Method in class studio.mevera.imperat.annotations.base.element.MethodElement
 
getStatus() - Method in class studio.mevera.imperat.command.tree.TreeExecutionResult
 
getSubCommand(String, boolean) - Method in interface studio.mevera.imperat.command.Command
 
getSubCommand(String, String) - Method in class studio.mevera.imperat.BaseImperat
 
getSubCommand(String, String) - Method in interface studio.mevera.imperat.CommandRegistrar
 
getSubCommands() - Method in interface studio.mevera.imperat.command.Command
 
getSubscriptionCount(Class<? extends Event>) - Method in interface studio.mevera.imperat.events.EventBus
Returns the number of active subscriptions for the given exact event type.
getSuggestionProvider() - Method in class studio.mevera.imperat.command.arguments.type.ArgumentType
Returns the suggestion resolver associated with this parameter type.
getSuggestionProvider() - Method in class studio.mevera.imperat.command.arguments.type.CompletableFutureArgument
 
getSuggestionProvider() - Method in class studio.mevera.imperat.command.arguments.type.FlagArgumentType
 
getSuggestionProvider() - Method in class studio.mevera.imperat.command.arguments.type.OptionalArgument
 
getSuggestionProviderForType(Type) - Method in interface studio.mevera.imperat.ResolverRegistrar
Fetches the suggestion provider/resolver for a specific valueType of argument or parameter.
getSuggestionResolver() - Method in interface studio.mevera.imperat.command.arguments.Argument
Fetches the suggestion resolver linked to this command parameter.
getSuggestionResolver() - Method in class studio.mevera.imperat.command.arguments.InputArgument
Fetches the suggestion resolver linked to this command parameter.
getTargetType() - Method in class studio.mevera.imperat.command.arguments.type.SimpleTypeResolver
Returns the target type this resolver handles.
getThrowablePrinter() - Method in interface studio.mevera.imperat.ImperatConfig
 
getTotalSubscriptionCount() - Method in interface studio.mevera.imperat.events.EventBus
Returns the total number of active subscriptions across all event types.
getTreeExecutionResult() - Method in interface studio.mevera.imperat.context.ExecutionContext
 
getType() - Method in class studio.mevera.imperat.annotations.base.element.ParameterElement
 
getType() - Method in class studio.mevera.imperat.command.returns.BaseReturnResolver
 
getType() - Method in interface studio.mevera.imperat.command.returns.ReturnResolver
Returns the type of the return value.
getType() - Method in class studio.mevera.imperat.util.TypeWrap
 
getUsage(Predicate<CommandPathway<S>>) - Method in interface studio.mevera.imperat.command.Command
 
getUsageCooldown() - Method in interface studio.mevera.imperat.command.cooldown.CooldownHandler
The required of a usage
getUsageFormatter() - Method in interface studio.mevera.imperat.command.tree.help.theme.HelpTheme
 
getValidators() - Method in interface studio.mevera.imperat.command.arguments.Argument
 
getValidators() - Method in class studio.mevera.imperat.command.arguments.InputArgument
 
getValue() - Method in class studio.mevera.imperat.command.Description
 
getValueOrElse(String) - Method in class studio.mevera.imperat.command.Description
 
getVisualizationString() - Method in class studio.mevera.imperat.command.tree.CommandTreeVisualizer
 
getVisualizer() - Method in interface studio.mevera.imperat.command.Command
 
globalCoordinator(CommandCoordinator<S>) - Method in class studio.mevera.imperat.ConfigBuilder
 
globalDefaultPathwayBuilder(CommandPathway.Builder<S>) - Method in class studio.mevera.imperat.ConfigBuilder
Sets the global default usage builder that will be used for all commands that do not have their own specific usage builder configured.
greedy - Variable in class studio.mevera.imperat.command.arguments.InputArgument
 
Greedy - Annotation Interface in studio.mevera.imperat.annotations.types
Marks a parameter or type as greedy, consuming the remainder of the input instead of a single token (e.g., capturing full sentences).
greedyLimit() - Method in interface studio.mevera.imperat.command.arguments.Argument
Returns the token limit for a greedy string argument.

H

handle(E, Throwable, EventSubscription<E>) - Method in interface studio.mevera.imperat.events.EventExceptionHandler
Handles an exception that occurred during event handler execution.
handle(TreeExecutionResult<S>, ExecutionContext<S>, Cursor<S>) - Method in interface studio.mevera.imperat.context.internal.ArgumentHandler
 
handle(TreeExecutionResult<S>, ExecutionContext<S>, Cursor<S>) - Method in class studio.mevera.imperat.context.internal.OptionalArgumentHandler
 
handle(CommandContext<S>) - Method in exception studio.mevera.imperat.exception.SelfHandlingException
Handles the exception
handle(ExecutionContext<S>, MethodElement, T) - Method in interface studio.mevera.imperat.command.returns.ReturnResolver
Handles the return value of a command.
handleExecutionError(E, CommandContext<S>, Class<?>, String) - Method in interface studio.mevera.imperat.BaseThrowableHandler
Handles exceptions that occur during command execution by traversing the exception cause chain and applying appropriate resolution strategies.
handleExecutionError(E, CommandContext<S>, Class<?>, String) - Method in interface studio.mevera.imperat.ThrowableHandler
Handles a given throwable by finding the appropriate exception handler or using a default handling strategy if no specific handler is found.
handleExecutionMiddleOptionalSkipping() - Method in interface studio.mevera.imperat.ImperatConfig
Whether to handle the skipping of consecutive optional argument during execution For example if you have `/test [a] [b]` where parameter 'a' is of type String and parameter 'b' is of type Integer.
handleMiddleOptionalArgSkipping(boolean) - Method in class studio.mevera.imperat.ConfigBuilder
handler() - Method in interface studio.mevera.imperat.events.EventSubscription
Returns the handler consumer that processes events for this subscription.
handleRemainingParsing(TreeExecutionResult<S>) - Method in interface studio.mevera.imperat.context.ExecutionContext
 
has(String) - Static method in class studio.mevera.imperat.permissions.CommandPermissionCondition
 
has(S, PermissionChecker<S>) - Method in class studio.mevera.imperat.permissions.CommandPermissionCondition
 
HAS_A_MAIN_ANNOTATION - Static variable in interface studio.mevera.imperat.annotations.base.element.selector.MethodRules
 
HAS_EXCEPTION_HANDLER_ANNOTATION - Static variable in interface studio.mevera.imperat.annotations.base.element.selector.MethodRules
 
HAS_EXCEPTION_HANDLER_PARAMS_IN_ORDER - Static variable in interface studio.mevera.imperat.annotations.base.element.selector.MethodRules
 
HAS_KNOWN_SENDER - Static variable in interface studio.mevera.imperat.annotations.base.element.selector.MethodRules
 
hasAlias(String) - Method in interface studio.mevera.imperat.context.FlagData
 
hasAnnotation(Class<? extends Annotation>) - Method in interface studio.mevera.imperat.annotations.parameters.AnnotatedArgument
 
hasAnnotationReplacerFor(Class<? extends Annotation>) - Method in class studio.mevera.imperat.annotations.base.AnnotationParser
Checks if the specific valueType of annotation entered has a AnnotationReplacer for it in the internal registry for replacers
hasArgumentType(Type) - Method in interface studio.mevera.imperat.ImperatConfig
 
hasContextResolver(Type) - Method in interface studio.mevera.imperat.ImperatConfig
Checks whether the valueType has a registered context-resolver
hasCooldown(S) - Method in interface studio.mevera.imperat.command.cooldown.CooldownHandler
Checks if there's a cooldown on the usage for a specific command sender
hasCoroutineScope() - Method in interface studio.mevera.imperat.ImperatConfig
 
hasFailed() - Method in class studio.mevera.imperat.context.ExecutionResult
Determines whether this execution result represents a failed command execution.
hasField(Object) - Method in interface studio.mevera.imperat.util.reflection.FieldAccessor
Determine if the given object has this field.
hasFinished() - Method in interface studio.mevera.imperat.context.internal.Cursor
 
hasFlag(String) - Method in interface studio.mevera.imperat.command.CommandPathway
Checks whether the raw input is a flag registered by this usage
hasGenericType(Type, Type) - Static method in class studio.mevera.imperat.util.TypeUtility
 
hashCode() - Method in class studio.mevera.imperat.annotations.base.element.ParameterElement
 
hashCode() - Method in class studio.mevera.imperat.annotations.base.element.ParseElement
 
hashCode() - Method in class studio.mevera.imperat.annotations.base.element.RootCommandClass
 
hashCode() - Method in class studio.mevera.imperat.command.arguments.FlagArgumentImpl
 
hashCode() - Method in class studio.mevera.imperat.command.arguments.InputArgument
 
hashCode() - Method in class studio.mevera.imperat.command.cooldown.CooldownRecord
 
hashCode() - Method in record class studio.mevera.imperat.command.suggestions.CompletionArg
Returns a hash code value for this object.
hashCode() - Method in record class studio.mevera.imperat.command.tree.CommandNode.CompletionCache
Returns a hash code value for this object.
hashCode() - Method in class studio.mevera.imperat.command.tree.CommandNode
 
hashCode() - Method in class studio.mevera.imperat.command.tree.help.HelpEntry
Computes the hash code for this HelpEntry based on its pathway.
hashCode() - Method in class studio.mevera.imperat.command.tree.help.HelpEntryList
 
hashCode() - Method in record class studio.mevera.imperat.context.FlagData.FlagDataImpl
Returns a hash code value for this object.
hashCode() - Method in class studio.mevera.imperat.context.internal.CursorPosition
 
hashCode() - Method in class studio.mevera.imperat.context.internal.ParsedFlagArgument
 
hashCode() - Method in record class studio.mevera.imperat.util.Pair
Returns a hash code value for this object.
hashCode() - Method in class studio.mevera.imperat.util.priority.Priority
 
hashCode() - Method in class studio.mevera.imperat.util.Registry
 
hasMax() - Method in class studio.mevera.imperat.command.arguments.NumericRange
 
hasMin() - Method in class studio.mevera.imperat.command.arguments.NumericRange
 
hasName(String) - Method in interface studio.mevera.imperat.command.Command
 
hasNextLetter() - Method in interface studio.mevera.imperat.context.internal.Cursor
Checks if there is another character available for reading in the current input string.
hasNextParameter() - Method in interface studio.mevera.imperat.context.internal.Cursor
Checks if there is a next command parameter available in the cursor.
hasNextRaw() - Method in interface studio.mevera.imperat.context.internal.Cursor
Checks if there is a next raw input string available in the cursor.
hasOptionalParam() - Static method in class studio.mevera.imperat.command.tree.help.HelpFilters
Creates a filter that only includes pathways containing at least one optional parameter.
hasParameters(Predicate<Argument<S>>) - Method in interface studio.mevera.imperat.command.CommandPathway
Searches for a parameter with specific valueType
hasParameters(List<Argument<S>>) - Method in interface studio.mevera.imperat.command.CommandPathway
 
hasParamType(Class<?>) - Method in interface studio.mevera.imperat.command.CommandPathway
 
hasParent() - Method in interface studio.mevera.imperat.command.Command
 
hasPermission(S, PermissionHolder) - Method in interface studio.mevera.imperat.permissions.PermissionChecker
 
hasPermission(S, String) - Method in interface studio.mevera.imperat.permissions.PermissionChecker
 
hasPermission(S, CommandHelp<S>) - Static method in class studio.mevera.imperat.command.tree.help.HelpFilters
Creates a filter that checks if a source has permission for the pathway.
hasPermission(S, CommandContext<S>) - Static method in class studio.mevera.imperat.command.tree.help.HelpFilters
Creates a filter that checks if a source has permission for the pathway.
hasPermission(S, PermissionChecker<S>) - Static method in class studio.mevera.imperat.command.tree.help.HelpFilters
Creates a filter that checks if a source has permission for the pathway.
hasPreviousParameter() - Method in interface studio.mevera.imperat.context.internal.Cursor
Checks if there is a previous command parameter available in the cursor.
hasPreviousRaw() - Method in interface studio.mevera.imperat.context.internal.Cursor
Checks if there is a previous raw input string available in the cursor.
hasRange() - Method in interface studio.mevera.imperat.command.arguments.NumericArgument
 
hasResolvedFlag(Argument<S>) - Method in interface studio.mevera.imperat.context.ExecutionContext
Checks if a flag parameter was resolved in this context.
hasResolvedFlag(FlagData<S>) - Method in interface studio.mevera.imperat.context.ExecutionContext
Checks if a flag was resolved in this context.
hasSourceResolver(Type) - Method in interface studio.mevera.imperat.ImperatConfig
 
HelpComponent<S extends CommandSource,C> - Class in studio.mevera.imperat.command.tree.help.theme
 
HelpComponent(C) - Constructor for class studio.mevera.imperat.command.tree.help.theme.HelpComponent
 
helpCoordinator(HelpCoordinator<S>) - Method in class studio.mevera.imperat.ConfigBuilder
Sets the HelpCoordinator that coordinates all the core-components of the new help API, to create a coordinator call HelpCoordinator.create()
HelpCoordinator<S extends CommandSource> - Class in studio.mevera.imperat.command.tree.help
 
HelpEntry<S extends CommandSource> - Class in studio.mevera.imperat.command.tree.help
Represents a final, immutable entry for a single executable command in the help system.
HelpEntryFactory<S extends CommandSource> - Interface in studio.mevera.imperat.command.tree.help
Factory interface for creating HelpEntry instances from command pathways.
HelpEntryList<S extends CommandSource> - Class in studio.mevera.imperat.command.tree.help
A custom list implementation that maintains insertion order, prevents duplicates, and supports indexing - implemented without using any Java collections.
HelpEntryList() - Constructor for class studio.mevera.imperat.command.tree.help.HelpEntryList
Creates a new HelpEntryList with default initial capacity.
HelpEntryList(int) - Constructor for class studio.mevera.imperat.command.tree.help.HelpEntryList
Creates a new HelpEntryList with specified initial capacity.
HelpFilter<S extends CommandSource> - Interface in studio.mevera.imperat.command.tree.help
A functional interface for filtering help entries during query operations.
HelpFilters - Class in studio.mevera.imperat.command.tree.help
Factory class providing common help filters based on CommandPathway.
HelpLayoutRenderer<S extends CommandSource,C> - Interface in studio.mevera.imperat.command.tree.help.renderers
Interface for rendering help documentation.
HelpQuery<S extends CommandSource> - Class in studio.mevera.imperat.command.tree.help
An immutable data class representing a query for help documentation.
HelpQuery.Builder<S extends CommandSource> - Class in studio.mevera.imperat.command.tree.help
A builder class for creating instances of HelpQuery.
HelpTheme<S extends CommandSource,C> - Interface in studio.mevera.imperat.command.tree.help.theme
A theme for help documentation generation and presentation.
HelpTheme.Option<T> - Interface in studio.mevera.imperat.command.tree.help.theme
 
HIGH - Static variable in class studio.mevera.imperat.util.priority.Priority
 

I

id() - Method in interface studio.mevera.imperat.command.tree.help.theme.HelpTheme.Option
 
id() - Method in interface studio.mevera.imperat.events.EventSubscription
Returns the unique identifier of this subscription.
id() - Method in interface studio.mevera.imperat.placeholders.Placeholder
The unique name for this placeholder
imperat - Variable in class studio.mevera.imperat.annotations.base.AnnotationParser
 
imperat - Variable in class studio.mevera.imperat.annotations.base.parsers.CommandClassParser
 
imperat() - Method in interface studio.mevera.imperat.command.Command
 
imperat() - Method in interface studio.mevera.imperat.context.CommandContext
 
Imperat<S extends CommandSource> - Interface in studio.mevera.imperat
Represents the class that handles all commands' registrations and executions It also caches the settings that the user can change or modify in the api.
imperatConfig() - Method in interface studio.mevera.imperat.context.CommandContext
 
ImperatConfig<S extends CommandSource> - Interface in studio.mevera.imperat
The ImperatConfig interface defines the core configuration and interaction points for a command processing system.
ImperatDebugger - Class in studio.mevera.imperat.util
 
index - Variable in class studio.mevera.imperat.command.arguments.InputArgument
 
index() - Method in record class studio.mevera.imperat.command.suggestions.CompletionArg
Returns the value of the index record component.
indexOf(HelpEntry<S>) - Method in class studio.mevera.imperat.command.tree.help.HelpEntryList
Returns the index of an entry.
InheritedArg - Annotation Interface in studio.mevera.imperat.annotations.types
Marks a parameter as inherited from an ancestor command's pathway.
InputArgument<S extends CommandSource> - Class in studio.mevera.imperat.command.arguments
 
InputArgument(String, ArgumentType<S, ?>, PermissionsData, Description, boolean, boolean, boolean, DefaultValueProvider, SuggestionProvider<S>) - Constructor for class studio.mevera.imperat.command.arguments.InputArgument
 
inputPosition - Variable in class studio.mevera.imperat.context.ParsedArgument
 
inputSuggestionResolver() - Method in interface studio.mevera.imperat.command.arguments.FlagArgument
 
inputSuggestionResolver() - Method in class studio.mevera.imperat.command.arguments.FlagArgumentImpl
 
inputType() - Method in record class studio.mevera.imperat.context.FlagData.FlagDataImpl
Returns the value of the inputType record component.
inputType() - Method in interface studio.mevera.imperat.context.FlagData
 
inputValueType() - Method in interface studio.mevera.imperat.command.arguments.FlagArgument
 
insertFlag(FlagArgument<S>) - Method in interface studio.mevera.imperat.command.flags.FlagExtractor
Inserts a flag during into the trie.
instance() - Method in interface studio.mevera.imperat.util.asm.MethodCaller.BoundMethodCaller
Get the instance bound to the method caller
INSTANCE - Static variable in class studio.mevera.imperat.util.asm.DefaultMethodCallerFactory
 
instanceFactory(InstanceFactory<S>) - Method in class studio.mevera.imperat.ConfigBuilder
Sets the instance factory used for creating instances of classes during command processing and dependency resolution.
InstanceFactory<S extends CommandSource> - Interface in studio.mevera.imperat.annotations.base
Functional interface for creating instances of a given class.
INTEGER_NUMERIC_COMPARATOR - Static variable in interface studio.mevera.imperat.command.NumericComparator
 
INVALID_BOOLEAN - Static variable in interface studio.mevera.imperat.responses.ResponseKey
 
INVALID_CHARACTER - Static variable in interface studio.mevera.imperat.responses.ResponseKey
 
INVALID_ENUM - Static variable in interface studio.mevera.imperat.responses.ResponseKey
 
INVALID_MAP_ENTRY_FORMAT - Static variable in interface studio.mevera.imperat.responses.ResponseKey
 
INVALID_NUMBER_FORMAT - Static variable in interface studio.mevera.imperat.responses.ResponseKey
 
INVALID_UUID - Static variable in interface studio.mevera.imperat.responses.ResponseKey
 
InvalidSourceException - Exception in studio.mevera.imperat.exception
 
InvalidSourceException(MethodElement, Type) - Constructor for exception studio.mevera.imperat.exception.InvalidSourceException
 
InvalidSyntaxException - Exception in studio.mevera.imperat.exception
Thrown when a command's syntax does not match any valid usage pathway.
InvalidSyntaxException(String, CommandPathway<S>) - Constructor for exception studio.mevera.imperat.exception.InvalidSyntaxException
 
IS_PROCESSOR - Static variable in interface studio.mevera.imperat.annotations.base.element.selector.MethodRules
 
IS_PUBLIC - Static variable in interface studio.mevera.imperat.annotations.base.element.selector.MethodRules
 
isAbnormalClass(Class<?>) - Static method in class studio.mevera.imperat.annotations.base.AnnotationHelper
 
isAbnormalClass(ParseElement<?>) - Static method in class studio.mevera.imperat.annotations.base.AnnotationHelper
Checks if the type is not a concrete class (Interface, enum, abstract class, etc.)
isAcceptableGreedyWrapper(Type) - Static method in class studio.mevera.imperat.util.TypeUtility
 
isAllOptionalInput() - Method in class studio.mevera.imperat.annotations.base.element.MethodElement
 
isAnnotated() - Method in interface studio.mevera.imperat.command.arguments.Argument
 
isAnnotated() - Method in interface studio.mevera.imperat.command.Command
 
isArray() - Method in class studio.mevera.imperat.util.TypeWrap
 
isBoolean(String) - Static method in class studio.mevera.imperat.util.TypeUtility
 
isBoxed(Type) - Static method in class studio.mevera.imperat.util.TypeUtility
 
isByte(String) - Static method in class studio.mevera.imperat.util.TypeUtility
 
isCancelled() - Method in interface studio.mevera.imperat.events.CancellableEvent
Checks if this event has been cancelled.
isCancelled() - Method in class studio.mevera.imperat.events.types.CommandPostProcessEvent
 
isCancelled() - Method in class studio.mevera.imperat.events.types.CommandPreProcessEvent
 
isCancelled() - Method in class studio.mevera.imperat.events.types.CommandPreRegistrationEvent
Checks whether the command registration has been canceled.
isCommand() - Method in class studio.mevera.imperat.annotations.base.element.RootCommandClass
 
isCommand() - Method in interface studio.mevera.imperat.command.arguments.Argument
 
isConsole() - Method in interface studio.mevera.imperat.context.CommandSource
 
isContextResolved() - Method in class studio.mevera.imperat.annotations.base.element.ParameterElement
 
isCurrentLetterAvailable() - Method in interface studio.mevera.imperat.context.internal.Cursor
Checks if there is a character available at the current cursor position within the current raw input string.
isCurrentParameterAvailable() - Method in interface studio.mevera.imperat.context.internal.Cursor
Checks if there is a command parameter available at the current cursor position.
isCurrentRawInputAvailable() - Method in interface studio.mevera.imperat.context.internal.Cursor
Checks if there is a raw input string available at the current cursor position.
isDefault() - Method in interface studio.mevera.imperat.command.CommandPathway
 
isDefault() - Method in class studio.mevera.imperat.context.internal.ParsedFlagArgument
Checks if this flag argument is a default value (i.e.
isDouble(String) - Static method in class studio.mevera.imperat.util.TypeUtility
 
isDoubleFlag(String) - Static method in class studio.mevera.imperat.util.Patterns
 
isDummyBus() - Method in interface studio.mevera.imperat.events.EventBus
Checks if this instance of event bus has no executor and no exception handler configured.
isEmpty() - Method in interface studio.mevera.imperat.command.arguments.DefaultValueProvider
 
isEmpty() - Method in class studio.mevera.imperat.command.arguments.NumericRange
 
isEmpty() - Method in class studio.mevera.imperat.command.Description
 
isEmpty() - Method in record class studio.mevera.imperat.command.suggestions.CompletionArg
 
isEmpty() - Method in class studio.mevera.imperat.command.tree.help.HelpEntryList
Checks if the list is empty.
isEmpty() - Method in class studio.mevera.imperat.permissions.PermissionsData
 
isEmpty() - Method in class studio.mevera.imperat.util.priority.PriorityList
Checks if this list is empty.
isEnabled() - Static method in class studio.mevera.imperat.util.ImperatDebugger
 
isEndOfQuote(char, char) - Static method in class studio.mevera.imperat.util.StringUtils
 
isEntryPointAnnotation(Class<? extends Annotation>) - Method in class studio.mevera.imperat.annotations.base.AnnotationParser
 
isExecutable() - Method in class studio.mevera.imperat.command.tree.CommandNode
 
isFailed() - Method in class studio.mevera.imperat.events.types.CommandPostRegistrationEvent
Checks if the command registration failed.
isFailure() - Method in class studio.mevera.imperat.command.tree.ParseResult
 
isFlag() - Method in class studio.mevera.imperat.annotations.parameters.AnnotationArgumentDecorator
 
isFlag() - Method in interface studio.mevera.imperat.command.arguments.Argument
 
isFlag() - Method in interface studio.mevera.imperat.command.arguments.FlagArgument
 
isFlag() - Method in class studio.mevera.imperat.command.arguments.InputArgument
 
isFlag() - Method in interface studio.mevera.imperat.command.Command
 
isFlag() - Method in class studio.mevera.imperat.command.tree.CommandNode
 
isFlagPosition(int) - Method in interface studio.mevera.imperat.context.SuggestionContext
Checks whether the current input at index is a flag
isFlagRegistered(String) - Method in interface studio.mevera.imperat.FlagRegistrar
 
isFloat(String) - Static method in class studio.mevera.imperat.util.TypeUtility
 
isGlobal() - Method in exception studio.mevera.imperat.exception.ProcessorException
 
isGreedy() - Method in interface studio.mevera.imperat.command.arguments.Argument
 
isGreedy() - Method in class studio.mevera.imperat.command.arguments.InputArgument
 
isGreedy() - Method in interface studio.mevera.imperat.command.Command
 
isGreedy(Argument<S>) - Method in class studio.mevera.imperat.command.arguments.type.ArgumentType
Determines if this parameter type is greedy, meaning it consumes multiple arguments.
isGreedy(Argument<S>) - Method in class studio.mevera.imperat.command.arguments.type.ArrayArgument
 
isGreedy(Argument<S>) - Method in class studio.mevera.imperat.command.arguments.type.CollectionArgument
 
isGreedy(Argument<S>) - Method in class studio.mevera.imperat.command.arguments.type.CompletableFutureArgument
 
isGreedy(Argument<S>) - Method in class studio.mevera.imperat.command.arguments.type.MapArgument
 
isGreedy(Argument<S>) - Method in class studio.mevera.imperat.command.arguments.type.OptionalArgument
 
isGreedy(Argument<S>) - Method in class studio.mevera.imperat.command.arguments.type.StringArgument
 
isGreedyParam() - Method in class studio.mevera.imperat.command.tree.ArgumentNode
 
isGreedyParam() - Method in class studio.mevera.imperat.command.tree.CommandNode
 
isGreedyString() - Method in interface studio.mevera.imperat.command.arguments.Argument
 
isGreedyString() - Method in class studio.mevera.imperat.command.arguments.InputArgument
 
isIgnoringACPerms() - Method in interface studio.mevera.imperat.command.Command
whether to ignore permission checks on the auto-completion of command and sub commands or not
isInputFlag(String) - Static method in class studio.mevera.imperat.util.Patterns
 
isInteger(String) - Static method in class studio.mevera.imperat.util.TypeUtility
 
isKnownAnnotation(Class<? extends Annotation>) - Method in class studio.mevera.imperat.annotations.base.AnnotationParser
Checks the internal registry whether the valueType of annotation entered is known/registered or not.
isLast() - Method in class studio.mevera.imperat.command.tree.CommandNode
 
isLast(ShiftTarget) - Method in class studio.mevera.imperat.context.internal.CursorPosition
 
isLiteral() - Method in class studio.mevera.imperat.command.tree.CommandNode
 
isLong(String) - Static method in class studio.mevera.imperat.util.TypeUtility
 
isNumber(String) - Static method in class studio.mevera.imperat.util.TypeUtility
 
isNumeric() - Method in interface studio.mevera.imperat.command.arguments.Argument
 
isNumericType(Class<?>) - Static method in class studio.mevera.imperat.util.TypeUtility
 
isNumericType(TypeWrap<?>) - Static method in class studio.mevera.imperat.util.TypeUtility
 
isOptional() - Method in class studio.mevera.imperat.annotations.base.element.ParameterElement
 
isOptional() - Method in interface studio.mevera.imperat.command.arguments.Argument
 
isOptional() - Method in class studio.mevera.imperat.command.arguments.InputArgument
 
isOptional() - Method in interface studio.mevera.imperat.command.Command
 
isOptional() - Method in class studio.mevera.imperat.command.tree.CommandNode
 
isOptionalParameterSuggestionOverlappingEnabled() - Method in interface studio.mevera.imperat.ImperatConfig
Determines whether multiple optional parameters can be suggested simultaneously during tab completion at the same command depth level.
isPrimitive() - Method in class studio.mevera.imperat.util.TypeWrap
 
isPrimitive(Type) - Static method in class studio.mevera.imperat.util.TypeUtility
 
isQuoteChar(char) - Static method in class studio.mevera.imperat.util.StringUtils
 
isRelatedToType(Type) - Method in class studio.mevera.imperat.command.arguments.type.ArgumentType
Checks if the given type is related to this parameter type.
isRequired() - Method in interface studio.mevera.imperat.command.arguments.Argument
 
isRequired() - Method in class studio.mevera.imperat.command.tree.CommandNode
 
isRoot() - Method in class studio.mevera.imperat.command.tree.CommandNode
 
isRootClass() - Method in class studio.mevera.imperat.annotations.base.element.ClassElement
 
isSecret() - Method in interface studio.mevera.imperat.command.Command
 
isSecret() - Method in class studio.mevera.imperat.command.tree.CommandNode
Whether this node represents a secret command.
isSecret() - Method in class studio.mevera.imperat.command.tree.LiteralCommandNode
 
isShort(String) - Static method in class studio.mevera.imperat.util.TypeUtility
 
isSingleFlag(String) - Static method in class studio.mevera.imperat.util.Patterns
 
isStaticClass() - Method in class studio.mevera.imperat.annotations.base.element.ClassElement
 
isSubCommand() - Method in interface studio.mevera.imperat.command.Command
 
isSubtypeOf(Type) - Method in class studio.mevera.imperat.util.TypeWrap
 
isSubtypeOf(TypeWrap<?>) - Method in class studio.mevera.imperat.util.TypeWrap
 
isSuccess() - Method in class studio.mevera.imperat.command.tree.TreeExecutionResult
 
isSuccessful() - Method in class studio.mevera.imperat.command.tree.ParseResult
 
isSuccessful() - Method in class studio.mevera.imperat.events.types.CommandPostRegistrationEvent
Checks if the command registration was successful.
isSupertypeOf(Type) - Method in class studio.mevera.imperat.util.TypeWrap
 
isSupertypeOf(TypeWrap<?>) - Method in class studio.mevera.imperat.util.TypeWrap
 
isSwitch() - Method in interface studio.mevera.imperat.command.arguments.FlagArgument
 
isSwitch() - Method in interface studio.mevera.imperat.context.FlagData
 
isSwitch() - Method in class studio.mevera.imperat.context.internal.ParsedFlagArgument
Checks if this flag argument is a switch (i.e.
isTesting() - Static method in class studio.mevera.imperat.util.ImperatDebugger
 
isTrueFlag() - Method in class studio.mevera.imperat.command.tree.CommandNode
 
isUsedIn(String) - Method in interface studio.mevera.imperat.placeholders.Placeholder
 
isUsingTestCases() - Static method in class studio.mevera.imperat.util.ImperatDebugger
 
isWithin(N, NumericRange) - Method in interface studio.mevera.imperat.command.NumericComparator
 
isWrapped() - Method in class studio.mevera.imperat.util.TypeWrap
 
iterator() - Method in class studio.mevera.imperat.annotations.base.element.ParseElement
Returns an iterator over elements of valueType T.
iterator() - Method in class studio.mevera.imperat.command.tree.help.HelpEntryList
 
iterator() - Method in class studio.mevera.imperat.util.priority.PriorityList
Returns an iterator over the elements in this list, ordered by priority.

J

JAVA - Enum constant in enum class studio.mevera.imperat.CommandParsingMode
 
join(String, int) - Method in interface studio.mevera.imperat.context.ArgumentInput
Joins all present arguments in this stack, starting from the specified index
join(String) - Method in interface studio.mevera.imperat.context.ArgumentInput
Joins all present arguments in this stack

K

Keyed<T> - Interface in studio.mevera.imperat.util
 
KOTLIN - Enum constant in enum class studio.mevera.imperat.CommandParsingMode
 

L

left() - Method in record class studio.mevera.imperat.util.Pair
Returns the value of the left record component.
limit() - Element in annotation interface studio.mevera.imperat.annotations.types.Greedy
 
limit(int) - Method in class studio.mevera.imperat.command.tree.help.HelpQuery.Builder
Sets the maximum number of help entries to return.
listen(Class<E>, EventListenerConsumer<E>) - Method in interface studio.mevera.imperat.events.EventListener
 
listen(Class<E>, EventListenerConsumer<E>, Priority) - Method in interface studio.mevera.imperat.events.EventListener
 
listen(Class<E>, EventListenerConsumer<E>, Priority, ExecutionStrategy) - Method in class studio.mevera.imperat.BaseImperat
 
listen(Class<E>, EventListenerConsumer<E>, Priority, ExecutionStrategy) - Method in interface studio.mevera.imperat.events.EventListener
 
literal(Imperat<S>, String...) - Static method in interface studio.mevera.imperat.command.arguments.Argument
 
LITERAL_SPLIT - Static variable in class studio.mevera.imperat.annotations.base.parsers.PathwaySyntaxParser
 
literalChildLookup() - Method in record class studio.mevera.imperat.command.tree.CommandNode.CompletionCache
Returns the value of the literalChildLookup record component.
literalChildren() - Method in record class studio.mevera.imperat.command.tree.CommandNode.CompletionCache
Returns the value of the literalChildren record component.
LiteralCommandNode<S extends CommandSource> - Class in studio.mevera.imperat.command.tree
 
loadArgument(MethodElement, String) - Method in class studio.mevera.imperat.annotations.base.parsers.PathwaySyntaxParser
 
loadCommand(Command<S>, String, MethodElement) - Method in class studio.mevera.imperat.annotations.base.parsers.PathwaySyntaxParser
 
loadDefaultContentFetcher() - Method in interface studio.mevera.imperat.responses.ResponseRegistry
 
loadParameterInstances(Imperat<S>, S, ExecutionContext<S>, MethodElement) - Static method in class studio.mevera.imperat.annotations.base.AnnotationHelper
The function loads the full parameters of a method and resolves all context, such as senders, flags, regular arguments, etc.
LONG_NUMERIC_COMPARATOR - Static variable in interface studio.mevera.imperat.command.NumericComparator
 
lookup(Type) - Method in interface studio.mevera.imperat.command.arguments.type.ArgumentTypeLookup
Looks up an ArgumentType for the specified type.
lookupOrThrow(Type) - Method in interface studio.mevera.imperat.command.arguments.type.ArgumentTypeLookup
Looks up an ArgumentType for the specified type, throwing an exception if not found.
LOW - Static variable in class studio.mevera.imperat.util.priority.Priority
 

M

map(TypeWrap<M>, Supplier<M>, ArgumentType<S, K>, ArgumentType<S, V>) - Static method in class studio.mevera.imperat.command.arguments.type.ArgumentTypes
 
MapArgument<S extends CommandSource,K,V,M extends Map<K,V>> - Class in studio.mevera.imperat.command.arguments.type
 
MapArgument(TypeWrap<M>, Supplier<M>, ArgumentType<S, K>, ArgumentType<S, V>) - Constructor for class studio.mevera.imperat.command.arguments.type.MapArgument
 
MapArgumentTypeHandler<S extends CommandSource> - Class in studio.mevera.imperat.command.arguments.type.handlers
Handler for resolving ArgumentType instances for Map types.
MapArgumentTypeHandler() - Constructor for class studio.mevera.imperat.command.arguments.type.handlers.MapArgumentTypeHandler
Creates a new MapArgumentTypeHandler with default initializers.
matches(double) - Method in class studio.mevera.imperat.command.arguments.NumericRange
 
matches(Type, Type) - Static method in class studio.mevera.imperat.util.TypeUtility
 
matchesRange(N) - Method in interface studio.mevera.imperat.command.arguments.NumericArgument
 
max() - Element in annotation interface studio.mevera.imperat.annotations.types.Range
 
max(double) - Static method in class studio.mevera.imperat.command.arguments.NumericRange
 
maxDepth(int) - Method in class studio.mevera.imperat.command.tree.help.HelpQuery.Builder
Sets the maximum depth to traverse the command tree.
MAXIMUM - Static variable in class studio.mevera.imperat.util.priority.Priority
 
MethodCaller - Interface in studio.mevera.imperat.util.asm
A high-level wrapper, responsible for invoking methods reflectively.
MethodCaller.BoundMethodCaller - Interface in studio.mevera.imperat.util.asm
Represents a MethodCaller that is attached to an instance
MethodCallerFactory - Interface in studio.mevera.imperat.util.asm
Factory for creating MethodCallers for methods.
MethodCommandExceptionHandler<E extends Throwable,S extends CommandSource> - Class in studio.mevera.imperat.annotations.base.parsers
 
MethodCommandExecutor<S extends CommandSource> - Class in studio.mevera.imperat.annotations.base
 
MethodCommandExecutor(MethodCommandExecutor<S>) - Constructor for class studio.mevera.imperat.annotations.base.MethodCommandExecutor
 
methodElement(MethodElement) - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
MethodElement - Class in studio.mevera.imperat.annotations.base.element
 
MethodElement(AnnotationParser<S>, ClassElement, Method) - Constructor for class studio.mevera.imperat.annotations.base.element.MethodElement
 
MethodElement(AnnotationParser<S>, ClassElement, Method, ReturnResolver<?, ?>) - Constructor for class studio.mevera.imperat.annotations.base.element.MethodElement
 
methodError(MethodElement, String) - Static method in interface studio.mevera.imperat.annotations.base.element.selector.MethodRules
 
methodHandles() - Static method in interface studio.mevera.imperat.util.asm.MethodCallerFactory
Returns a MethodCallerFactory that uses the new method handling API to create method callers.
MethodRules - Interface in studio.mevera.imperat.annotations.base.element.selector
 
methodSelector - Variable in class studio.mevera.imperat.annotations.base.parsers.CommandClassParser
 
min() - Element in annotation interface studio.mevera.imperat.annotations.types.Range
 
min(double) - Static method in class studio.mevera.imperat.command.arguments.NumericRange
 
MINIMUM - Static variable in class studio.mevera.imperat.util.priority.Priority
 
MISSING_FLAG_INPUT - Static variable in interface studio.mevera.imperat.responses.ResponseKey
 

N

name - Variable in class studio.mevera.imperat.command.arguments.ArgumentBuilder
 
name - Variable in class studio.mevera.imperat.command.arguments.InputArgument
 
name() - Method in interface studio.mevera.imperat.context.CommandSource
 
name() - Method in record class studio.mevera.imperat.context.FlagData.FlagDataImpl
Returns the value of the name record component.
name() - Method in interface studio.mevera.imperat.context.FlagData
The main name of the flag
nameContains(String) - Static method in class studio.mevera.imperat.command.tree.help.HelpFilters
Creates a filter that matches pathways whose formatted usage contains a substring.
Named - Annotation Interface in studio.mevera.imperat.annotations.types
Assigns a logical name to a command element or parameter.
nameMatches(String) - Static method in class studio.mevera.imperat.command.tree.help.HelpFilters
Creates a filter that matches the pathway's formatted usage against a regex pattern.
negate() - Method in interface studio.mevera.imperat.command.tree.help.HelpFilter
Creates a filter that inverts this filter's result.
newCommandParsingVisitor(Imperat<S>, AnnotationParser<S>) - Static method in class studio.mevera.imperat.annotations.base.parsers.CommandClassParser
 
newThrowableParsingVisitor(Imperat<S>, AnnotationParser<S>) - Static method in class studio.mevera.imperat.annotations.base.parsers.CommandClassParser
 
nextInput() - Method in interface studio.mevera.imperat.context.internal.Cursor
Advances the cursor to the next raw input and returns it.
nextParameter() - Method in interface studio.mevera.imperat.context.internal.Cursor
Advances the cursor to the next parameter and returns it.
NO_HELP - Static variable in interface studio.mevera.imperat.responses.ResponseKey
 
NO_HELP_PAGE - Static variable in interface studio.mevera.imperat.responses.ResponseKey
 
NO_MATCH - Enum constant in enum class studio.mevera.imperat.command.tree.TreeExecutionResult.Status
No matching pathway was found in the tree for the given input.
noMatch(CommandPathway<S>, Command<S>) - Static method in class studio.mevera.imperat.command.tree.TreeExecutionResult
Creates a result indicating no matching pathway was found.
none() - Static method in class studio.mevera.imperat.command.tree.help.HelpFilters
Creates a filter that never passes (excludes all pathways).
nonLiteralChildren() - Method in record class studio.mevera.imperat.command.tree.CommandNode.CompletionCache
Returns the value of the nonLiteralChildren record component.
noPermission() - Static method in class studio.mevera.imperat.command.tree.help.HelpFilters
Creates a filter that only includes pathways without any permission requirement.
NORMAL - Static variable in class studio.mevera.imperat.util.priority.Priority
 
NORMAL_VALUE - Static variable in class studio.mevera.imperat.util.priority.Priority
 
normalizedParameterFormatting(String, boolean) - Static method in class studio.mevera.imperat.util.StringUtils
 
not() - Method in class studio.mevera.imperat.permissions.CommandPermissionCondition
 
notEmpty(String, String) - Static method in class studio.mevera.imperat.util.Preconditions
 
notEmpty(Collection<T>, String) - Static method in class studio.mevera.imperat.util.Preconditions
 
notEmpty(T[], String) - Static method in class studio.mevera.imperat.util.Preconditions
 
notNull(T, String) - Static method in class studio.mevera.imperat.util.Preconditions
 
NUMBER_OUT_OF_RANGE - Static variable in interface studio.mevera.imperat.responses.ResponseKey
 
NumberArgument<S extends CommandSource,N extends Number> - Class in studio.mevera.imperat.command.arguments.type
 
NumberArgument() - Constructor for class studio.mevera.imperat.command.arguments.type.NumberArgument
 
numeric(Class<N>) - Static method in class studio.mevera.imperat.command.arguments.type.ArgumentTypes
 
NumericArgument<S extends CommandSource> - Interface in studio.mevera.imperat.command.arguments
Represents a behavior that deals with numeric inputs if they are ranged from min to max using NumericRange
NumericArgumentDecorator<S extends CommandSource> - Class in studio.mevera.imperat.annotations.parameters
 
NumericArgumentTypeHandler<S extends CommandSource> - Class in studio.mevera.imperat.command.arguments.type.handlers
Handler for resolving ArgumentType instances for numeric types.
NumericArgumentTypeHandler() - Constructor for class studio.mevera.imperat.command.arguments.type.handlers.NumericArgumentTypeHandler
 
NumericComparator<N extends Number> - Interface in studio.mevera.imperat.command
 
NumericRange - Class in studio.mevera.imperat.command.arguments
 

O

of(double, double) - Static method in class studio.mevera.imperat.command.arguments.NumericRange
 
of(int) - Static method in class studio.mevera.imperat.util.priority.Priority
 
of(String) - Static method in interface studio.mevera.imperat.command.arguments.DefaultValueProvider
 
of(ResponseKey) - Static method in exception studio.mevera.imperat.exception.ResponseException
Factory for creating an inline ResponseException with the given key.
of(CommandTree<S>) - Static method in class studio.mevera.imperat.command.tree.CommandTreeVisualizer
 
of(Class<T>) - Static method in class studio.mevera.imperat.util.TypeWrap
 
of(Type) - Static method in class studio.mevera.imperat.util.TypeWrap
 
of(String) - Static method in class studio.mevera.imperat.command.Description
 
of(String) - Static method in interface studio.mevera.imperat.context.ArgumentInput
 
of(String...) - Static method in class studio.mevera.imperat.permissions.PermissionsData
 
of(String, ArgumentType<S, T>, PermissionsData, Description, boolean, boolean, DefaultValueProvider, SuggestionProvider<S>, List<ArgValidator<S>>) - Static method in interface studio.mevera.imperat.command.arguments.Argument
 
of(Supplier<T>) - Static method in interface studio.mevera.imperat.providers.ContextArgumentProvider
 
of(List<String>) - Static method in class studio.mevera.imperat.permissions.PermissionsData
 
of(N) - Static method in interface studio.mevera.imperat.command.NumericComparator
 
of(ArgumentInput, CommandPathway<S>) - Static method in interface studio.mevera.imperat.context.internal.Cursor
Creates a new Cursor instance with the specified raw arguments and command pathway information.
of(ExecutionContext<S>, CommandContext<S>) - Static method in class studio.mevera.imperat.context.ExecutionResult
Creates a successful execution result.
of(Imperat<S>, MethodElement) - Static method in class studio.mevera.imperat.annotations.base.MethodCommandExecutor
 
of(CommandPermissionCondition) - Static method in class studio.mevera.imperat.permissions.PermissionsData
 
of(T) - Static method in interface studio.mevera.imperat.providers.ContextArgumentProvider
 
ofArray(Type) - Static method in class studio.mevera.imperat.util.TypeWrap
 
ofFallback(B) - Static method in class studio.mevera.imperat.command.arguments.Either
 
ofFlag(String, ArgumentType<S, T>) - Static method in class studio.mevera.imperat.command.arguments.FlagArgumentBuilder
 
ofParameterized(Type, Type...) - Static method in class studio.mevera.imperat.util.TypeWrap
 
ofParameterized(Type, List<ArgumentType<S, ?>>) - Static method in class studio.mevera.imperat.util.TypeWrap
 
ofPrimary(A) - Static method in class studio.mevera.imperat.command.arguments.Either
 
ofSingleString(Argument<S>, String) - Static method in interface studio.mevera.imperat.context.internal.Cursor
Creates a new Cursor with a single string as input.
ofSwitch(String) - Static method in class studio.mevera.imperat.command.arguments.FlagArgumentBuilder
 
onFailure(AnnotationParser<?>, T) - Method in interface studio.mevera.imperat.annotations.base.element.selector.Rule
 
onFailure(AnnotationParser<?>, T) - Method in class studio.mevera.imperat.annotations.base.element.selector.Rule.SimpleRule
 
onRegisteringResolver(SimpleTypeResolver<S, T>) - Method in interface studio.mevera.imperat.command.arguments.type.ArgumentTypeHandler
 
onRegisteringResolver(SimpleTypeResolver<S, T>) - Method in class studio.mevera.imperat.command.arguments.type.handlers.ArrayArgumentTypeHandler
 
optional - Variable in class studio.mevera.imperat.command.arguments.InputArgument
 
optional(String, ArgumentType<S, T>) - Static method in interface studio.mevera.imperat.command.arguments.Argument
 
optional(TypeWrap<Optional<T>>, ArgumentType<S, T>) - Static method in class studio.mevera.imperat.command.arguments.type.ArgumentTypes
 
Optional - Annotation Interface in studio.mevera.imperat.annotations.types
Marks a parameter or type as optional.
OptionalArgument<S extends CommandSource,T> - Class in studio.mevera.imperat.command.arguments.type
 
OptionalArgument(TypeWrap<Optional<T>>, ArgumentType<S, T>) - Constructor for class studio.mevera.imperat.command.arguments.type.OptionalArgument
 
OptionalArgumentHandler<S extends CommandSource> - Class in studio.mevera.imperat.context.internal
 
OptionalArgumentHandler() - Constructor for class studio.mevera.imperat.context.internal.OptionalArgumentHandler
 
OptionalArgumentTypeHandler<S extends CommandSource> - Class in studio.mevera.imperat.command.arguments.type.handlers
Handler for resolving ArgumentType instances for Optional types.
OptionalArgumentTypeHandler() - Constructor for class studio.mevera.imperat.command.arguments.type.handlers.OptionalArgumentTypeHandler
 
optionalBoolean(String) - Static method in interface studio.mevera.imperat.command.arguments.Argument
 
optionalDouble(String) - Static method in interface studio.mevera.imperat.command.arguments.Argument
 
optionalFloat(String) - Static method in interface studio.mevera.imperat.command.arguments.Argument
 
optionalGreedy(String) - Static method in interface studio.mevera.imperat.command.arguments.Argument
 
optionalInt(String) - Static method in interface studio.mevera.imperat.command.arguments.Argument
 
optionalLong(String) - Static method in interface studio.mevera.imperat.command.arguments.Argument
 
optionalOverlapDescendants() - Method in record class studio.mevera.imperat.command.tree.CommandNode.CompletionCache
Returns the value of the optionalOverlapDescendants record component.
optionalText(String) - Static method in interface studio.mevera.imperat.command.arguments.Argument
 
or(Rule<T>) - Method in interface studio.mevera.imperat.annotations.base.element.selector.Rule
 
or(Rule<T>) - Method in class studio.mevera.imperat.annotations.base.element.selector.Rule.SimpleRule
 
or(String...) - Method in class studio.mevera.imperat.permissions.CommandPermissionCondition
 
or(RuleCondition<E>) - Method in interface studio.mevera.imperat.annotations.base.element.selector.RuleCondition
 
or(HelpFilter<S>) - Method in interface studio.mevera.imperat.command.tree.help.HelpFilter
Creates a composite filter that passes if either this or another filter passes.
or(CommandPermissionCondition...) - Method in class studio.mevera.imperat.permissions.CommandPermissionCondition
 
origin() - Method in interface studio.mevera.imperat.context.CommandSource
 
originalArgument - Variable in class studio.mevera.imperat.context.ParsedArgument
 
overlapOptionalParameterSuggestions(boolean) - Method in class studio.mevera.imperat.ConfigBuilder
Configures whether multiple optional parameters can be suggested simultaneously during tab completion at the same command depth level.

P

Pair<L,R> - Record Class in studio.mevera.imperat.util
 
Pair(L, R) - Constructor for record class studio.mevera.imperat.util.Pair
Creates an instance of a Pair record class.
PARAMETER_ONLY - Enum constant in enum class studio.mevera.imperat.context.internal.ShiftTarget
 
ParameterElement - Class in studio.mevera.imperat.annotations.base.element
 
parametersLength() - Method in interface studio.mevera.imperat.context.internal.Cursor
Retrieves the total number of command parameters in the cursor.
parent - Variable in class studio.mevera.imperat.annotations.base.element.ParseElement
 
parent(Command<S>) - Method in class studio.mevera.imperat.command.Command.Builder
 
parentCommand - Variable in class studio.mevera.imperat.command.arguments.InputArgument
 
parse(int, CommandContext<S>) - Method in class studio.mevera.imperat.command.tree.CommandNode
 
parse(int, CommandContext<S>, CommandPathway<S>) - Method in class studio.mevera.imperat.command.tree.CommandNode
 
parse(int, CommandContext<S>, CommandPathway<S>, int) - Method in class studio.mevera.imperat.command.tree.CommandNode
 
parse(CommandContext<S>, Argument<S>, String) - Method in class studio.mevera.imperat.command.arguments.type.ArgumentType
Parses the argument value from the given input string, using the provided execution context.
parse(CommandContext<S>, Argument<S>, String) - Method in class studio.mevera.imperat.command.arguments.type.ArrayArgument
 
parse(CommandContext<S>, Argument<S>, String) - Method in class studio.mevera.imperat.command.arguments.type.BooleanArgument
 
parse(CommandContext<S>, Argument<S>, String) - Method in class studio.mevera.imperat.command.arguments.type.CharacterArgument
 
parse(CommandContext<S>, Argument<S>, String) - Method in class studio.mevera.imperat.command.arguments.type.CollectionArgument
 
parse(CommandContext<S>, Argument<S>, String) - Method in class studio.mevera.imperat.command.arguments.type.CommandArgument
 
parse(CommandContext<S>, Argument<S>, String) - Method in class studio.mevera.imperat.command.arguments.type.CompletableFutureArgument
 
parse(CommandContext<S>, Argument<S>, String) - Method in class studio.mevera.imperat.command.arguments.type.EitherArgument
 
parse(CommandContext<S>, Argument<S>, String) - Method in class studio.mevera.imperat.command.arguments.type.EnumArgument
 
parse(CommandContext<S>, Argument<S>, String) - Method in class studio.mevera.imperat.command.arguments.type.FlagArgumentType
 
parse(CommandContext<S>, Argument<S>, String) - Method in class studio.mevera.imperat.command.arguments.type.MapArgument
 
parse(CommandContext<S>, Argument<S>, String) - Method in class studio.mevera.imperat.command.arguments.type.NumberArgument
 
parse(CommandContext<S>, Argument<S>, String) - Method in class studio.mevera.imperat.command.arguments.type.OptionalArgument
 
parse(CommandContext<S>, Argument<S>, String) - Method in class studio.mevera.imperat.command.arguments.type.StringArgument
 
parse(CommandContext<S>, Argument<S>, String) - Method in class studio.mevera.imperat.command.arguments.type.UUIDArgument
 
parse(ExecutionContext<S>, Cursor<S>) - Method in class studio.mevera.imperat.command.arguments.type.ArgumentType
Parses the argument value from the current position of the cursor, using the provided execution context.
parse(ExecutionContext<S>, Cursor<S>) - Method in class studio.mevera.imperat.command.arguments.type.CompletableFutureArgument
 
parse(ExecutionContext<S>, Cursor<S>) - Method in class studio.mevera.imperat.command.arguments.type.FlagArgumentType
 
parse(ExecutionContext<S>, Cursor<S>) - Method in class studio.mevera.imperat.command.arguments.type.OptionalArgument
 
parse(String) - Static method in interface studio.mevera.imperat.context.ArgumentInput
 
parse(String[]) - Static method in interface studio.mevera.imperat.context.ArgumentInput
 
parseArgument(Cursor<S>, T) - Method in interface studio.mevera.imperat.context.ExecutionContext
Resolves and registers a command argument.
parseArgument(ParsedArgument<S>) - Method in interface studio.mevera.imperat.context.ExecutionContext
Registers a resolved argument in the context.
parseAutoCompletion(String[], boolean) - Static method in interface studio.mevera.imperat.context.ArgumentInput
 
parseAutoCompletion(String, boolean) - Static method in interface studio.mevera.imperat.context.ArgumentInput
 
parseCommandClass(T) - Method in class studio.mevera.imperat.annotations.base.AnnotationParser
Parses annotated command class of valueType AnnotationParser into Command then register it using Imperat
parseCommandMethod(Command<S>, MethodElement) - Method in class studio.mevera.imperat.annotations.base.parsers.CommandElementParser
 
ParsedArgument<S extends CommandSource> - Class in studio.mevera.imperat.context
 
ParsedArgument(String, Argument<S>, int, Object) - Constructor for class studio.mevera.imperat.context.ParsedArgument
 
ParsedFlagArgument<S extends CommandSource> - Class in studio.mevera.imperat.context.internal
 
ParseElement<E extends AnnotatedElement> - Class in studio.mevera.imperat.annotations.base.element
 
ParseElement(AnnotationParser<S>, ParseElement<?>, E) - Constructor for class studio.mevera.imperat.annotations.base.element.ParseElement
 
parseGlobalErrorHandlersFrom(T) - Method in class studio.mevera.imperat.annotations.base.AnnotationParser
Parses annotated throwable handling class into a set of CommandExceptionHandler that are automatically injected into the instance of Imperat that you're using.
parseMethodParameter(MethodElement, ParameterElement) - Method in class studio.mevera.imperat.annotations.base.parsers.CommandElementParser
 
ParseOrder - Annotation Interface in studio.mevera.imperat.annotations.types
Defines the execution or evaluation priority of an element.
parsePathwayMethod(Command<S>, MethodElement) - Method in class studio.mevera.imperat.annotations.base.parsers.CommandElementParser
 
parser - Variable in class studio.mevera.imperat.annotations.base.element.ParseElement
 
parser - Variable in class studio.mevera.imperat.annotations.base.parsers.CommandClassParser
 
ParseResult<S extends CommandSource> - Class in studio.mevera.imperat.command.tree
 
parseSpecificClass(Command<S>, ClassElement) - Method in class studio.mevera.imperat.annotations.base.parsers.CommandElementParser
 
parseSubCommand(Command<S>, String) - Method in interface studio.mevera.imperat.command.tree.CommandTree
 
parseSubTree(CommandTree<S>, String) - Method in interface studio.mevera.imperat.command.tree.CommandTree
 
parseToQueue(String, boolean) - Static method in class studio.mevera.imperat.util.StringUtils
 
parseToQueue(String, boolean, boolean) - Static method in class studio.mevera.imperat.util.StringUtils
 
parseUsage(CommandPathway<S>) - Method in interface studio.mevera.imperat.command.tree.CommandTree
Parses the given command usage and updates the command tree accordingly.
pathway(CommandPathway.Builder<S>) - Method in class studio.mevera.imperat.command.Command.Builder
 
PathwayCommand - Annotation Interface in studio.mevera.imperat.annotations.types
 
PathwaySyntaxParser<S extends CommandSource> - Class in studio.mevera.imperat.annotations.base.parsers
 
Patterns - Class in studio.mevera.imperat.util
 
peekLetter() - Method in interface studio.mevera.imperat.context.internal.Cursor
Peeks at the next character without advancing the cursor.
peekParameter() - Method in interface studio.mevera.imperat.context.internal.Cursor
Peeks at the next command parameter wrapped in an Optional container.
peekParameterIfPresent() - Method in interface studio.mevera.imperat.context.internal.Cursor
Peeks at the next command parameter without advancing the cursor.
peekRaw() - Method in interface studio.mevera.imperat.context.internal.Cursor
Peeks at the next raw input string wrapped in an Optional container.
peekRawIfPresent() - Method in interface studio.mevera.imperat.context.internal.Cursor
Peeks at the next raw input string without advancing the cursor.
permission - Variable in class studio.mevera.imperat.command.arguments.ArgumentBuilder
 
permission() - Element in annotation interface studio.mevera.imperat.annotations.types.Cooldown
 
permission() - Method in class studio.mevera.imperat.command.cooldown.CooldownRecord
 
permission(PermissionsData) - Method in class studio.mevera.imperat.command.arguments.ArgumentBuilder
 
permission(PermissionsData) - Method in class studio.mevera.imperat.command.Command.Builder
 
permission(PermissionsData) - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
Permission - Annotation Interface in studio.mevera.imperat.annotations.types
Declares a permission node required to access a command, subcommand, or parameter.
PERMISSION_DENIED - Enum constant in enum class studio.mevera.imperat.command.tree.TreeExecutionResult.Status
The source does not have permission to execute the matched pathway.
permissionChecker(PermissionChecker<S>) - Method in class studio.mevera.imperat.ConfigBuilder
Sets a custom PermissionChecker to determine and resolve permissions for the command sender/source within the platform's configuration.
PermissionChecker<S extends CommandSource> - Interface in studio.mevera.imperat.permissions
Represents a functional way of checking for the permissions of the command source/sender.
permissionDenied(CommandPathway<S>, PermissionHolder, Command<S>) - Static method in class studio.mevera.imperat.command.tree.TreeExecutionResult
Creates a result indicating permission was denied.
PermissionDeniedException - Exception in studio.mevera.imperat.exception
Thrown when a command source lacks the required permission to execute a command or usage.
PermissionDeniedException(String, CommandPathway<? extends CommandSource>, PermissionHolder) - Constructor for exception studio.mevera.imperat.exception.PermissionDeniedException
 
PermissionHolder - Interface in studio.mevera.imperat.permissions
Represents an entity that can hold a permission.
Permissions - Annotation Interface in studio.mevera.imperat.annotations.types
 
permissionsData - Variable in class studio.mevera.imperat.command.arguments.InputArgument
 
PermissionsData - Class in studio.mevera.imperat.permissions
 
placeholder(Placeholder) - Method in class studio.mevera.imperat.ConfigBuilder
Registers a placeholder with the configuration.
Placeholder - Interface in studio.mevera.imperat.placeholders
 
Placeholder.Builder - Class in studio.mevera.imperat.placeholders
 
PlaceholderDataProvider - Interface in studio.mevera.imperat.placeholders
 
PlaceholderRegistry - Class in studio.mevera.imperat.placeholders
 
PlaceholderResolver - Interface in studio.mevera.imperat.placeholders
 
plainText(String) - Static method in class studio.mevera.imperat.command.tree.help.theme.HelpComponent
 
plus(int) - Method in class studio.mevera.imperat.util.priority.Priority
 
popLetter() - Method in interface studio.mevera.imperat.context.internal.Cursor
Removes and returns the current character while advancing the cursor.
popParameter() - Method in interface studio.mevera.imperat.context.internal.Cursor
Removes and returns the current command parameter while advancing the cursor.
popRaw() - Method in interface studio.mevera.imperat.context.internal.Cursor
Removes and returns the current raw input while advancing the cursor.
position() - Method in interface studio.mevera.imperat.context.internal.Cursor
Retrieves the current cursor position within the input cursor.
post(T) - Method in interface studio.mevera.imperat.events.EventBus
Posts an event to all subscriptions registered for its exact runtime type.
POST - Enum constant in enum class studio.mevera.imperat.exception.ProcessorException.Type
 
postProcess(ExecutionContext<S>) - Method in interface studio.mevera.imperat.command.Command
Executes the post-processing instructions in CommandPostProcessor
postProcessor(CommandPostProcessor<S>) - Method in class studio.mevera.imperat.command.Command.Builder
 
PRE - Enum constant in enum class studio.mevera.imperat.exception.ProcessorException.Type
 
Preconditions - Class in studio.mevera.imperat.util
 
prepareArguments(ExecutionContext<S>) - Method in class studio.mevera.imperat.annotations.base.MethodCommandExecutor
 
preProcess(CommandContext<S>) - Method in interface studio.mevera.imperat.command.Command
Executes the pre-processing instructions in CommandPreProcessor
preProcessor(CommandPreProcessor<S>) - Method in class studio.mevera.imperat.command.Command.Builder
 
prevParameter() - Method in interface studio.mevera.imperat.context.internal.Cursor
Retrieves the previous command parameter without moving the cursor.
prevRaw() - Method in interface studio.mevera.imperat.context.internal.Cursor
Retrieves the previous raw input string without moving the cursor.
primaryOrMapFallback(Function<B, A>) - Method in class studio.mevera.imperat.command.arguments.Either
 
primitiveToBoxed(Type) - Static method in class studio.mevera.imperat.util.TypeUtility
 
print(Throwable) - Method in interface studio.mevera.imperat.ThrowablePrinter
Prints the stacktrace for the given throwable.
Prioritizable - Interface in studio.mevera.imperat.util.priority
 
priority() - Element in annotation interface studio.mevera.imperat.annotations.types.Processor
 
Priority - Class in studio.mevera.imperat.util.priority
Represents the relative priority used when resolving command parameters.
PriorityList<E extends Prioritizable> - Class in studio.mevera.imperat.util.priority
A collection that maintains elements sorted by their Priority.
PriorityList() - Constructor for class studio.mevera.imperat.util.priority.PriorityList
Creates a new empty PriorityList.
process(CommandContext<S>) - Method in interface studio.mevera.imperat.command.processors.CommandPreProcessor
Processes context BEFORE the resolving operation.
process(ExecutionContext<S>) - Method in interface studio.mevera.imperat.command.processors.CommandPostProcessor
Processes context AFTER the resolving operation.
process(ExecutionContext<S>) - Method in class studio.mevera.imperat.command.processors.impl.CooldownProcessor
Processes context BEFORE the resolving operation.
Processor - Annotation Interface in studio.mevera.imperat.annotations.types
Marks a method as a CommandProcessor, which is a method that is executed after the command is executed, regardless of the outcome.
ProcessorException - Exception in studio.mevera.imperat.exception
 
ProcessorException(ProcessorException.Type, Command<?>, Throwable) - Constructor for exception studio.mevera.imperat.exception.ProcessorException
 
ProcessorException.Type - Enum Class in studio.mevera.imperat.exception
 
provide(ExecutionContext<S>, ParameterElement) - Method in interface studio.mevera.imperat.providers.ContextArgumentProvider
Resolves a parameter's default value if it has been not input by the user
provide(ExecutionContext<S>, Argument<S>) - Method in interface studio.mevera.imperat.command.arguments.DefaultValueProvider
Supplies a default-value for optional usage parameters Argument
provide(SuggestionContext<S>, Argument<S>) - Method in interface studio.mevera.imperat.providers.SuggestionProvider
 
provideAsynchronously(SuggestionContext<S>, Argument<S>) - Method in interface studio.mevera.imperat.providers.SuggestionProvider
 
provideExecutorService() - Method in class studio.mevera.imperat.annotations.base.DefaultExecutorServiceProvider
 
provideExecutorService() - Method in interface studio.mevera.imperat.annotations.base.ExecutorServiceProvider
Provides an ExecutorService to be used for asynchronous command execution.
provideSource(Type) - Method in interface studio.mevera.imperat.context.ExecutionContext
Resolves the command source into a different type using the configured source resolver.
proxyClass() - Method in class studio.mevera.imperat.annotations.base.element.RootCommandClass
 
proxyInstance() - Method in class studio.mevera.imperat.annotations.base.element.RootCommandClass
 
publishEvent(E) - Method in class studio.mevera.imperat.BaseImperat
 
publishEvent(E) - Method in interface studio.mevera.imperat.events.EventPublisher
 

Q

queryHelp(HelpQuery<S>) - Method in interface studio.mevera.imperat.command.tree.CommandTree
Queries the help system to retrieve a set of help entries that match the specified criteria.

R

Range - Annotation Interface in studio.mevera.imperat.annotations.types
Constrains a numeric parameter or type to a minimum/maximum value.
RangeValidator<S extends CommandSource> - Class in studio.mevera.imperat.command.arguments.validator
 
RangeValidator() - Constructor for class studio.mevera.imperat.command.arguments.validator.RangeValidator
 
raw - Variable in class studio.mevera.imperat.context.ParsedArgument
 
RAW_ONLY - Enum constant in enum class studio.mevera.imperat.context.internal.ShiftTarget
 
rawsLength() - Method in interface studio.mevera.imperat.context.internal.Cursor
Retrieves the total number of raw input strings in the cursor.
read(Imperat<S>, ElementSelector<MethodElement>, AnnotationParser<S>, Object) - Static method in interface studio.mevera.imperat.annotations.base.AnnotationReader
 
readInput() - Method in interface studio.mevera.imperat.context.internal.Cursor
Reads and returns the current raw input without advancing the cursor.
Reflections - Class in studio.mevera.imperat.util.reflection
 
Reflections() - Constructor for class studio.mevera.imperat.util.reflection.Reflections
 
register(Class<T>, EventListenerConsumer<T>) - Method in interface studio.mevera.imperat.events.EventBus
Registers an event handler with Priority.NORMAL and ExecutionStrategy.SYNC.
register(Class<T>, EventListenerConsumer<T>, Priority) - Method in interface studio.mevera.imperat.events.EventBus
Registers an event handler with the specified priority and ExecutionStrategy.SYNC.
register(Class<T>, EventListenerConsumer<T>, Priority, ExecutionStrategy) - Method in interface studio.mevera.imperat.events.EventBus
Registers an event handler with full configuration.
register(String, Placeholder) - Method in interface studio.mevera.imperat.placeholders.PlaceholderDataProvider
 
registerAnnotationReplacer(Class<A>, AnnotationReplacer<A>) - Method in interface studio.mevera.imperat.AnnotationInjector
Registers annotation replacer
registerAnnotationReplacer(Class<A>, AnnotationReplacer<A>) - Method in class studio.mevera.imperat.annotations.base.AnnotationParser
registerAnnotationReplacer(Class<A>, AnnotationReplacer<A>) - Method in class studio.mevera.imperat.BaseImperat
registerAnnotationReplacer(Class<A>, AnnotationReplacer<A>) - Method in interface studio.mevera.imperat.ImperatConfig
Registers annotation replacer
registerAnnotations(Class<? extends Annotation>...) - Method in interface studio.mevera.imperat.AnnotationInjector
Registers a valueType of annotations so that it can be detected by AnnotationReader , it's useful as it allows that valueType of annotation to be recognized as a true Imperat-related annotation to be used in something like checking if a Argument is annotated and checks for the annotations it has.
registerAnnotations(Class<? extends Annotation>...) - Method in class studio.mevera.imperat.annotations.base.AnnotationParser
Registers a valueType of annotations so that it can be detected by AnnotationReader , it's useful as it allows that valueType of annotation to be recognized as a true Imperat-related annotation to be used in something like checking if a Argument is annotated and checks for the annotations it has.
registerAnnotations(Class<? extends Annotation>...) - Method in class studio.mevera.imperat.BaseImperat
Registers a valueType of annotations so that it can be detected by AnnotationReader , it's useful as it allows that valueType of annotation to be recognized as a true Imperat-related annotation to be used in something like checking if a Argument is annotated and checks for the annotations it has.
registerArgType(Type, ArgumentType<S, T>) - Method in interface studio.mevera.imperat.ResolverRegistrar
Registers ArgumentType
registerArgTypeHandler(ArgumentTypeHandler<S>) - Method in interface studio.mevera.imperat.ResolverRegistrar
Registers a custom ArgumentTypeHandler.
registerCollectionInitializer(Class<C>, Supplier<C>) - Method in class studio.mevera.imperat.context.ArgumentTypeRegistry
Registers a custom collection initializer.
registerCommand(Class<?>) - Method in class studio.mevera.imperat.BaseImperat
Registers a command class built by the annotations using a parser
registerCommand(Class<?>) - Method in interface studio.mevera.imperat.CommandRegistrar
Registers a command class built by the annotations using a parser
registerCommand(Object) - Method in class studio.mevera.imperat.BaseImperat
 
registerCommand(Object) - Method in interface studio.mevera.imperat.CommandRegistrar
Registers a command instance built by the annotations using a parser
registerCommands(Class<?>...) - Method in interface studio.mevera.imperat.CommandRegistrar
Registers some commands into the dispatcher annotations using a parser
registerCommands(Object...) - Method in interface studio.mevera.imperat.CommandRegistrar
Registers some command instances built by the annotations using a parser
registerCommands(Command<S>...) - Method in interface studio.mevera.imperat.CommandRegistrar
Registers some commands into the dispatcher
registerContextArgumentProvider(Type, ContextArgumentProvider<S, T>) - Method in interface studio.mevera.imperat.ResolverRegistrar
registerContextArgumentProviderFactory(Type, ContextArgumentProviderFactory<S, T>) - Method in interface studio.mevera.imperat.ResolverRegistrar
Registers a context resolver factory
registerDependencyResolver(Type, DependencySupplier) - Method in interface studio.mevera.imperat.ImperatConfig
Registers the dependency to the type
registerDynamicArrayInitializer(Class<T>, Function<Integer, T[]>) - Method in class studio.mevera.imperat.context.ArgumentTypeRegistry
Registers a custom array initializer using raw/dynamic types.
registerExecutionMoment(S) - Method in interface studio.mevera.imperat.command.cooldown.CooldownHandler
Sets the last time of execution to this current moment using System.currentTimeMillis()
registerFactory(Type, ContextArgumentProviderFactory<S, T>) - Method in class studio.mevera.imperat.command.ContextArgumentProviderRegistry
 
registerGlobalExceptionHandlers(Object) - Method in interface studio.mevera.imperat.AnnotationInjector
Parses the instance's class that contains ExceptionHandler annotation into multiple throwable resolvers to be registered and injected into Imperat
registerHandler(ArgumentTypeHandler<S>) - Method in class studio.mevera.imperat.context.ArgumentTypeRegistry
Registers a custom ArgumentTypeHandler.
registerInitializer(Class<C>, Supplier<C>) - Method in class studio.mevera.imperat.command.arguments.type.handlers.CollectionArgumentTypeHandler
Registers a custom collection initializer.
registerInitializer(Class<M>, Supplier<M>) - Method in class studio.mevera.imperat.command.arguments.type.handlers.MapArgumentTypeHandler
Registers a custom map initializer.
registerInitializer(Class<T>, Function<Integer, T[]>) - Method in class studio.mevera.imperat.command.arguments.type.handlers.ArrayArgumentTypeHandler
Registers a custom array initializer for a specific component type.
registerMapInitializer(Class<M>, Supplier<M>) - Method in class studio.mevera.imperat.context.ArgumentTypeRegistry
Registers a custom map initializer.
registerPlaceholder(Placeholder) - Method in interface studio.mevera.imperat.ResolverRegistrar
Registers a placeholder
registerProvider(Type, ContextArgumentProvider<S, T>) - Method in class studio.mevera.imperat.command.ContextArgumentProviderRegistry
 
registerResolver(Type, Supplier<ArgumentType<S, T>>) - Method in class studio.mevera.imperat.context.ArgumentTypeRegistry
Registers a simple type resolver for a specific type.
registerResolver(Type, Supplier<ArgumentType<S, T>>, Priority) - Method in class studio.mevera.imperat.context.ArgumentTypeRegistry
Registers a simple type resolver for a specific type with a custom priority.
registerResponse(Response) - Method in interface studio.mevera.imperat.responses.ResponseRegistry
 
registerResponse(ResponseKey, Supplier<String>, String...) - Method in interface studio.mevera.imperat.responses.ResponseRegistry
 
registerResponse(ResponseKey, Supplier<String>, ResponseContentFetcher, String...) - Method in interface studio.mevera.imperat.responses.ResponseRegistry
 
registerReturnResolver(Type, ReturnResolver<S, T>) - Method in interface studio.mevera.imperat.ResolverRegistrar
Registers the ReturnResolver into an internal registry
registerReturnResolver(TypeWrap<T>, ReturnResolver<S, T>) - Method in interface studio.mevera.imperat.ResolverRegistrar
Registers the ReturnResolver into an internal registry
registerSimpleCommand(Command<S>) - Method in class studio.mevera.imperat.BaseImperat
Registering a command into the global registry, it will check for ambiguity with other commands and their tree before registering, if an ambiguity is detected it will throw an AmbiguousCommandException
registerSimpleCommand(Command<S>) - Method in interface studio.mevera.imperat.CommandRegistrar
Registering a command into the global registry, it will check for ambiguity with other commands and their tree before registering, if an ambiguity is detected it will throw an AmbiguousCommandException
registerSourceProvider(Type, SourceProvider<S, R>) - Method in interface studio.mevera.imperat.ResolverRegistrar
Registers the SourceProvider into an internal registry
registerSourceProvider(TypeWrap<R>, SourceProvider<S, R>) - Method in interface studio.mevera.imperat.ResolverRegistrar
Registers the SourceProvider into an internal registry
registry() - Method in interface studio.mevera.imperat.placeholders.PlaceholderDataProvider
 
Registry<K,V> - Class in studio.mevera.imperat.util
 
Registry() - Constructor for class studio.mevera.imperat.util.Registry
 
Registry(Supplier<Map<K, V>>) - Constructor for class studio.mevera.imperat.util.Registry
 
Registry(K, V, Supplier<Map<K, V>>) - Constructor for class studio.mevera.imperat.util.Registry
 
remove(int) - Method in class studio.mevera.imperat.command.tree.help.HelpEntryList
Removes an entry by index.
remove(E) - Method in class studio.mevera.imperat.util.priority.PriorityList
Removes an element from this list.
remove(HelpEntry<S>) - Method in class studio.mevera.imperat.command.tree.help.HelpEntryList
Removes a specific entry.
removeCooldown(S) - Method in interface studio.mevera.imperat.command.cooldown.CooldownHandler
Unregisters the user's cached cooldown when it's expired!
removeData(K) - Method in class studio.mevera.imperat.util.Registry
 
removeListener(UUID) - Method in class studio.mevera.imperat.BaseImperat
 
removeListener(UUID) - Method in interface studio.mevera.imperat.events.EventListener
 
removeRule(Rule<E>) - Method in interface studio.mevera.imperat.annotations.base.element.selector.ElementSelector
 
render(ExecutionContext<S>, HelpEntryList<S>, HelpTheme<S, C>) - Method in interface studio.mevera.imperat.command.tree.help.renderers.HelpLayoutRenderer
Renders the help documentation to the source.
render(ExecutionContext<S>, HelpEntryList<S>, HelpTheme<S, C>) - Method in class studio.mevera.imperat.command.tree.help.renderers.StandardHelpRenderer
 
repeat(int) - Method in class studio.mevera.imperat.command.tree.help.theme.HelpComponent
 
repeat(int) - Method in class studio.mevera.imperat.command.tree.help.theme.StringHelpComponent
 
replace(ParseElement<?>, A) - Method in interface studio.mevera.imperat.annotations.base.AnnotationReplacer
The annotation to replace
replacePlaceholders(String) - Method in interface studio.mevera.imperat.ImperatConfig
Replaces the placeholders of input by their PlaceholderResolver
replacePlaceholders(String[]) - Method in interface studio.mevera.imperat.ImperatConfig
Replaces the placeholders on each string of the array, modifying the input array content.
replaceResolved(String, String) - Method in interface studio.mevera.imperat.placeholders.Placeholder
 
reply(String) - Method in interface studio.mevera.imperat.context.CommandSource
Replies to the command sender with a string message
required(String, ArgumentType<S, T>) - Static method in interface studio.mevera.imperat.command.arguments.Argument
 
requiredBoolean(String) - Static method in interface studio.mevera.imperat.command.arguments.Argument
 
requiredDouble(String) - Static method in interface studio.mevera.imperat.command.arguments.Argument
 
requiredFloat(String) - Static method in interface studio.mevera.imperat.command.arguments.Argument
 
requiredGreedy(String) - Static method in interface studio.mevera.imperat.command.arguments.Argument
 
requiredInt(String) - Static method in interface studio.mevera.imperat.command.arguments.Argument
 
requiredLong(String) - Static method in interface studio.mevera.imperat.command.arguments.Argument
 
requiredText(String) - Static method in interface studio.mevera.imperat.command.arguments.Argument
 
resolve(Type, TypeWrap<?>, ArgumentTypeLookup<S>) - Method in interface studio.mevera.imperat.command.arguments.type.ArgumentTypeHandler
Resolves an ArgumentType for the given type.
resolve(Type, TypeWrap<?>, ArgumentTypeLookup<S>) - Method in class studio.mevera.imperat.command.arguments.type.handlers.ArrayArgumentTypeHandler
 
resolve(Type, TypeWrap<?>, ArgumentTypeLookup<S>) - Method in class studio.mevera.imperat.command.arguments.type.handlers.CollectionArgumentTypeHandler
 
resolve(Type, TypeWrap<?>, ArgumentTypeLookup<S>) - Method in class studio.mevera.imperat.command.arguments.type.handlers.CompletableFutureArgumentTypeHandler
 
resolve(Type, TypeWrap<?>, ArgumentTypeLookup<S>) - Method in class studio.mevera.imperat.command.arguments.type.handlers.EitherArgumentTypeHandler
 
resolve(Type, TypeWrap<?>, ArgumentTypeLookup<S>) - Method in class studio.mevera.imperat.command.arguments.type.handlers.EnumArgumentTypeHandler
 
resolve(Type, TypeWrap<?>, ArgumentTypeLookup<S>) - Method in class studio.mevera.imperat.command.arguments.type.handlers.MapArgumentTypeHandler
 
resolve(Type, TypeWrap<?>, ArgumentTypeLookup<S>) - Method in class studio.mevera.imperat.command.arguments.type.handlers.NumericArgumentTypeHandler
 
resolve(Type, TypeWrap<?>, ArgumentTypeLookup<S>) - Method in class studio.mevera.imperat.command.arguments.type.handlers.OptionalArgumentTypeHandler
 
resolve(Type, TypeWrap<?>, ArgumentTypeLookup<S>) - Method in class studio.mevera.imperat.command.arguments.type.SimpleTypeResolver
 
resolve(E, CommandContext<S>) - Method in class studio.mevera.imperat.annotations.base.parsers.MethodCommandExceptionHandler
 
resolve(E, CommandContext<S>) - Method in interface studio.mevera.imperat.exception.CommandExceptionHandler
Resolves the given exception within the provided execution context.
resolve(String) - Method in interface studio.mevera.imperat.placeholders.PlaceholderResolver
Resolves a placeholder
resolve(S, CommandContext<S>) - Method in interface studio.mevera.imperat.providers.SourceProvider
resolvedArray(String[]) - Method in class studio.mevera.imperat.placeholders.PlaceholderRegistry
 
resolveDependency(Type) - Method in interface studio.mevera.imperat.ImperatConfig
Resolves dependency of certain type
resolveFlag(ParsedFlagArgument<S>) - Method in interface studio.mevera.imperat.context.ExecutionContext
Registers a resolved flag in the context.
resolveInput(String) - Method in interface studio.mevera.imperat.placeholders.Placeholder
 
resolver() - Method in interface studio.mevera.imperat.placeholders.Placeholder
The dynamic resolver for this placeholder
resolver(PlaceholderResolver) - Method in class studio.mevera.imperat.placeholders.Placeholder.Builder
 
ResolverRegistrar<S extends CommandSource> - Interface in studio.mevera.imperat
The ResolverRegistrar interface provides mechanisms for registering and retrieving various types of resolvers, factories, and initializers that are contextually linked to specific source types and value types.
response(Response) - Method in class studio.mevera.imperat.ConfigBuilder
 
response(ResponseKey, Supplier<String>, String...) - Method in class studio.mevera.imperat.ConfigBuilder
 
Response - Class in studio.mevera.imperat.responses
 
Response(ResponseKey, Supplier<String>) - Constructor for class studio.mevera.imperat.responses.Response
 
Response(ResponseKey, Supplier<String>, ResponseContentFetcher) - Constructor for class studio.mevera.imperat.responses.Response
 
ResponseContentFetcher - Interface in studio.mevera.imperat.responses
 
ResponseException - Exception in studio.mevera.imperat.exception
Base class for all exceptions whose user-facing message is driven by the ResponseRegistry — i.e.
ResponseException(ResponseKey) - Constructor for exception studio.mevera.imperat.exception.ResponseException
 
ResponseException(ResponseKey, PlaceholderDataProvider) - Constructor for exception studio.mevera.imperat.exception.ResponseException
 
ResponseKey - Interface in studio.mevera.imperat.responses
 
ResponseRegistry - Interface in studio.mevera.imperat.responses
 
returnResolver(Type, ReturnResolver<S, ?>) - Method in class studio.mevera.imperat.ConfigBuilder
Registers a ReturnResolver
ReturnResolver<S extends CommandSource,T> - Interface in studio.mevera.imperat.command.returns
An interface that represents a way to handle a returned value from a method that does is NOT void.
ReturnResolverRegistry<S extends CommandSource> - Class in studio.mevera.imperat.command
 
ReturnResolverRegistry() - Constructor for class studio.mevera.imperat.command.ReturnResolverRegistry
 
right() - Method in record class studio.mevera.imperat.util.Pair
Returns the value of the right record component.
root() - Method in interface studio.mevera.imperat.command.tree.CommandTree
Gets the root command of this command tree.
RootCommand - Annotation Interface in studio.mevera.imperat.annotations.types
Declares a command entry point on a type or method.
RootCommandClass<S extends CommandSource> - Class in studio.mevera.imperat.annotations.base.element
Represents a root command class information
RootCommandClass(Class<?>, Object) - Constructor for class studio.mevera.imperat.annotations.base.element.RootCommandClass
 
rootNode() - Method in interface studio.mevera.imperat.command.tree.CommandTree
Gets the root node of this command tree.
Rule<T> - Interface in studio.mevera.imperat.annotations.base.element.selector
 
Rule.Builder<T> - Class in studio.mevera.imperat.annotations.base.element.selector
 
Rule.SimpleRule<T> - Class in studio.mevera.imperat.annotations.base.element.selector
 
RuleCondition<E> - Interface in studio.mevera.imperat.annotations.base.element.selector
 
run() - Method in interface studio.mevera.imperat.command.CommandCoordinator.UnsafeRunnable
 
runUnsafe() - Method in interface studio.mevera.imperat.command.CommandCoordinator.UnsafeRunnable
 

S

search(BiPredicate<K, V>) - Method in class studio.mevera.imperat.util.Registry
 
secret(boolean) - Method in class studio.mevera.imperat.command.Command.Builder
 
Secret - Annotation Interface in studio.mevera.imperat.annotations.types
Marks a command or command class/method as secret, meaning it will not be listed in help commands and may be hidden from tab-completion results.
SelfHandlingException - Exception in studio.mevera.imperat.exception
 
SelfHandlingException() - Constructor for exception studio.mevera.imperat.exception.SelfHandlingException
 
send(S) - Method in class studio.mevera.imperat.command.tree.help.theme.HelpComponent
 
send(S) - Method in class studio.mevera.imperat.command.tree.help.theme.StringHelpComponent
 
sendContent(CommandContext<S>, PlaceholderDataProvider) - Method in class studio.mevera.imperat.responses.Response
 
set(Annotation) - Method in class studio.mevera.imperat.util.AnnotationMap
 
set(Object, Object) - Method in interface studio.mevera.imperat.util.reflection.FieldAccessor
Set the content of a field.
setAllowVariants(boolean) - Method in class studio.mevera.imperat.command.arguments.type.BooleanArgument
 
setAnnotationParser(AnnotationParser<S>) - Method in interface studio.mevera.imperat.AnnotationInjector
Changes the instance of AnnotationParser
setAnnotationParser(AnnotationParser<S>) - Method in class studio.mevera.imperat.BaseImperat
Changes the instance of AnnotationParser
setAt(Cursor<S>) - Method in interface studio.mevera.imperat.context.internal.Cursor
 
setCancelled(boolean) - Method in interface studio.mevera.imperat.events.CancellableEvent
Sets the cancellation state of this event.
setCancelled(boolean) - Method in class studio.mevera.imperat.events.types.CommandPostProcessEvent
 
setCancelled(boolean) - Method in class studio.mevera.imperat.events.types.CommandPreProcessEvent
 
setCancelled(boolean) - Method in class studio.mevera.imperat.events.types.CommandPreRegistrationEvent
Sets whether the command registration should be cancelled.
setCommandParsingMode(CommandParsingMode) - Method in interface studio.mevera.imperat.ImperatConfig
 
setCommandPrefix(String) - Method in interface studio.mevera.imperat.ImperatConfig
 
setCompletionCache(CommandNode.CompletionCache<S>) - Method in class studio.mevera.imperat.command.tree.CommandNode
 
setCondition(CommandPermissionCondition) - Method in class studio.mevera.imperat.permissions.PermissionsData
 
setContextFactory(ContextFactory<S>) - Method in interface studio.mevera.imperat.ImperatConfig
sets the context factory ContextFactory for the contexts
setCooldown(long, TimeUnit) - Method in interface studio.mevera.imperat.command.CooldownHolder
 
setCooldown(long, TimeUnit, String) - Method in interface studio.mevera.imperat.command.CooldownHolder
 
setCooldown(CooldownRecord) - Method in interface studio.mevera.imperat.command.CooldownHolder
 
setCooldownHandler(CooldownHandler<S>) - Method in interface studio.mevera.imperat.command.CommandPathway
Sets the cooldown handler CooldownHandler
setCoordinator(CommandCoordinator<S>) - Method in interface studio.mevera.imperat.command.CommandPathway
Sets the command coordinator
setCoroutineScope(Object) - Method in interface studio.mevera.imperat.ImperatConfig
 
setData(K, V) - Method in class studio.mevera.imperat.util.Registry
 
setDefaultPathway(CommandPathway<S>) - Method in interface studio.mevera.imperat.command.Command
Sets the default command usage representation.
setDefaultSuggestionProvider(SuggestionProvider<S>) - Method in interface studio.mevera.imperat.ResolverRegistrar
Sets the default suggestion resolver to be used when no specific suggestion resolver is provided.
setDetectedPathway(CommandPathway<S>) - Method in interface studio.mevera.imperat.context.ExecutionContext
 
setEnabled(boolean) - Static method in class studio.mevera.imperat.util.ImperatDebugger
 
setErrorHandler(Class<T>, CommandExceptionHandler<T, S>) - Method in interface studio.mevera.imperat.ImperatConfig
Registers a new CommandExceptionHandler for the specified valueType of throwable.
setErrorHandler(Class<T>, CommandExceptionHandler<T, S>) - Method in interface studio.mevera.imperat.ThrowableHandler
Registers a CommandExceptionHandler for a specific exception type and returns the registered resolver instance.
setEventBus(EventBus) - Method in interface studio.mevera.imperat.ImperatConfig
 
setExecutableUsage(CommandPathway<S>) - Method in class studio.mevera.imperat.command.tree.CommandNode
 
setFailureCause(Throwable) - Method in class studio.mevera.imperat.events.types.CommandPostRegistrationEvent
Sets the exception that caused the registration to fail.
setFormat(String) - Method in interface studio.mevera.imperat.command.arguments.Argument
Sets a custom format for this parameter the default value is the name of the parameter
setFormat(String) - Method in class studio.mevera.imperat.command.arguments.InputArgument
 
setGlobalCommandCoordinator(CommandCoordinator<S>) - Method in interface studio.mevera.imperat.ImperatConfig
 
setGlobalDefaultPathway(CommandPathway.Builder<S>) - Method in interface studio.mevera.imperat.ImperatConfig
Sets the usual default usage if the user doesn't set the default-usage for a Command
setHandleExecutionConsecutiveOptionalArgumentsSkip(boolean) - Method in interface studio.mevera.imperat.ImperatConfig
Refer to ImperatConfig.handleExecutionMiddleOptionalSkipping() to know about this option.
setHelpCoordinator(HelpCoordinator<S>) - Method in interface studio.mevera.imperat.ImperatConfig
Sets the coordinator for displaying of a help.
setIgnoreACPermissions(boolean) - Method in interface studio.mevera.imperat.command.Command
if true, it will ignore permission checks on the auto-completion of command and sub commands
setInstanceFactory(InstanceFactory<S>) - Method in interface studio.mevera.imperat.ImperatConfig
Sets the instance factory for creating instances of types to be dependency injected.
setLogger(Logger) - Static method in class studio.mevera.imperat.util.ImperatDebugger
 
setMetaPropertiesFromOtherCommand(Command<S>) - Method in class studio.mevera.imperat.command.Command.Builder
 
setNearestExecutableUsage(CommandPathway<S>) - Method in class studio.mevera.imperat.command.tree.CommandNode
 
setOptionalParameterSuggestionOverlap(boolean) - Method in interface studio.mevera.imperat.ImperatConfig
Sets whether multiple optional parameters can be suggested simultaneously during tab completion at the same command depth level.
setOptionValue(HelpTheme.Option<T>, T) - Method in class studio.mevera.imperat.command.tree.help.theme.BaseHelpTheme
 
setOptionValue(HelpTheme.Option<T>, T) - Method in interface studio.mevera.imperat.command.tree.help.theme.HelpTheme
 
setParent(Command<S>) - Method in class studio.mevera.imperat.command.arguments.InputArgument
 
setParent(Command<S>) - Method in interface studio.mevera.imperat.command.arguments.Argument
Sets parent command for a parameter
setPermissionData(PermissionsData) - Method in class studio.mevera.imperat.command.arguments.InputArgument
 
setPermissionData(PermissionsData) - Method in interface studio.mevera.imperat.permissions.PermissionHolder
 
setPermissionResolver(PermissionChecker<S>) - Method in interface studio.mevera.imperat.ImperatConfig
Sets the permission resolver for the platform
setPosition(int) - Method in interface studio.mevera.imperat.command.arguments.Argument
Sets the position of this parameter in a syntax DO NOT USE THIS FOR ANY REASON unless it's necessary to do so
setPosition(int) - Method in class studio.mevera.imperat.command.arguments.InputArgument
Sets the position of this parameter in a syntax DO NOT USE THIS FOR ANY REASON unless it's necessary to do so
setPosition(int) - Method in interface studio.mevera.imperat.command.Command
Sets the position of this command in a syntax DO NOT USE THIS FOR ANY REASON unless it's necessary to do so
setPostProcessingChain(PriorityList<CommandPostProcessor<S>>) - Method in interface studio.mevera.imperat.command.Command
 
setPreProcessingChain(PriorityList<CommandPreProcessor<S>>) - Method in interface studio.mevera.imperat.command.Command
 
setRootCommand(Command<S>) - Method in class studio.mevera.imperat.annotations.base.element.RootCommandClass
 
setSecret(boolean) - Method in interface studio.mevera.imperat.command.Command
Sets whether this parameter is secret, meaning it won't be displayed in the usage of the command, and it will be ignored in the auto-completion suggestions
setTesting(boolean) - Static method in class studio.mevera.imperat.util.ImperatDebugger
 
setThrowablePrinter(ThrowablePrinter) - Method in interface studio.mevera.imperat.ImperatConfig
Sets the printer used for unhandled throwables.
setTreeResult(TreeExecutionResult<S>) - Method in interface studio.mevera.imperat.context.ExecutionContext
 
setUsingTestCases(boolean) - Static method in class studio.mevera.imperat.util.ImperatDebugger
 
ShiftTarget - Enum Class in studio.mevera.imperat.context.internal
 
Shortcut - Annotation Interface in studio.mevera.imperat.annotations.types
Annotation to forward or redirect the usages of a command/subcommand to another command/subcommand, therefore, the forwarded command/subcommand will be executed the same with same input-parameters as the inheriting one.
SHOW_FOOTER - Static variable in interface studio.mevera.imperat.command.tree.help.theme.HelpTheme.Option
 
SHOW_HEADER - Static variable in interface studio.mevera.imperat.command.tree.help.theme.HelpTheme.Option
 
showHelp(ExecutionContext<S>, HelpQuery<S>, HelpTheme<S, C>) - Method in class studio.mevera.imperat.command.tree.help.HelpCoordinator
Displays the help documentation based on the given context and query.
shutdown() - Method in interface studio.mevera.imperat.events.EventBus
Shuts down the event bus, releasing resources.
shutdownAndWait() - Method in interface studio.mevera.imperat.events.EventBus
Shuts down the event bus and blocks until all async handlers finish executing.
shutdownPlatform() - Method in interface studio.mevera.imperat.Imperat
Shuts down the platform
similarTo(Argument<?>) - Method in interface studio.mevera.imperat.command.arguments.Argument
Checks if this parameter has same name and valueType to the other Argument unlike `Argument#equals(Object)`, if both parameters are only different in their parent Command, it would still return true
similarTo(Argument<?>) - Method in class studio.mevera.imperat.command.arguments.InputArgument
 
simple() - Static method in interface studio.mevera.imperat.ThrowablePrinter
Returns a simple printer that logs the throwable using the IMPERAT logger.
SimpleRule(RuleCondition<T>, BiConsumer<AnnotationParser<?>, T>) - Constructor for class studio.mevera.imperat.annotations.base.element.selector.Rule.SimpleRule
 
SimpleTypeResolver<S extends CommandSource,T> - Class in studio.mevera.imperat.command.arguments.type
An ArgumentTypeHandler that wraps a simple Supplier for non-generic types.
SimpleTypeResolver(Type, Supplier<ArgumentType<S, T>>) - Constructor for class studio.mevera.imperat.command.arguments.type.SimpleTypeResolver
Creates a new SimpleTypeResolver with Priority.HIGH.
SimpleTypeResolver(Type, Supplier<ArgumentType<S, T>>, Priority) - Constructor for class studio.mevera.imperat.command.arguments.type.SimpleTypeResolver
Creates a new SimpleTypeResolver with the specified priority.
SimpleTypeResolver(Type, Supplier<ArgumentType<S, T>>, Priority, boolean) - Constructor for class studio.mevera.imperat.command.arguments.type.SimpleTypeResolver
Creates a new SimpleTypeResolver with full configuration.
SINGLE_FLAG - Static variable in class studio.mevera.imperat.util.Patterns
 
SINGLE_QUOTE - Static variable in class studio.mevera.imperat.util.StringUtils
 
size() - Method in class studio.mevera.imperat.annotations.base.element.MethodElement
 
size() - Method in interface studio.mevera.imperat.command.CommandPathway
 
size() - Method in interface studio.mevera.imperat.command.tree.CommandTree
The number of nodes cached in this CommandTree.
size() - Method in class studio.mevera.imperat.command.tree.help.HelpEntryList
Returns the number of entries.
size() - Method in class studio.mevera.imperat.util.priority.PriorityList
Returns the number of elements in this list.
size() - Method in class studio.mevera.imperat.util.Registry
 
skip() - Method in interface studio.mevera.imperat.context.internal.Cursor
Skips the current input element and advances the appropriate cursor.
skipLetter() - Method in interface studio.mevera.imperat.context.internal.Cursor
Skips the current character and advances the character cursor.
skipParameter() - Method in interface studio.mevera.imperat.context.internal.Cursor
Skips the current command parameter and advances the parameter cursor.
skipRaw() - Method in interface studio.mevera.imperat.context.internal.Cursor
Skips the current raw input and advances the raw input cursor.
skipSuggestionsChecks() - Element in annotation interface studio.mevera.imperat.annotations.types.RootCommand
 
skipSuggestionsChecks() - Element in annotation interface studio.mevera.imperat.annotations.types.SubCommand
 
skipTill(char) - Method in interface studio.mevera.imperat.context.internal.Cursor
Advances the character cursor until the specified target character is encountered.
SNOWFLAKE - Static variable in class studio.mevera.imperat.util.StringUtils
Pattern to extract snowflake IDs.
source() - Method in interface studio.mevera.imperat.context.CommandContext
 
SourceOrderHelper - Class in studio.mevera.imperat.annotations.base
 
sourceProvider(Type, SourceProvider<S, R>) - Method in class studio.mevera.imperat.ConfigBuilder
Registers a SourceProvider for a specific type to resolve command sources.
SourceProvider<S extends CommandSource,R> - Interface in studio.mevera.imperat.providers
An interface whose single responsibility is to resolve SourceProvider into SourceProvider to allow custom command sources
SourceProviderRegistry<S extends CommandSource> - Class in studio.mevera.imperat.command
 
SourceWrapper<S extends CommandSource> - Interface in studio.mevera.imperat
A sealed interface representing the abstraction for wrapping and handling sources or senders of commands, and validating the compatibility of a type as a sender.
StandardHelpRenderer<S extends CommandSource,C> - Class in studio.mevera.imperat.command.tree.help.renderers
Standard help renderer that displays help entries in a flat list format.
StandardHelpRenderer() - Constructor for class studio.mevera.imperat.command.tree.help.renderers.StandardHelpRenderer
 
StandardTreeHelpVisitor<S extends CommandSource> - Class in studio.mevera.imperat.command.tree.help
Standard help provider that queries the command tree.
StandardTreeHelpVisitor() - Constructor for class studio.mevera.imperat.command.tree.help.StandardTreeHelpVisitor
 
staticSuggestions(String...) - Static method in interface studio.mevera.imperat.providers.SuggestionProvider
 
staticSuggestions(List<String>) - Static method in interface studio.mevera.imperat.providers.SuggestionProvider
 
strategy() - Method in interface studio.mevera.imperat.events.EventSubscription
Returns the execution strategy for this subscription, determining whether the handler runs in the posting thread (ExecutionStrategy.SYNC) or in a background thread (ExecutionStrategy.ASYNC).
stream() - Method in class studio.mevera.imperat.util.priority.PriorityList
Returns a sequential Stream of the elements in this list, ordered by priority.
StrictArgumentList<S extends CommandSource> - Class in studio.mevera.imperat.command.arguments
 
StrictArgumentList() - Constructor for class studio.mevera.imperat.command.arguments.StrictArgumentList
 
string() - Static method in class studio.mevera.imperat.command.arguments.type.ArgumentTypes
 
StringArgument<S extends CommandSource> - Class in studio.mevera.imperat.command.arguments.type
 
StringHelpComponent<S extends CommandSource> - Class in studio.mevera.imperat.command.tree.help.theme
 
StringHelpComponent(String) - Constructor for class studio.mevera.imperat.command.tree.help.theme.StringHelpComponent
 
StringUtils - Class in studio.mevera.imperat.util
 
stripNamespace(String) - Static method in class studio.mevera.imperat.util.StringUtils
 
studio.mevera.imperat - package studio.mevera.imperat
 
studio.mevera.imperat.annotations.base - package studio.mevera.imperat.annotations.base
 
studio.mevera.imperat.annotations.base.element - package studio.mevera.imperat.annotations.base.element
 
studio.mevera.imperat.annotations.base.element.selector - package studio.mevera.imperat.annotations.base.element.selector
 
studio.mevera.imperat.annotations.base.parsers - package studio.mevera.imperat.annotations.base.parsers
 
studio.mevera.imperat.annotations.parameters - package studio.mevera.imperat.annotations.parameters
 
studio.mevera.imperat.annotations.types - package studio.mevera.imperat.annotations.types
 
studio.mevera.imperat.command - package studio.mevera.imperat.command
 
studio.mevera.imperat.command.arguments - package studio.mevera.imperat.command.arguments
 
studio.mevera.imperat.command.arguments.type - package studio.mevera.imperat.command.arguments.type
 
studio.mevera.imperat.command.arguments.type.handlers - package studio.mevera.imperat.command.arguments.type.handlers
Contains built-in ArgumentTypeHandler implementations for common generic and specialized types.
studio.mevera.imperat.command.arguments.validator - package studio.mevera.imperat.command.arguments.validator
 
studio.mevera.imperat.command.cooldown - package studio.mevera.imperat.command.cooldown
 
studio.mevera.imperat.command.flags - package studio.mevera.imperat.command.flags
 
studio.mevera.imperat.command.processors - package studio.mevera.imperat.command.processors
 
studio.mevera.imperat.command.processors.impl - package studio.mevera.imperat.command.processors.impl
 
studio.mevera.imperat.command.returns - package studio.mevera.imperat.command.returns
 
studio.mevera.imperat.command.suggestions - package studio.mevera.imperat.command.suggestions
 
studio.mevera.imperat.command.tree - package studio.mevera.imperat.command.tree
 
studio.mevera.imperat.command.tree.help - package studio.mevera.imperat.command.tree.help
 
studio.mevera.imperat.command.tree.help.renderers - package studio.mevera.imperat.command.tree.help.renderers
 
studio.mevera.imperat.command.tree.help.theme - package studio.mevera.imperat.command.tree.help.theme
 
studio.mevera.imperat.context - package studio.mevera.imperat.context
 
studio.mevera.imperat.context.internal - package studio.mevera.imperat.context.internal
 
studio.mevera.imperat.events - package studio.mevera.imperat.events
 
studio.mevera.imperat.events.exception - package studio.mevera.imperat.events.exception
 
studio.mevera.imperat.events.types - package studio.mevera.imperat.events.types
 
studio.mevera.imperat.exception - package studio.mevera.imperat.exception
 
studio.mevera.imperat.permissions - package studio.mevera.imperat.permissions
 
studio.mevera.imperat.placeholders - package studio.mevera.imperat.placeholders
 
studio.mevera.imperat.providers - package studio.mevera.imperat.providers
 
studio.mevera.imperat.responses - package studio.mevera.imperat.responses
 
studio.mevera.imperat.util - package studio.mevera.imperat.util
 
studio.mevera.imperat.util.asm - package studio.mevera.imperat.util.asm
 
studio.mevera.imperat.util.priority - package studio.mevera.imperat.util.priority
 
studio.mevera.imperat.util.reflection - package studio.mevera.imperat.util.reflection
 
subCommand(Command<S>) - Method in class studio.mevera.imperat.command.Command.Builder
 
subCommand(Command<S>, String) - Method in class studio.mevera.imperat.command.Command.Builder
 
SubCommand - Annotation Interface in studio.mevera.imperat.annotations.types
Declares a subcommand on a type or method, with optional attachment mode and suggestion-permission behavior.
subCursor(Cursor<S>, String) - Static method in interface studio.mevera.imperat.context.internal.Cursor
Creates a subcursor of the specified parent cursor with new input content.
subList(int, int) - Method in class studio.mevera.imperat.command.tree.help.HelpEntryList
Creates a copy of a range of elements.
success(ExecutionContext<S>, CommandPathway<S>, CommandPathway<S>, Command<S>, List<ParseResult<S>>) - Static method in class studio.mevera.imperat.command.tree.TreeExecutionResult
Creates a successful execution result.
SUCCESS - Enum constant in enum class studio.mevera.imperat.command.tree.TreeExecutionResult.Status
The tree traversal found a matching pathway and successfully executed it.
successful(Object, Argument<S>, String, int, int) - Static method in class studio.mevera.imperat.command.tree.ParseResult
 
suggest(String...) - Method in class studio.mevera.imperat.command.arguments.ArgumentBuilder
 
suggest(SuggestionProvider<S>) - Method in class studio.mevera.imperat.command.arguments.ArgumentBuilder
 
Suggest - Annotation Interface in studio.mevera.imperat.annotations.types
Provides a fixed set of inline suggestions for a parameter during tab-completion.
suggestForInputValue(SuggestionProvider<S>) - Method in class studio.mevera.imperat.command.arguments.FlagArgumentBuilder
 
SuggestionContext<S extends CommandSource> - Interface in studio.mevera.imperat.context
Represents the context for auto-completion while providing suggestions
suggestionProvider - Variable in class studio.mevera.imperat.command.arguments.InputArgument
 
suggestionProvider() - Method in record class studio.mevera.imperat.command.tree.CommandNode.CompletionCache
Returns the value of the suggestionProvider record component.
SuggestionProvider<S extends CommandSource> - Interface in studio.mevera.imperat.providers
Represents a suggestion providing interface for an argument/parameter
SuggestionProvider - Annotation Interface in studio.mevera.imperat.annotations.types
Binds a parameter's suggestions to a named provider registered in the system.
suggestions - Variable in class studio.mevera.imperat.command.arguments.type.ArgumentType
A list storing suggestions for parameter types in a command processing framework.
suppressPermissionCheckDuringAutoCompletion() - Element in annotation interface studio.mevera.imperat.annotations.types.PathwayCommand
 
supressPermissionsForAutoCompletion(boolean) - Method in class studio.mevera.imperat.command.Command.Builder
 
Switch - Annotation Interface in studio.mevera.imperat.annotations.types
Declares one or more switch names for a boolean-like parameter.
sync() - Static method in interface studio.mevera.imperat.command.CommandCoordinator
 
SYNC - Enum constant in enum class studio.mevera.imperat.events.ExecutionStrategy
Handler executes synchronously in the posting thread.

T

tabComplete(SuggestionContext<S>) - Method in interface studio.mevera.imperat.command.tree.CommandTree
Generates tab-completion suggestions based on the current command context.
test(Imperat, AnnotationParser<?>, E) - Method in interface studio.mevera.imperat.annotations.base.element.selector.RuleCondition
 
test(Imperat, AnnotationParser<?>, T) - Method in interface studio.mevera.imperat.annotations.base.element.selector.Rule
 
TextBasedHelpTheme<S extends CommandSource> - Class in studio.mevera.imperat.command.tree.help.theme
 
TextBasedHelpTheme() - Constructor for class studio.mevera.imperat.command.tree.help.theme.TextBasedHelpTheme
 
TextHelpTheme<S extends CommandSource> - Class in studio.mevera.imperat.command.tree.help.theme
 
TextHelpTheme() - Constructor for class studio.mevera.imperat.command.tree.help.theme.TextHelpTheme
 
ThrowableHandler<S extends CommandSource> - Interface in studio.mevera.imperat
The ThrowableHandler interface defines a mechanism for managing and resolving throwable instances within a given context.
throwablePrinter(ThrowablePrinter) - Method in class studio.mevera.imperat.ConfigBuilder
Sets the ThrowablePrinter used to print unhandled exceptions.
ThrowablePrinter - Interface in studio.mevera.imperat
Strategy interface responsible for printing throwables that are caught but not otherwise handled.
toArray() - Method in class studio.mevera.imperat.command.tree.help.HelpEntryList
Converts to an array.
toDuration() - Method in class studio.mevera.imperat.command.cooldown.CooldownRecord
 
toList() - Method in class studio.mevera.imperat.util.priority.PriorityList
Returns a list of all elements in priority order.
toParsedArgument() - Method in class studio.mevera.imperat.command.tree.ParseResult
 
toSet() - Method in class studio.mevera.imperat.command.tree.help.HelpEntryList
Converts to a Java Set (LinkedHashSet).
toString() - Method in class studio.mevera.imperat.annotations.base.element.ParameterElement
 
toString() - Method in class studio.mevera.imperat.annotations.base.element.ParseElement
 
toString() - Method in class studio.mevera.imperat.command.arguments.InputArgument
 
toString() - Method in class studio.mevera.imperat.command.returns.BaseReturnResolver
 
toString() - Method in record class studio.mevera.imperat.command.suggestions.CompletionArg
Returns a string representation of this record class.
toString() - Method in record class studio.mevera.imperat.command.tree.CommandNode.CompletionCache
Returns a string representation of this record class.
toString() - Method in class studio.mevera.imperat.command.tree.help.HelpEntryList
 
toString() - Method in record class studio.mevera.imperat.context.FlagData.FlagDataImpl
Returns a string representation of this record class.
toString() - Method in class studio.mevera.imperat.context.ParsedArgument
 
toString() - Method in class studio.mevera.imperat.permissions.CommandPermissionCondition
 
toString() - Method in record class studio.mevera.imperat.util.Pair
Returns a string representation of this record class.
toString() - Method in class studio.mevera.imperat.util.priority.PriorityList
 
tree() - Method in interface studio.mevera.imperat.command.Command
 
TreeExecutionResult<S extends CommandSource> - Class in studio.mevera.imperat.command.tree
Represents the result of a direct tree execution.
TreeExecutionResult.Status - Enum Class in studio.mevera.imperat.command.tree
The status of a tree execution.
TreeHelpVisitor<S extends CommandSource> - Interface in studio.mevera.imperat.command.tree.help
Provides help data by visiting the command tree, node by node.
trimToSize() - Method in class studio.mevera.imperat.command.tree.help.HelpEntryList
Trims the internal capacity to the current size.
type - Variable in class studio.mevera.imperat.command.arguments.InputArgument
 
type - Variable in class studio.mevera.imperat.command.arguments.type.ArgumentType
Encapsulates type information for the parameter being handled.
type() - Element in annotation interface studio.mevera.imperat.annotations.types.InheritedArg
The expected type of the inherited argument (for validation).
type() - Method in interface studio.mevera.imperat.command.arguments.Argument
Retrieves the parameter type associated with this command parameter.
type() - Method in class studio.mevera.imperat.command.arguments.InputArgument
 
type() - Method in class studio.mevera.imperat.command.arguments.type.ArgumentType
Retrieves the Type associated with this BaseArgumentType.
type() - Method in interface studio.mevera.imperat.command.Command
Retrieves the parameter type associated with the current command, including its name and any aliases.
TypeCapturer - Class in studio.mevera.imperat.util
 
TypeCapturer() - Constructor for class studio.mevera.imperat.util.TypeCapturer
 
TypeUtility - Class in studio.mevera.imperat.util
 
TypeWrap<T> - Class in studio.mevera.imperat.util
 
TypeWrap() - Constructor for class studio.mevera.imperat.util.TypeWrap
 

U

unit() - Element in annotation interface studio.mevera.imperat.annotations.types.Cooldown
 
unit() - Method in class studio.mevera.imperat.command.cooldown.CooldownRecord
 
UNKNOWN_FLAG - Static variable in interface studio.mevera.imperat.responses.ResponseKey
 
UnknownCommandException - Exception in studio.mevera.imperat.exception
 
UnknownCommandException(String) - Constructor for exception studio.mevera.imperat.exception.UnknownCommandException
 
UnknownDependencyException - Exception in studio.mevera.imperat.exception
 
UnknownDependencyException(String) - Constructor for exception studio.mevera.imperat.exception.UnknownDependencyException
 
UnknownDependencyException(String, Throwable) - Constructor for exception studio.mevera.imperat.exception.UnknownDependencyException
 
unregister(UUID) - Method in interface studio.mevera.imperat.events.EventBus
Unregisters a subscription by its unique identifier.
unregisterAllCommands() - Method in class studio.mevera.imperat.BaseImperat
Unregisters all commands from the internal registry
unregisterAllCommands() - Method in interface studio.mevera.imperat.CommandRegistrar
Unregisters all commands from the internal registry
unregisterCommand(String) - Method in class studio.mevera.imperat.BaseImperat
Unregisters a command from the internal registry
unregisterCommand(String) - Method in interface studio.mevera.imperat.CommandRegistrar
Unregisters a command from the internal registry
unwrap() - Method in class studio.mevera.imperat.util.TypeWrap
 
update(K, Function<? super V, ? extends V>) - Method in class studio.mevera.imperat.util.Registry
 
updateData(K, Consumer<V>) - Method in class studio.mevera.imperat.util.Registry
 
updateIfAbsent(K, Function<? super K, ? extends V>) - Method in class studio.mevera.imperat.util.Registry
 
updateIfPresent(K, Function<? super V, ? extends V>) - Method in class studio.mevera.imperat.util.Registry
 
UsageFormatter<S extends CommandSource,C> - Interface in studio.mevera.imperat.command.tree.help.renderers
Interface for formatting command usage paths into displayable help components.
UsageFormatting - Class in studio.mevera.imperat.util
 
uuid() - Static method in class studio.mevera.imperat.command.arguments.type.ArgumentTypes
 
uuid() - Method in interface studio.mevera.imperat.context.CommandSource
 
UUIDArgument<S extends CommandSource> - Class in studio.mevera.imperat.command.arguments.type
 
UUIDArgument() - Constructor for class studio.mevera.imperat.command.arguments.type.UUIDArgument
 

V

validate(List<ArgValidator<S>>) - Method in class studio.mevera.imperat.command.arguments.ArgumentBuilder
 
validate(ArgValidator<S>) - Method in class studio.mevera.imperat.command.arguments.ArgumentBuilder
 
validate(CommandContext<S>, ParsedArgument<S>) - Method in interface studio.mevera.imperat.command.arguments.validator.ArgValidator
 
validate(CommandContext<S>, ParsedArgument<S>) - Method in class studio.mevera.imperat.command.arguments.validator.ConstrainedValueValidator
 
validate(CommandContext<S>, ParsedArgument<S>) - Method in class studio.mevera.imperat.command.arguments.validator.RangeValidator
 
validate(ExecutionContext<S>, ParsedArgument<S>) - Method in interface studio.mevera.imperat.command.arguments.Argument
 
validate(ExecutionContext<S>, ParsedArgument<S>) - Method in class studio.mevera.imperat.command.arguments.InputArgument
 
validators - Variable in class studio.mevera.imperat.command.arguments.ArgumentBuilder
 
Validators - Annotation Interface in studio.mevera.imperat.annotations.types
Container annotation for declaring one or more ArgValidator types on a command type or a specific parameter.
value() - Element in annotation interface studio.mevera.imperat.annotations.types.ArgType
 
value() - Element in annotation interface studio.mevera.imperat.annotations.types.Async
Optional parameter to specify a custom executor service provider.
value() - Element in annotation interface studio.mevera.imperat.annotations.types.Cooldown
 
value() - Element in annotation interface studio.mevera.imperat.annotations.types.Default
 
value() - Element in annotation interface studio.mevera.imperat.annotations.types.DefaultProvider
 
value() - Element in annotation interface studio.mevera.imperat.annotations.types.Description
 
value() - Element in annotation interface studio.mevera.imperat.annotations.types.ExceptionHandler
 
value() - Element in annotation interface studio.mevera.imperat.annotations.types.ExplicitReturnResolver
The class of the return resolver to use for this method.
value() - Element in annotation interface studio.mevera.imperat.annotations.types.ExternalSubCommand
 
value() - Element in annotation interface studio.mevera.imperat.annotations.types.Flag
 
value() - Element in annotation interface studio.mevera.imperat.annotations.types.Format
 
value() - Element in annotation interface studio.mevera.imperat.annotations.types.InheritedArg
The name of the argument to inherit from ancestor pathway.
value() - Element in annotation interface studio.mevera.imperat.annotations.types.Named
 
value() - Element in annotation interface studio.mevera.imperat.annotations.types.ParseOrder
The priority value.
value() - Element in annotation interface studio.mevera.imperat.annotations.types.PathwayCommand
 
value() - Element in annotation interface studio.mevera.imperat.annotations.types.Permission
 
value() - Element in annotation interface studio.mevera.imperat.annotations.types.Permissions
 
value() - Element in annotation interface studio.mevera.imperat.annotations.types.RootCommand
 
value() - Element in annotation interface studio.mevera.imperat.annotations.types.Shortcut
 
value() - Element in annotation interface studio.mevera.imperat.annotations.types.SubCommand
 
value() - Element in annotation interface studio.mevera.imperat.annotations.types.Suggest
 
value() - Element in annotation interface studio.mevera.imperat.annotations.types.SuggestionProvider
 
value() - Element in annotation interface studio.mevera.imperat.annotations.types.Switch
 
value() - Element in annotation interface studio.mevera.imperat.annotations.types.Validators
 
value() - Element in annotation interface studio.mevera.imperat.annotations.types.Values
Specific allowed values
value() - Method in class studio.mevera.imperat.command.cooldown.CooldownRecord
 
value() - Method in record class studio.mevera.imperat.command.suggestions.CompletionArg
Returns the value of the value record component.
VALUE_OUT_OF_CONSTRAINT - Static variable in interface studio.mevera.imperat.responses.ResponseKey
 
valueOf(String) - Static method in enum class studio.mevera.imperat.command.tree.TreeExecutionResult.Status
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class studio.mevera.imperat.CommandParsingMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class studio.mevera.imperat.context.internal.ShiftTarget
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class studio.mevera.imperat.events.ExecutionStrategy
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class studio.mevera.imperat.exception.ProcessorException.Type
Returns the enum constant of this class with the specified name.
values() - Static method in enum class studio.mevera.imperat.command.tree.TreeExecutionResult.Status
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class studio.mevera.imperat.CommandParsingMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class studio.mevera.imperat.context.internal.ShiftTarget
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class studio.mevera.imperat.events.ExecutionStrategy
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class studio.mevera.imperat.exception.ProcessorException.Type
Returns an array containing the constants of this enum class, in the order they are declared.
Values - Annotation Interface in studio.mevera.imperat.annotations.types
Restricts a parameter to a predefined set of allowed string values.
valueType() - Method in interface studio.mevera.imperat.command.arguments.Argument
 
verifyWithFail(Rule<E>, Imperat<?>, AnnotationParser<?>, E) - Method in interface studio.mevera.imperat.annotations.base.element.selector.ElementSelector
 
visibleFlags() - Method in record class studio.mevera.imperat.command.tree.CommandNode.CompletionCache
Returns the value of the visibleFlags record component.
visit(Function<ImperatConfig<S>, T>, Consumer<T>) - Method in class studio.mevera.imperat.ConfigBuilder
 
visit(Command<S>, HelpQuery<S>) - Method in class studio.mevera.imperat.command.tree.help.StandardTreeHelpVisitor
 
visit(Command<S>, HelpQuery<S>) - Method in interface studio.mevera.imperat.command.tree.help.TreeHelpVisitor
Queries help entries based on the given query parameters.
visitCommandClass(ClassElement) - Method in class studio.mevera.imperat.annotations.base.parsers.CommandClassParser
 
visitCommandClass(ClassElement) - Method in class studio.mevera.imperat.annotations.base.parsers.CommandElementParser
 
visualize() - Method in class studio.mevera.imperat.command.tree.CommandTreeVisualizer
 
visualizeSimple() - Method in class studio.mevera.imperat.command.tree.CommandTreeVisualizer
Alternative visualization using a simpler node representation
visualizeTree() - Method in interface studio.mevera.imperat.command.Command
Debugs or visualizes all tree nodes from CommandTree.

W

warn(String) - Method in interface studio.mevera.imperat.context.CommandSource
Replies to the command sender with a string message formatted specifically for error messages
warning(String, Object...) - Static method in class studio.mevera.imperat.util.ImperatDebugger
 
withContextPlaceholders(CommandContext<S>) - Method in exception studio.mevera.imperat.exception.ResponseException
 
withFlags(Set<FlagArgument<S>>) - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
withFlags(FlagArgument<S>...) - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
withFlags(FlagArgumentBuilder<S, ?>...) - Method in class studio.mevera.imperat.command.CommandPathway.Builder
 
withoutFlagSign(String) - Static method in class studio.mevera.imperat.util.Patterns
 
withPermission(String) - Static method in class studio.mevera.imperat.command.tree.help.HelpFilters
Creates a filter that only includes pathways with a specific permission.
withPlaceholder(String, String) - Method in exception studio.mevera.imperat.exception.ResponseException
 
withPlaceholder(String, Supplier<String>) - Method in exception studio.mevera.imperat.exception.ResponseException
 
withPlaceholder(Placeholder) - Method in exception studio.mevera.imperat.exception.ResponseException
 
wrap() - Method in class studio.mevera.imperat.util.TypeWrap
 
wrappedType() - Method in interface studio.mevera.imperat.command.arguments.Argument
 
wrappedType() - Method in class studio.mevera.imperat.command.arguments.InputArgument
 
wrappedType() - Method in class studio.mevera.imperat.command.arguments.type.ArgumentType
Gets a TypeWrap for the handled type.
wrappedType() - Method in interface studio.mevera.imperat.command.Command
 
wrapSender(Object) - Method in interface studio.mevera.imperat.SourceWrapper
Wraps the sender into a built-in command-sender valueType
A B C D E F G H I J K L M N O P Q R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form