A B C D E F G H I K L M N O P R S T U V W

A

ABSENT_VALUE - Static variable in class revxrsal.commands.reflect.ktx.KotlinConstants

accept(LampVisitor<A>) - Method in class revxrsal.commands.Lamp

Accepts the given visitor by calling LampVisitor.visit(Lamp) on this Lamp instance

accept(LampBuilderVisitor<? super A>) - Method in class revxrsal.commands.Lamp.Builder

Accepts the given visitor by calling LampBuilderVisitor#visit(Builder) on this Lamp.Builder instance

action() - Method in interface revxrsal.commands.command.ExecutableCommand

Returns the action of this command.

action() - Method in interface revxrsal.commands.node.CommandNode

Returns the action bound to this command node.

actor() - Method in interface revxrsal.commands.exception.context.ErrorContext

Returns the actor

actor() - Method in interface revxrsal.commands.node.ExecutionContext

Returns the actor executing this command

addComparator(Comparator<ParameterType<?, ?>>) - Method in class revxrsal.commands.parameter.PrioritySpec.Builder

Adds the given comparator.

addContextParameter(Class<T>, ContextParameter<? super A, T>) - Method in class revxrsal.commands.parameter.ParameterTypes.Builder

Registers a ParameterType that matches a specific class.

addContextParameterFactory(ContextParameter.Factory<? super A>) - Method in class revxrsal.commands.parameter.ParameterTypes.Builder

Registers a ParameterType.Factory to this registry.

addContextParameterFactoryLast(ContextParameter.Factory<? super A>) - Method in class revxrsal.commands.parameter.ParameterTypes.Builder

Registers a ParameterType.Factory to this registry.

addContextParameterLast(Class<T>, ContextParameter<? super A, T>) - Method in class revxrsal.commands.parameter.ParameterTypes.Builder

Registers a ParameterType that matches a specific class.

addParameterType(Class<T>, ParameterType<? super A, T>) - Method in class revxrsal.commands.parameter.ParameterTypes.Builder

Registers a ParameterType that matches a specific class.

addParameterTypeFactory(ParameterType.Factory<? super A>) - Method in class revxrsal.commands.parameter.ParameterTypes.Builder

Registers a ParameterType.Factory to this registry.

addParameterTypeFactoryLast(ParameterType.Factory<? super A>) - Method in class revxrsal.commands.parameter.ParameterTypes.Builder

Registers a ParameterType.Factory to this registry.

addParameterTypeLast(Class<T>, ParameterType<? super A, T>) - Method in class revxrsal.commands.parameter.ParameterTypes.Builder

Registers a ParameterType that matches a specific class.

addProvider(Class<?>, SuggestionProvider<A>) - Method in class revxrsal.commands.autocomplete.SuggestionProviders.Builder

Registers a SuggestionProvider that matches a specific class.

addProviderFactory(SuggestionProvider.Factory<? super A>) - Method in class revxrsal.commands.autocomplete.SuggestionProviders.Builder

Registers a SuggestionProvider.Factory to this registry.

addProviderFactoryLast(SuggestionProvider.Factory<? super A>) - Method in class revxrsal.commands.autocomplete.SuggestionProviders.Builder

Registers a SuggestionProvider.Factory to this registry.

addProviderForAnnotation(Class<L>, Function<L, SuggestionProvider<A>>) - Method in class revxrsal.commands.autocomplete.SuggestionProviders.Builder

Registers a SuggestionProvider that matches all parameters with a specific annotation.

addProviderForAnnotationLast(Class<L>, Function<L, SuggestionProvider<A>>) - Method in class revxrsal.commands.autocomplete.SuggestionProviders.Builder

Registers a SuggestionProvider that matches all parameters with a specific annotation.

addProviderLast(Class<?>, SuggestionProvider<A>) - Method in class revxrsal.commands.autocomplete.SuggestionProviders.Builder

Registers a SuggestionProvider that matches a specific class.

addResolvedArgument(String, Object) - Method in interface revxrsal.commands.node.MutableExecutionContext

Adds the given parameter name to this context

all() - Method in interface revxrsal.commands.help.Help.CommandList

Returns all the commands that belong to this list.

allowSubclasses() - Method in class revxrsal.commands.parameter.builtins.ClassContextParameterFactory

allowSubclasses() - Method in class revxrsal.commands.parameter.builtins.ClassParameterTypeFactory

allowSubclasses() - Method in class revxrsal.commands.response.ClassResponseHandlerFactory

alwaysTrue() - Static method in interface revxrsal.commands.command.CommandPermission

Returns a CommandPermission that always returns true for all actors.

AnnotationList - Interface in revxrsal.commands.annotation.list

Represents an immutable collection of annotations.

AnnotationReplacer<T extends java.lang.annotation.Annotation> - Interface in revxrsal.commands.annotation.dynamic

An interface that allows creating annotations that will get replaced by others.

annotationReplacer(Class<T>, AnnotationReplacer<T>) - Method in class revxrsal.commands.Lamp.Builder

Registers an AnnotationReplacer for a specified annotation type

annotationReplacers() - Method in class revxrsal.commands.Lamp

Returns an immutable map of the annotation replacers registered in this Lamp instance

Annotations - Class in revxrsal.commands.annotation.dynamic

A utility for constructing annotations dynamically.

Annotations() - Constructor for class revxrsal.commands.annotation.dynamic.Annotations

annotations() - Method in interface revxrsal.commands.command.CommandFunction

Returns the annotations on the function

annotations() - Method in interface revxrsal.commands.command.CommandParameter

Returns the list of annotations present on this parameter.

annotations() - Method in interface revxrsal.commands.command.ExecutableCommand

Returns the annotations on the function

annotations() - Method in interface revxrsal.commands.node.ParameterNode

Returns the annotations present on this ParameterNode.

Annotations.CannotBeCreated - Annotation Type in revxrsal.commands.annotation.dynamic

An annotation that implies that the annotated type cannot be dynamically created using Annotations.create(Class)

any(Predicate<Annotation>) - Method in interface revxrsal.commands.annotation.list.AnnotationList

Tests whether any of the annotations in this list match the given predicate

any(Predicate<ExecutableCommand<A>>) - Method in interface revxrsal.commands.node.CommandRegistry

Tests whether any of the registered commands matches the given predicate

any(Predicate<ExecutableCommand<A>>) - Method in class revxrsal.commands.node.parser.BaseCommandRegistry

any(Iterable<T>, Predicate<T>) - Static method in class revxrsal.commands.util.Collections

arrayComponentType(Type) - Static method in class revxrsal.commands.util.Classes

Returns the array type of the given type.

ArrayParameterTypeFactory - Class in revxrsal.commands.parameter.builtins

ArrayParameterTypeFactory() - Constructor for class revxrsal.commands.parameter.builtins.ArrayParameterTypeFactory

AsyncSuggestionProvider<A extends CommandActor> - Interface in revxrsal.commands.autocomplete

An interface that supplies completions asynchronously for the user depending on their input.

AutoCompleter<A extends CommandActor> - Interface in revxrsal.commands.autocomplete

Represents an auto-completer that provides suggestions for the user input.

autoCompleter() - Method in class revxrsal.commands.Lamp

Returns the AutoCompleter of this Lamp instance

B

BaseCommandRegistry<A extends CommandActor> - Class in revxrsal.commands.node.parser

BaseCommandRegistry(Lamp<A>, List<ExecutableCommand<A>>) - Constructor for class revxrsal.commands.node.parser.BaseCommandRegistry

BaseCommandRegistry(Lamp<A>) - Constructor for class revxrsal.commands.node.parser.BaseCommandRegistry

BaseParameterType - Interface in revxrsal.commands.parameter

A common interface for ParameterType and ParameterType.Factory.

BaseSuggestionProvider - Interface in revxrsal.commands.autocomplete

Represents a common interface for SuggestionProvider and SuggestionProvider.Factory.

bindTo(Object) - Method in interface revxrsal.commands.reflect.MethodCaller

Binds this caller to the specified instance.

BooleanParameterType - Class in revxrsal.commands.parameter.primitives

A basic ParameterType for parsing boolean types

BooleanParameterType() - Constructor for class revxrsal.commands.parameter.primitives.BooleanParameterType

build() - Method in class revxrsal.commands.autocomplete.SuggestionProviders.Builder

Creates a new SuggestionProviders instance of this builder

build() - Method in class revxrsal.commands.hook.Hooks.Builder

Creates a new Hooks registry from this builder

build() - Method in class revxrsal.commands.Lamp.Builder

Constructs a Lamp from this Lamp.Builder.

build() - Method in class revxrsal.commands.node.DispatcherSettings.Builder

Creates a new DispatcherSettings based on this builder

build() - Method in class revxrsal.commands.parameter.ParameterTypes.Builder

Creates a new ParameterTypes instance of this builder

build() - Method in class revxrsal.commands.parameter.PrioritySpec.Builder

Builds a PrioritySpec out of this builder

build() - Method in class revxrsal.commands.util.StackTraceSanitizer.Builder

Constructs the StackTraceSanitizer from the configuration

builder() - Static method in class revxrsal.commands.autocomplete.SuggestionProviders

Creates a new SuggestionProviders.Builder for SuggestionProviders.

Builder() - Constructor for class revxrsal.commands.autocomplete.SuggestionProviders.Builder

builder() - Static method in class revxrsal.commands.hook.Hooks

Creates a new hooks Hooks.Builder

Builder() - Constructor for class revxrsal.commands.hook.Hooks.Builder

builder() - Static method in class revxrsal.commands.Lamp

Creates a new Lamp Lamp.Builder

Builder() - Constructor for class revxrsal.commands.Lamp.Builder

builder() - Static method in class revxrsal.commands.node.DispatcherSettings

Creates a new DispatcherSettings.Builder for constructing DispatcherSettings

Builder() - Constructor for class revxrsal.commands.node.DispatcherSettings.Builder

builder() - Static method in class revxrsal.commands.parameter.ParameterTypes

Creates a new ParameterTypes.Builder for ParameterTypes.

Builder() - Constructor for class revxrsal.commands.parameter.ParameterTypes.Builder

builder() - Static method in class revxrsal.commands.parameter.PrioritySpec

Creates a new PrioritySpec.Builder

Builder() - Constructor for class revxrsal.commands.parameter.PrioritySpec.Builder

Builder(Comparator<ParameterType<?, ?>>) - Constructor for class revxrsal.commands.parameter.PrioritySpec.Builder

builder() - Static method in class revxrsal.commands.util.StackTraceSanitizer

Returns a new StackTraceSanitizer.Builder

Builder() - Constructor for class revxrsal.commands.util.StackTraceSanitizer.Builder

BuiltInNamingStrategies - Class in revxrsal.commands.util

Re-adapted from Gson's FieldNamingPolicy, licensed under Apache 2.0

BuiltInNamingStrategies() - Constructor for class revxrsal.commands.util.BuiltInNamingStrategies

ByteParameterType - Class in revxrsal.commands.parameter.primitives

A basic ParameterType for parsing byte types

ByteParameterType() - Constructor for class revxrsal.commands.parameter.primitives.ByteParameterType

C

call(Object...) - Method in interface revxrsal.commands.command.CommandFunction

Calls the function with the given arguments

call(Object, List<Object>, Function<Parameter, Boolean>) - Method in interface revxrsal.commands.reflect.ktx.KotlinFunction

Calls the function with the given arguments.

call(Object...) - Method in interface revxrsal.commands.reflect.MethodCaller.BoundMethodCaller

Calls the method of this caller

call(Object, Object...) - Method in interface revxrsal.commands.reflect.MethodCaller

Calls the method of this caller

CallableMethod - Class in revxrsal.commands.reflect.ktx

A utility class that combines a Method with a MethodCaller.

CallableMethod(Method, MethodCaller) - Constructor for class revxrsal.commands.reflect.ktx.CallableMethod

callByIndices(Object, Map<Integer, Object>, Function<Parameter, Boolean>) - Method in interface revxrsal.commands.reflect.ktx.KotlinFunction

Calls the function with the given arguments, mapped by the index of each parameter.

callByNames(Object, Map<String, Object>, Function<Parameter, Boolean>) - Method in interface revxrsal.commands.reflect.ktx.KotlinFunction

Calls the function with the given arguments, mapped by the name of each parameter.

callByParameters(Object, Map<Parameter, Object>, Function<Parameter, Boolean>) - Method in interface revxrsal.commands.reflect.ktx.KotlinFunction

Calls the function with the given arguments, mapped by the Parameter object representing each parameter.

caller() - Method in interface revxrsal.commands.command.CommandFunction

Returns a wrapper that allows to easily invoke the method with its parameters directly.

caller() - Method in class revxrsal.commands.reflect.ktx.CallableMethod

cancel() - Method in interface revxrsal.commands.hook.CancelHandle

Cancels the handle

CancelHandle - Interface in revxrsal.commands.hook

A parameter passed to hooks to cancel the hooked event

cannotInstantiate(Class<?>) - Static method in class revxrsal.commands.util.Preconditions

Throws an exception that the user cannot instantiate the given class

canRead(int) - Method in interface revxrsal.commands.stream.StringStream

Tests whether the stream can read the given characters count

cause() - Method in exception revxrsal.commands.exception.CommandInvocationException

cause() - Method in exception revxrsal.commands.exception.InputParseException

Returns the cause of the exception

CharParameterType - Class in revxrsal.commands.parameter.primitives

A basic ParameterType for parsing char types

CharParameterType() - Constructor for class revxrsal.commands.parameter.primitives.CharParameterType

CharPredicate - Interface in revxrsal.commands.stream

A predicate on a character.

checkRetention(Class<? extends Annotation>) - Static method in class revxrsal.commands.util.Classes

Checks whether the given annotation type has Retention of RetentionPolicy.RUNTIME.

childrenCommands(A) - Method in interface revxrsal.commands.command.ExecutableCommand

Returns all children commands of this command.

childrenCommands() - Method in interface revxrsal.commands.command.ExecutableCommand

Returns all children commands of this command.

ClassContextParameterFactory<A extends CommandActor,T> - Class in revxrsal.commands.parameter.builtins

ClassContextParameterFactory(Class<?>, ContextParameter<A, T>, boolean) - Constructor for class revxrsal.commands.parameter.builtins.ClassContextParameterFactory

Classes - Class in revxrsal.commands.util

A utility class for dealing with wrapping and unwrapping of primitive types

ClassParameterTypeFactory<A extends CommandActor,T> - Class in revxrsal.commands.parameter.builtins

ClassParameterTypeFactory(Class<?>, ParameterType<A, T>, boolean) - Constructor for class revxrsal.commands.parameter.builtins.ClassParameterTypeFactory

ClassResponseHandlerFactory<A extends CommandActor,T> - Class in revxrsal.commands.response

ClassResponseHandlerFactory(Class<?>, ResponseHandler<A, T>, boolean) - Constructor for class revxrsal.commands.response.ClassResponseHandlerFactory

clearResolvedArguments() - Method in interface revxrsal.commands.node.MutableExecutionContext

Clears all the resolved arguments.

Collections - Class in revxrsal.commands.util

Provides utilities for dealing with collections and iterators.

Command - Annotation Type in revxrsal.commands.annotation

The main entrypoint to a command, which specifies the parent of any command.

command() - Method in exception revxrsal.commands.exception.MissingArgumentException

command() - Method in interface revxrsal.commands.node.CommandNode

Returns the ExecutableCommand that this node belongs to

command() - Method in interface revxrsal.commands.node.ExecutionContext

Returns the command being executed

CommandAction<A extends CommandActor> - Interface in revxrsal.commands.node

Represents an action that gets executed by a CommandNode.

CommandActor - Interface in revxrsal.commands.command

Represents a command sender, responsible for performing a command-related action.

CommandActorSenderResolver - Enum in revxrsal.commands.parameter

commandCondition(CommandCondition<? super A>) - Method in class revxrsal.commands.Lamp.Builder

Registers a CommandCondition that is invoked before a command is finally executed

CommandCondition<A extends CommandActor> - Interface in revxrsal.commands.process

Represents a condition that must be met in order for the command invocation to continue.

commandConditions() - Method in class revxrsal.commands.Lamp

Returns an immutable list of the command conditions registered in this Lamp instance

CommandErrorException - Exception in revxrsal.commands.exception

Represents a command error, for example when an invalid value is returned, a condition is violated, or an illegal value is inputted, and validated through a parameter validator.

CommandErrorException() - Constructor for exception revxrsal.commands.exception.CommandErrorException

Constructs a new CommandErrorException that does not send any message.

CommandErrorException(String, Object...) - Constructor for exception revxrsal.commands.exception.CommandErrorException

Constructs a new CommandErrorException with an inferred actor

CommandExceptionHandler<A extends CommandActor> - Interface in revxrsal.commands.exception

A handler for all exceptions that may be thrown during the command invocation.

CommandExecutedHook<A extends CommandActor> - Interface in revxrsal.commands.hook

A hook that gets called when a command is executed

CommandFunction - Interface in revxrsal.commands.command

Represents a function that contains an executable command.

CommandInvocationException - Exception in revxrsal.commands.exception

Thrown when an exception is thrown by invoking the command's method.

CommandInvocationException(Throwable) - Constructor for exception revxrsal.commands.exception.CommandInvocationException

CommandNode<A extends CommandActor> - Interface in revxrsal.commands.node

Represents a node in a command tree.

CommandParameter - Interface in revxrsal.commands.command

Represents a parameter in a command.

CommandPaths - Class in revxrsal.commands.util

CommandPermission<A extends CommandActor> - Interface in revxrsal.commands.command

Represents a permission that is required in order to execute a command.

CommandPermission.Factory<A extends CommandActor> - Interface in revxrsal.commands.command

Represents a convenient way to register custom CommandPermission implementations.

CommandPlaceholder - Annotation Type in revxrsal.commands.annotation

An annotation that takes the place of a @Command of a OrphanCommand.

CommandPriority - Annotation Type in revxrsal.commands.annotation

Defines an explicit priority for a certain method over other methods that similarly define a priority in the same class.

commandPriority() - Method in interface revxrsal.commands.command.ExecutableCommand

Returns the explicit priority defined by CommandPriority.

CommandPriority.Low - Annotation Type in revxrsal.commands.annotation

Represents a command with a low priority.

CommandRegisteredHook<A extends CommandActor> - Interface in revxrsal.commands.hook

A hook that gets called when a command is registered

CommandRegistry<A extends CommandActor> - Interface in revxrsal.commands.node

Represents a registry of commands maintained by a Lamp instance.

commands() - Method in exception revxrsal.commands.exception.InvalidHelpPageException

Returns all the commands that belong to this list.

commands() - Method in interface revxrsal.commands.node.CommandRegistry

Gets an unmodifiable view of all the commands registered in this registry.

commands() - Method in class revxrsal.commands.node.parser.BaseCommandRegistry

CommandUnregisteredHook<A extends CommandActor> - Interface in revxrsal.commands.hook

A hook that gets called when a command is unregistered

comparator() - Method in class revxrsal.commands.parameter.PrioritySpec

complete(A, String) - Method in interface revxrsal.commands.autocomplete.AutoCompleter

Returns a list of suggestions for the given input and actor.

complete(A, StringStream) - Method in interface revxrsal.commands.autocomplete.AutoCompleter

Returns a list of suggestions for the given input and actor.

complete(A, StringStream, ExecutionContext<A>) - Method in interface revxrsal.commands.node.ParameterNode

Provides suggestions for the given user input.

CompletionStageResponseHandler - Enum in revxrsal.commands.response

A ResponseHandler.Factory that creates ResponseHandlers for {@code CompletionStage} where T is any type that has a registered response handler.

consumeRemaining() - Method in interface revxrsal.commands.stream.MutableStringStream

Consumes the rest of the stream

consumeRemaining() - Method in class revxrsal.commands.stream.MutableStringStreamImpl

consumesInput() - Method in class revxrsal.commands.parameter.ParameterResolver

Tests whether this actually consumes input or not.

contains(Class<T>) - Method in interface revxrsal.commands.annotation.list.AnnotationList

Tests whether this list contains the given annotation or not

containsFlags() - Method in interface revxrsal.commands.command.ExecutableCommand

Tests whether the command has any Flag or Switch parameters

context() - Method in interface revxrsal.commands.command.Potential

Returns the ExecutionContext generated from the execution attempt, as well as any values parsed from the input.

context() - Method in interface revxrsal.commands.exception.context.ErrorContext

Returns the ExecutionContext in this context.

context() - Method in interface revxrsal.commands.exception.context.ErrorContext.ExecutingFunction

context() - Method in interface revxrsal.commands.exception.context.ErrorContext.ParsingLiteral

context() - Method in interface revxrsal.commands.exception.context.ErrorContext.ParsingParameter

context() - Method in interface revxrsal.commands.exception.context.ErrorContext.UnknownCommand

context() - Method in interface revxrsal.commands.exception.context.ErrorContext.UnknownParameter

ContextParameter<A extends CommandActor,T> - Interface in revxrsal.commands.parameter

Represents a parameter that is resolved from the context of the command.

contextParameter(ContextParameter<A, T>) - Static method in class revxrsal.commands.parameter.ParameterResolver

ContextParameter.Factory<A extends CommandActor> - Interface in revxrsal.commands.parameter

Represents a factory that constructs ContextParameters dynamically

continuation() - Static method in class revxrsal.commands.reflect.ktx.KotlinConstants

Returns the continuation class

convert(List<Object>, Type) - Method in class revxrsal.commands.parameter.builtins.ArrayParameterTypeFactory

convert(List<Object>, Type) - Method in class revxrsal.commands.parameter.builtins.ListParameterTypeFactory

convert(List<Object>, Type) - Method in class revxrsal.commands.parameter.builtins.SetParameterTypeFactory

copyList(Collection<T>) - Static method in class revxrsal.commands.util.Collections

copyMap(Map<K, V>) - Static method in class revxrsal.commands.util.Collections

create(Class<T>) - Static method in class revxrsal.commands.annotation.dynamic.Annotations

Creates a new annotation with no values.

create(Class<T>, Map<String, Object>) - Static method in class revxrsal.commands.annotation.dynamic.Annotations

Creates a new annotation with the given map values.

create(Class<T>, Object...) - Static method in class revxrsal.commands.annotation.dynamic.Annotations

Creates a new annotation with the given map values.

create(AnnotatedElement) - Static method in interface revxrsal.commands.annotation.list.AnnotationList

Creates a new AnnotationList for the given AnnotatedElement.

create(Collection<Annotation>) - Static method in interface revxrsal.commands.annotation.list.AnnotationList

Creates a new AnnotationList for the given collection of annotations.

create(Map<Class<? extends Annotation>, Annotation>) - Static method in interface revxrsal.commands.annotation.list.AnnotationList

Creates a new AnnotationList for the given map of annotations.

create(Lamp<A>) - Static method in interface revxrsal.commands.autocomplete.AutoCompleter

Creates an AutoCompleter for the given Lamp instance.

create(Type, AnnotationList, Lamp<A>) - Method in interface revxrsal.commands.autocomplete.SuggestionProvider.Factory

Creates a SuggestionProvider for the given parameter.

create(AnnotationList, Lamp<A>) - Method in interface revxrsal.commands.command.CommandPermission.Factory

Creates a new CommandPermission for the given list of annotations.

create(ExecutableCommand<A>, A, StringStream) - Static method in interface revxrsal.commands.node.ExecutionContext

Creates a new MutableExecutionContext for the given command, actor and input.

create(Type, AnnotationList, Lamp<A>) - Method in class revxrsal.commands.parameter.builtins.ClassContextParameterFactory

create(Type, AnnotationList, Lamp<A>) - Method in class revxrsal.commands.parameter.builtins.ClassParameterTypeFactory

create(Type, AnnotationList, Lamp<CommandActor>) - Method in enum revxrsal.commands.parameter.builtins.EnumParameterTypeFactory

create(Type, AnnotationList, Lamp<CommandActor>) - Method in enum revxrsal.commands.parameter.builtins.OptionalParameterTypeFactory

create(Type, AnnotationList, Lamp<CommandActor>) - Method in enum revxrsal.commands.parameter.builtins.ParseWithParameterTypeFactory

create(Type, AnnotationList, Lamp<A>) - Method in interface revxrsal.commands.parameter.ContextParameter.Factory

Dynamically creates a ContextParameter

create(Type, AnnotationList, Lamp<A>) - Method in interface revxrsal.commands.parameter.ParameterType.Factory

Dynamically creates a ParameterType

create(Type, AnnotationList, Lamp<A>) - Method in class revxrsal.commands.response.ClassResponseHandlerFactory

create(Type, AnnotationList, Lamp<CommandActor>) - Method in enum revxrsal.commands.response.CompletionStageResponseHandler

create(Type, AnnotationList, Lamp<CommandActor>) - Method in enum revxrsal.commands.response.OptionalResponseHandler

create(Type, AnnotationList, Lamp<A>) - Method in interface revxrsal.commands.response.ResponseHandler.Factory

Creates a new CommandPermission for the given type and list of annotations.

create(Type, AnnotationList, Lamp<CommandActor>) - Method in enum revxrsal.commands.response.SupplierResponseHandler

create(String, int) - Static method in interface revxrsal.commands.stream.StringStream

Returns an immutable StringStream with the given source and cursor position

create(String) - Static method in interface revxrsal.commands.stream.StringStream

Returns an immutable StringStream with the given source, starting at the beginning of the string.

create(Class<? extends T>) - Static method in class revxrsal.commands.util.InstanceCreator

createFor(Method) - Method in interface revxrsal.commands.reflect.MethodCallerFactory

Creates a new MethodCaller for the specified method.

createMutable(ExecutableCommand<A>, A, StringStream) - Static method in interface revxrsal.commands.node.ExecutionContext

Creates a new MutableExecutionContext for the given command, actor and input.

createMutable(String, int) - Static method in interface revxrsal.commands.stream.StringStream

Returns a mutable MutableStringStream with the given source and cursor position

createMutable(String) - Static method in interface revxrsal.commands.stream.StringStream

Returns a mutable MutableStringStream with the given source, starting at the beginning of the string.

createPermission(AnnotationList) - Method in class revxrsal.commands.Lamp

Creates a new CommandPermission for the given list of annotations.

D

Default - Annotation Type in revxrsal.commands.annotation

Adds a default value for a parameter when it is not supplied.

DEFAULT_MAXIMUM_FAILED_ATTEMPTS - Static variable in class revxrsal.commands.node.DispatcherSettings

The default number of failed attempts after which Lamp will stop testing out commands (for efficiency) and invoke the FailureHandler.

defaultErrorSender(MessageSender<? super A, String>) - Method in class revxrsal.commands.Lamp.Builder

Registers the default message sender used by CommandActor.error(String)

DefaultExceptionHandler<A extends CommandActor> - Class in revxrsal.commands.exception

DefaultExceptionHandler() - Constructor for class revxrsal.commands.exception.DefaultExceptionHandler

defaultFactory() - Static method in interface revxrsal.commands.reflect.MethodCallerFactory

Returns the default MethodCallerFactory, which uses the method handles API to create method callers, and KotlinFunction to call Kotlin methods.

DefaultFunctionFinder - Class in revxrsal.commands.reflect.ktx

A utility for finding the default synthetic function generated by the Kotlin compiler.

defaultMessageSender(MessageSender<? super A, String>) - Method in class revxrsal.commands.Lamp.Builder

Registers the default message sender used by CommandActor.reply(String)

defaultPrimitiveValue(Class<?>) - Static method in class revxrsal.commands.reflect.ktx.KotlinConstants

Returns the 'zero'-like value for a primitive type.

defaultPriority() - Static method in class revxrsal.commands.parameter.PrioritySpec

The default PrioritySpec, which treats all types with equal priority.

defaultSanitizer() - Static method in class revxrsal.commands.util.StackTraceSanitizer

Returns the default sanitizer

defaultSuggestions() - Method in interface revxrsal.commands.parameter.ParameterType

Returns the default suggestions.

defaultSuggestions() - Method in class revxrsal.commands.parameter.primitives.BooleanParameterType

Delimiter - Annotation Type in revxrsal.commands.annotation

An annotation that marks that collection-based annotation, such as List, Set, or a T[] array type, should be parsed by splitting the input based on the given Delimiter.value() in this annotation.

Dependency - Annotation Type in revxrsal.commands.annotation

An annotation for fields and parameters used to inject dependencies into command classes.

dependency(Class<T>, T) - Method in class revxrsal.commands.Lamp.Builder

Registers the given dependency as an object

dependency(Class<T>, Supplier<T>) - Method in class revxrsal.commands.Lamp.Builder

Registers the given dependency as a supplier that will provide the values as needed

dependency(Class<T>) - Method in class revxrsal.commands.Lamp

Returns the dependency that corresponds to the given type, otherwise throws an IllegalStateException

Description - Annotation Type in revxrsal.commands.annotation

An annotation to give the ExecutableCommand a description.

description() - Method in interface revxrsal.commands.command.ExecutableCommand

Returns the description of this command.

description() - Method in interface revxrsal.commands.node.HasDescription

Returns the description.

dispatch(A, String) - Method in class revxrsal.commands.Lamp

Executes the given input on the behalf of the specified actor.

dispatch(A, StringStream) - Method in class revxrsal.commands.Lamp

Executes the given input on the behalf of the specified actor.

dispatcherSettings(Consumer<DispatcherSettings.Builder<A>>) - Method in class revxrsal.commands.Lamp.Builder

Performs the given consumer on the Lamp.Builder.dispatcherSettings() builder.

dispatcherSettings() - Method in class revxrsal.commands.Lamp.Builder

Returns the DispatcherSettings builder

dispatcherSettings(DispatcherSettings<A>) - Method in class revxrsal.commands.Lamp.Builder

Sets the DispatcherSettings that is used by this Lamp instance

dispatcherSettings() - Method in class revxrsal.commands.Lamp

Returns the DispatcherSettings that are used by Lamp under the hood to customize the dispatcher settings.

DispatcherSettings<A extends CommandActor> - Class in revxrsal.commands.node

Contains the settings for Lamp's underlying dispatcher.

DispatcherSettings.Builder<A extends CommandActor> - Class in revxrsal.commands.node

Builder class for DispatcherSettings

DistributeOnMethods - Annotation Type in revxrsal.commands.annotation

Marks an annotation as distributable on methods.

DoubleParameterType - Class in revxrsal.commands.parameter.primitives

A basic ParameterType for parsing double types

DoubleParameterType() - Constructor for class revxrsal.commands.parameter.primitives.DoubleParameterType

E

elementsPerPage() - Method in exception revxrsal.commands.exception.InvalidHelpPageException

Returns the elements to include in each page

empty() - Static method in interface revxrsal.commands.annotation.list.AnnotationList

Returns an empty AnnotationList.

empty() - Static method in interface revxrsal.commands.autocomplete.SuggestionProvider

Returns a SuggestionProvider that always gives empty suggestions.

end() - Method in class revxrsal.commands.util.Strings.StringRange

EnumNotFoundException - Exception in revxrsal.commands.exception

Thrown when an invalid value is specified for an Enum parameter.

EnumNotFoundException(String) - Constructor for exception revxrsal.commands.exception.EnumNotFoundException

EnumParameterTypeFactory - Enum in revxrsal.commands.parameter.builtins

equals(Object) - Method in class revxrsal.commands.orphan.OrphanRegistry

equals(Object) - Method in class revxrsal.commands.orphan.Orphans

equals(Object) - Method in class revxrsal.commands.parameter.builtins.ClassContextParameterFactory

equals(Object) - Method in class revxrsal.commands.parameter.builtins.ClassParameterTypeFactory

equals(Object) - Method in class revxrsal.commands.parameter.builtins.SenderContextParameter

equals(Object) - Method in class revxrsal.commands.parameter.PrioritySpec

equals(Object) - Method in class revxrsal.commands.reflect.ktx.CallableMethod

equals(Object) - Method in class revxrsal.commands.response.ClassResponseHandlerFactory

equals(Object) - Method in class revxrsal.commands.stream.token.LiteralToken

equals(Object) - Method in class revxrsal.commands.stream.token.ParameterToken

equals(Object) - Method in class revxrsal.commands.util.Strings.StringRange

error(String) - Method in interface revxrsal.commands.command.CommandActor

Replies to the sender with the specified message, and marks it as an error depending on the platform.

error() - Method in interface revxrsal.commands.command.Potential

Returns the error generated from the execution attempt.

errorContext() - Method in interface revxrsal.commands.command.Potential

Returns the context in which the error has occurred.

ErrorContext<A extends CommandActor> - Interface in revxrsal.commands.exception.context

Represents the context in which the error has occurred.

ErrorContext.ExecutingFunction<A extends CommandActor> - Interface in revxrsal.commands.exception.context

Represents the context for an error that occurred during executing a command function

ErrorContext.ParsingLiteral<A extends CommandActor> - Interface in revxrsal.commands.exception.context

Represents the context for an error that occurred during parsing a literal node

ErrorContext.ParsingParameter<A extends CommandActor> - Interface in revxrsal.commands.exception.context

Represents the context for an error that occurred during parsing a parameter node

ErrorContext.UnknownCommand<A extends CommandActor> - Interface in revxrsal.commands.exception.context

Represents the context for an error due to an unknown command.

ErrorContext.UnknownParameter<A extends CommandActor> - Interface in revxrsal.commands.exception.context

Represents the context for an error due to an unknown parameter.

errorSender() - Method in class revxrsal.commands.Lamp

Returns the MessageSender responsible for sending messages using CommandActor.error(String)

exceptionHandler(CommandExceptionHandler<A>) - Method in class revxrsal.commands.Lamp.Builder

Sets the registered exception handler that handles all exceptions passed to this builder.

ExecutableCommand<A extends CommandActor> - Interface in revxrsal.commands.command

Represents an immutable, full, separate command path that may be executed.

execute(A, MutableStringStream) - Method in interface revxrsal.commands.command.ExecutableCommand

Executes this command with the given actor and input.

execute(ExecutionContext<A>) - Method in interface revxrsal.commands.command.ExecutableCommand

Executes this command with the given context.

execute() - Method in interface revxrsal.commands.command.Potential

Executes the command.

execute(ExecutionContext<A>) - Method in interface revxrsal.commands.node.CommandAction

Executes the given command, possibly throwing exceptions in cases of errors.

execute(ExecutionContext<A>, MutableStringStream) - Method in interface revxrsal.commands.node.CommandNode

Executes the CommandNode.action() of this node with the given context and input.

execute(A, String) - Method in interface revxrsal.commands.node.CommandRegistry

Executes the given input on the behalf of the actor.

execute(A, StringStream) - Method in interface revxrsal.commands.node.CommandRegistry

Executes the given input on the behalf of the actor.

execute(A, ExecutableCommand<A>, MutableStringStream) - Method in interface revxrsal.commands.node.CommandRegistry

Executes the given command on the behalf of the actor.

execute(A, ExecutableCommand<A>, MutableStringStream) - Method in class revxrsal.commands.node.parser.BaseCommandRegistry

execute(A, StringStream) - Method in class revxrsal.commands.node.parser.BaseCommandRegistry

execute(ExecutionContext<A>) - Method in class revxrsal.commands.node.parser.ReflectionAction

executingFunction(ExecutionContext<A>) - Static method in interface revxrsal.commands.exception.context.ErrorContext

Creates an ErrorContext.ExecutingFunction error context

ExecutionContext<A extends CommandActor> - Interface in revxrsal.commands.node

Represents the context of the execution of the command.

ExpectedLiteralException - Exception in revxrsal.commands.exception

Thrown when a certain literal LiteralNode was expected, but found a different literal.

ExpectedLiteralException(String, LiteralNode<CommandActor>) - Constructor for exception revxrsal.commands.exception.ExpectedLiteralException

extend(String) - Method in class revxrsal.commands.stream.MutableStringStreamImpl

F

failed() - Method in interface revxrsal.commands.command.Potential

Tests whether the execution failed or not

failureHandler(FailureHandler<? super A>) - Method in class revxrsal.commands.node.DispatcherSettings.Builder

Sets the failure handler that will consume the failed potentials.

failureHandler() - Method in class revxrsal.commands.node.DispatcherSettings

The failure handler that will consume the failed potentials.

FailureHandler<A extends CommandActor> - Interface in revxrsal.commands.node

A functional interface that handles all failed Potentials that failed to parse the given input.

filter(Predicate<ExecutableCommand<A>>) - Method in interface revxrsal.commands.node.CommandRegistry

Returns a new list of all commands that match the given predicate

filter(Predicate<ExecutableCommand<A>>) - Method in class revxrsal.commands.node.parser.BaseCommandRegistry

filter(Iterable<T>, Predicate<T>) - Static method in class revxrsal.commands.util.Collections

findCompanion(Class<?>) - Static method in class revxrsal.commands.reflect.ktx.KotlinSingletons

Attempts to find the companion singleton in the given class.

findDefaultFunction(Method) - Static method in class revxrsal.commands.reflect.ktx.DefaultFunctionFinder

findNextProvider(Type, AnnotationList, SuggestionProvider.Factory<? super A>, Lamp<A>) - Method in class revxrsal.commands.autocomplete.SuggestionProviders

Returns the first SuggestionProvider that comes after the skipPast factory.

findNextResolver(Type, AnnotationList, ParameterFactory) - Method in class revxrsal.commands.Lamp

Returns the first ParameterType that comes after the skipPast factory.

findNextResolver(Type, AnnotationList, ParameterFactory, Lamp<A>) - Method in class revxrsal.commands.parameter.ParameterTypes

Returns the first ParameterType that comes after the skipPast factory.

findNextSuggestionProvider(Type, AnnotationList, SuggestionProvider.Factory<? super A>, Lamp<A>) - Method in class revxrsal.commands.Lamp

Returns the first SuggestionProvider that comes after the skipPast factory.

first(Iterable<T>, Predicate<T>) - Static method in class revxrsal.commands.util.Collections

firstNode() - Method in interface revxrsal.commands.command.ExecutableCommand

Returns the first node in this command.

Flag - Annotation Type in revxrsal.commands.annotation

An annotation to mark a parameter as a flag.

flagName() - Method in interface revxrsal.commands.node.ParameterNode

Gets the flag name defined in Flag.value().

FloatParameterType - Class in revxrsal.commands.parameter.primitives

A basic ParameterType for parsing float types

FloatParameterType() - Constructor for class revxrsal.commands.parameter.primitives.FloatParameterType

fmt(Number) - Static method in class revxrsal.commands.exception.RuntimeExceptionAdapter

forAnnotation(Class<L>, Function<L, SuggestionProvider<A>>) - Static method in interface revxrsal.commands.autocomplete.SuggestionProvider.Factory

Returns a SuggestionProvider.Factory that returns a suggestion provider for all parameters that contain a specific annotation

forAnnotation(Class<T>, Function<T, CommandPermission<A>>) - Static method in interface revxrsal.commands.command.CommandPermission.Factory

Creates a CommandPermission.Factory that creates a CommandPermission for every function or parameter that contains a certain

forType(Class<?>, SuggestionProvider<A>) - Static method in interface revxrsal.commands.autocomplete.SuggestionProvider.Factory

Returns a SuggestionProvider.Factory that returns a suggestion provider for all parameters that match a certain type.

forType(Class<T>, ContextParameter<A, T>) - Static method in interface revxrsal.commands.parameter.ContextParameter.Factory

Creates a new ContextParameter.Factory that returns a ContextParameter for all parameters that exactly have a certain class.

forType(Class<T>, ParameterType<A, T>) - Static method in interface revxrsal.commands.parameter.ParameterType.Factory

Creates a new ParameterType.Factory that returns a ParameterType for all parameters that exactly have a certain class.

forType(Class<T>, ResponseHandler<A, T>) - Static method in interface revxrsal.commands.response.ResponseHandler.Factory

Creates a new ParameterType.Factory that returns a ParameterType for all parameters that exactly have a certain class.

forTypeAndSubclasses(Class<?>, SuggestionProvider<A>) - Static method in interface revxrsal.commands.autocomplete.SuggestionProvider.Factory

Returns a SuggestionProvider.Factory that returns a suggestion provider for all parameters that match a certain type, as well as its subclasses.

forTypeAndSubclasses(Class<T>, ContextParameter<A, T>) - Static method in interface revxrsal.commands.parameter.ContextParameter.Factory

Creates a new ContextParameter.Factory that returns a ContextParameter for all parameters that are assignable from the given type.

forTypeAndSubclasses(Class<T>, ParameterType<A, T>) - Static method in interface revxrsal.commands.parameter.ParameterType.Factory

Creates a new ParameterType.Factory that returns a ParameterType for all parameters that are assignable from the given type.

forTypeAndSubclasses(Class<T>, ResponseHandler<A, T>) - Static method in interface revxrsal.commands.response.ResponseHandler.Factory

Creates a new ParameterType.Factory that returns a ParameterType for all parameters that are assignable from the given type.

from(SuggestionProvider<A>) - Static method in interface revxrsal.commands.autocomplete.AsyncSuggestionProvider

Creates a AsyncSuggestionProvider from the given SuggestionProvider

fromAsync(AsyncSuggestionProvider<A>) - Static method in interface revxrsal.commands.autocomplete.SuggestionProvider

Creates a SuggestionProvider that provides suggestions asynchronously.

fullType() - Method in interface revxrsal.commands.command.CommandParameter

Returns the full type of the parameter, including generics.

fullType() - Method in interface revxrsal.commands.node.ParameterNode

Returns the parameter Java type

function() - Method in interface revxrsal.commands.command.ExecutableCommand

Returns the underlying CommandFunction of this command

G

generics() - Method in interface revxrsal.commands.command.CommandParameter

Returns a list of generic types associated with this parameter.

get(Class<T>) - Method in interface revxrsal.commands.annotation.list.AnnotationList

Returns the given annotation, or null if it's not annotated with the given annotation (or distributed on, indirectly)

getAllMethods(Class<?>) - Static method in class revxrsal.commands.util.Reflections

Finds all Methods defined by a class, including private ones and ones that are inherited from classes.

getAllMethods(Class<?>, boolean) - Static method in class revxrsal.commands.util.Reflections

Finds all Methods defined by a class, including private ones and ones that are inherited from classes.

getAnnotation(Class<T>) - Method in interface revxrsal.commands.command.CommandFunction

Returns the annotation on the function

getAnnotation(Class<T>) - Method in interface revxrsal.commands.command.CommandParameter

Returns the given annotation, or null if it's not annotated with the given annotation (or distributed on, indirectly)

getCallerForNonDefault(Method) - Static method in class revxrsal.commands.reflect.ktx.KotlinSingletons

Generates a MethodCaller for the given method, assuming that it is not the synthetic default function generated by the Kotlin compiler.

getCause() - Method in exception revxrsal.commands.exception.CommandInvocationException

getDefaultSyntheticMethod() - Method in interface revxrsal.commands.reflect.ktx.KotlinFunction

Returns the synthetic method generated by the Kotlin compiler for invoking a function with the default values.

getElementType(Type) - Method in class revxrsal.commands.parameter.builtins.ArrayParameterTypeFactory

getElementType(Type) - Method in class revxrsal.commands.parameter.builtins.ListParameterTypeFactory

getElementType(Type) - Method in class revxrsal.commands.parameter.builtins.SetParameterTypeFactory

getFirstGeneric(Class<?>, Type) - Static method in class revxrsal.commands.util.Classes

Deprecated.

Classes do not have generics. You might have passed the wrong parameters.

getFirstGeneric(Type, Type) - Static method in class revxrsal.commands.util.Classes

Returns the first generic type of the given (possibly parameterized) type genericType.

getMaxValue(Class<?>) - Static method in class revxrsal.commands.util.Numbers

getMethod() - Method in interface revxrsal.commands.reflect.ktx.KotlinFunction

Returns the method that this function wraps

getMinValue(Class<?>) - Static method in class revxrsal.commands.util.Numbers

getName(Parameter) - Method in interface revxrsal.commands.node.ParameterNamingStrategy

Returns the parameter name.

getOrNull(T[], int) - Static method in class revxrsal.commands.util.Collections

Returns an element at the given [index] or `null` if the [index] is out of bounds of this array.

getOrNull(List<T>, int) - Static method in class revxrsal.commands.util.Collections

Returns an element at the given [index] or `null` if the [index] is out of bounds of this array.

getOverriddenName(AnnotationList) - Static method in class revxrsal.commands.util.Strings

getParameter(String) - Method in interface revxrsal.commands.reflect.ktx.KotlinFunction

Returns the parameter by the given name, otherwise throws an IllegalArgumentException

getParameter(int) - Method in interface revxrsal.commands.reflect.ktx.KotlinFunction

Returns the parameter by the given index, otherwise throws an IndexOutOfBoundsException

getParameters() - Method in interface revxrsal.commands.reflect.ktx.KotlinFunction

Returns the real function parameters, as declared in the Kotlin source.

getParametersByName() - Method in interface revxrsal.commands.reflect.ktx.KotlinFunction

Returns the real function parameters and their names, as declared in the Kotlin source.

getRawType(Type) - Static method in class revxrsal.commands.util.Classes

Returns the Class object representing the class or interface that declared this type.

getResolvedArgument(String) - Method in interface revxrsal.commands.node.ExecutionContext

Returns the first argument that matches the given type, or throws an IllegalArgumentException if not found.

getResolvedArgument(Class<T>) - Method in interface revxrsal.commands.node.ExecutionContext

Returns the first argument that matches the given type, or throws an IllegalArgumentException if not found.

getResolvedArgumentOrNull(String) - Method in interface revxrsal.commands.node.ExecutionContext

Returns the argument that has been resolved with the given name

getResolvedArgumentOrNull(Class<T>) - Method in interface revxrsal.commands.node.ExecutionContext

Returns the first argument that matches the given type

getSender(Class<?>, CommandActor, ExecutableCommand<CommandActor>) - Method in enum revxrsal.commands.parameter.CommandActorSenderResolver

getSender(Class<?>, A, ExecutableCommand<A>) - Method in interface revxrsal.commands.process.SenderResolver

Returns the custom sender value from the given context

getSnowflake(String) - Static method in class revxrsal.commands.util.Strings

getSuggestions(ExecutionContext<A>) - Method in interface revxrsal.commands.autocomplete.SuggestionProvider

Returns the suggestions

getSuggestionsAsync(ExecutionContext<A>) - Method in interface revxrsal.commands.autocomplete.AsyncSuggestionProvider

Returns the suggestions

getTopClasses(Class<?>) - Static method in class revxrsal.commands.util.Reflections

Returns a hierarchy of classes that are contained by the given class.

getType(Object) - Static method in class revxrsal.commands.util.Classes

Returns the type of the given object

greedy() - Static method in class revxrsal.commands.parameter.StringParameterType

H

handle(ErrorContext<A>) - Method in interface revxrsal.commands.exception.SelfHandledException

Handles the exception.

handleException() - Method in interface revxrsal.commands.command.Potential

Handles the exception that caused the attempt to fail.

handleException(Throwable, ErrorContext<A>) - Method in interface revxrsal.commands.exception.CommandExceptionHandler

Handles the given exception.

handleException(Throwable, ErrorContext<A>) - Method in class revxrsal.commands.exception.RuntimeExceptionAdapter

handleException(Throwable, ErrorContext<A>) - Method in class revxrsal.commands.Lamp

Handles the given exception in the given context.

handleFailedAttempts(A, List<Potential<A>>, StringStream) - Method in interface revxrsal.commands.node.FailureHandler

Handles all the given failed attempts

handler() - Method in class revxrsal.commands.orphan.OrphanRegistry

handler(OrphanCommand) - Method in class revxrsal.commands.orphan.Orphans

Sets the handler of this orphan command.

handleResponse(T, ExecutionContext<A>) - Method in interface revxrsal.commands.response.ResponseHandler

Handles the response returned from the method

hasAction() - Method in interface revxrsal.commands.node.CommandNode

Tests whether this node has an CommandNode.action().

hasAnnotation(Class<? extends Annotation>) - Method in interface revxrsal.commands.command.CommandFunction

Tests whether the function has the specified annotation

hasAnnotation(Class<? extends Annotation>) - Method in interface revxrsal.commands.command.CommandParameter

Tests whether this parameter has the given annotation or not

HasDescription - Interface in revxrsal.commands.node

Represents a component that has a description property.

hasExecutionContext() - Method in interface revxrsal.commands.exception.context.ErrorContext

Tests whether this context has a ExecutionContext or not.

hasFinished() - Method in interface revxrsal.commands.stream.StringStream

Tests whether this stream has finished parsing or not

hashCode() - Method in class revxrsal.commands.orphan.OrphanRegistry

hashCode() - Method in class revxrsal.commands.orphan.Orphans

hashCode() - Method in class revxrsal.commands.parameter.builtins.ClassContextParameterFactory

hashCode() - Method in class revxrsal.commands.parameter.builtins.ClassParameterTypeFactory

hashCode() - Method in class revxrsal.commands.parameter.builtins.SenderContextParameter

hashCode() - Method in class revxrsal.commands.parameter.PrioritySpec

hashCode() - Method in class revxrsal.commands.reflect.ktx.CallableMethod

hashCode() - Method in class revxrsal.commands.response.ClassResponseHandlerFactory

hashCode() - Method in class revxrsal.commands.stream.token.LiteralToken

hashCode() - Method in class revxrsal.commands.stream.token.ParameterToken

hashCode() - Method in class revxrsal.commands.util.Strings.StringRange

hasRemaining() - Method in interface revxrsal.commands.stream.StringStream

Tests whether there are any characters left in the string stream

Help - Interface in revxrsal.commands.help

Contains useful interfaces for generating help commands

Help.ChildrenCommands<A extends CommandActor> - Interface in revxrsal.commands.help

Contains all children commands of a certain ExecutableCommand.

Help.CommandList<A extends CommandActor> - Interface in revxrsal.commands.help

Represents a generic list of ExecutableCommands that can be split into pages

Help.RelatedCommands<A extends CommandActor> - Interface in revxrsal.commands.help

Contains all children and sibling commands of a certain ExecutableCommand.

Help.SiblingCommands<A extends CommandActor> - Interface in revxrsal.commands.help

Contains all sibling commands of a certain ExecutableCommand.

higherThan(Class<? extends ParameterType<?, ?>>) - Method in class revxrsal.commands.parameter.PrioritySpec.Builder

Declares this parameter to have higher priority over the specified parameter type

highest() - Static method in class revxrsal.commands.parameter.PrioritySpec

Represents a PrioritySpec that will always come first.

Hook - Interface in revxrsal.commands.hook

Represents a hook.

Hooks<A extends CommandActor> - Class in revxrsal.commands.hook

An immutable registry of Hooks, which are listeners that allow to execute code at certain points of the command flow.

hooks() - Method in class revxrsal.commands.Lamp.Builder

Returns the Hooks builder

hooks(Consumer<Hooks.Builder<A>>) - Method in class revxrsal.commands.Lamp.Builder

Performs the given consumer on the Lamp.Builder.hooks() builder.

hooks() - Method in class revxrsal.commands.Lamp

Returns the hooks registry

Hooks.Builder<A extends CommandActor> - Class in revxrsal.commands.hook

A builder for Hooks

I

identity() - Static method in interface revxrsal.commands.node.ParameterNamingStrategy

Preserves the default parameter name.

ignoreClasses(Class<?>...) - Method in class revxrsal.commands.util.StackTraceSanitizer.Builder

Strips all the given classes from the trace

ignoreMethod(String) - Method in class revxrsal.commands.util.StackTraceSanitizer.Builder

Strips all traces that point to the given method name

ignoreNativeMethods() - Method in class revxrsal.commands.util.StackTraceSanitizer.Builder

Strips all native methods.

ignorePackage(String) - Method in class revxrsal.commands.util.StackTraceSanitizer.Builder

Strips all classes that belong to the given package name

ignorePackage(Package) - Method in class revxrsal.commands.util.StackTraceSanitizer.Builder

Strips all classes that belong to the given package

input() - Method in exception revxrsal.commands.exception.InvalidStringSizeException

Returns the actual size of the input list.

input() - Method in exception revxrsal.commands.exception.InvalidValueException

The invalid inputted value for the number

input() - Method in exception revxrsal.commands.exception.NumberNotInRangeException

The inputted value

input() - Method in interface revxrsal.commands.node.ExecutionContext

Returns the underlying StringStream of this context.

InputParseException - Exception in revxrsal.commands.exception

Thrown when a MutableStringStream fails to parse the user input.

InputParseException(InputParseException.Cause) - Constructor for exception revxrsal.commands.exception.InputParseException

InputParseException.Cause - Enum in revxrsal.commands.exception

inputSize() - Method in exception revxrsal.commands.exception.InvalidListSizeException

Returns the actual size of the input list.

insertAtBeginning(T[], T) - Static method in class revxrsal.commands.util.Collections

Creates a grown copy of the given array, with the given element inserted at the beginning.

INSTANCE - Static variable in class revxrsal.commands.parameter.builtins.ArrayParameterTypeFactory

INSTANCE - Static variable in class revxrsal.commands.parameter.builtins.ListParameterTypeFactory

INSTANCE - Static variable in class revxrsal.commands.parameter.builtins.SetParameterTypeFactory

InstanceCreator - Class in revxrsal.commands.util

A utility that tries multiple ways of obtaining an instance of a certain type.

IntParameterType - Class in revxrsal.commands.parameter.primitives

A basic ParameterType for parsing int types

IntParameterType() - Constructor for class revxrsal.commands.parameter.primitives.IntParameterType

InvalidBooleanException - Exception in revxrsal.commands.exception

Thrown when an invalid value is inputted for a boolean parameter

InvalidBooleanException(String) - Constructor for exception revxrsal.commands.exception.InvalidBooleanException

InvalidDecimalException - Exception in revxrsal.commands.exception

Thrown when an invalid value is supplied for a decimal-like (double, float) parameter.

InvalidDecimalException(String) - Constructor for exception revxrsal.commands.exception.InvalidDecimalException

InvalidHelpPageException - Exception in revxrsal.commands.exception

Thrown when an invalid page is passed to Help.CommandList.paginate(int, int)

InvalidHelpPageException(List<ExecutableCommand<A>>, int, int, int) - Constructor for exception revxrsal.commands.exception.InvalidHelpPageException

InvalidIntegerException - Exception in revxrsal.commands.exception

Thrown when an invalid value is supplied for an integer-like (short, long, int) parameter.

InvalidIntegerException(String) - Constructor for exception revxrsal.commands.exception.InvalidIntegerException

InvalidListSizeException - Exception in revxrsal.commands.exception

Exception thrown when a collection-like type does not meet the specified size constraints set by @Sized.

InvalidListSizeException(int, int, int, List<Object>) - Constructor for exception revxrsal.commands.exception.InvalidListSizeException

InvalidNumberException - Exception in revxrsal.commands.exception

Thrown when an invalid value is supplied for a number-like parameter.

InvalidNumberException(String) - Constructor for exception revxrsal.commands.exception.InvalidNumberException

InvalidStringSizeException - Exception in revxrsal.commands.exception

Exception thrown when a collection-like type does not meet the specified size constraints set by @Sized.

InvalidStringSizeException(int, int, String) - Constructor for exception revxrsal.commands.exception.InvalidStringSizeException

InvalidUUIDException - Exception in revxrsal.commands.exception

Thrown when an invalid value is supplied for a UUID parameter.

InvalidUUIDException(String) - Constructor for exception revxrsal.commands.exception.InvalidUUIDException

InvalidValueException - Exception in revxrsal.commands.exception

Thrown when an unacceptable value for a certain parameter is inputted, for example, an invalid number for a number parameter, or an invalid UUID for a UUID parameter.

InvalidValueException(String) - Constructor for exception revxrsal.commands.exception.InvalidValueException

isChildOf(ExecutableCommand<A>) - Method in interface revxrsal.commands.command.ExecutableCommand

Tests whether this command is a child of the provided command.

isClassPresent(String) - Static method in class revxrsal.commands.util.Classes

Tests whether the given class is available or not

isContextParameter() - Method in class revxrsal.commands.parameter.ParameterResolver

isDecimal(Class<?>) - Static method in class revxrsal.commands.util.Numbers

isEmpty() - Method in interface revxrsal.commands.annotation.list.AnnotationList

Tests whether this list is empty or not

isEmpty() - Method in interface revxrsal.commands.stream.StringStream

Tests whether is this stream empty or not.

isExecutableBy(A) - Method in interface revxrsal.commands.command.CommandPermission

Returns whether the sender has permission to use this command or not.

isExecutingFunction() - Method in interface revxrsal.commands.exception.context.ErrorContext

Tests whether the error occurred during executing a function

isFlag() - Method in interface revxrsal.commands.node.ParameterNode

Tests whether this parameter is a flag

isGreedy() - Method in interface revxrsal.commands.node.ParameterNode

Tests whether is this parameter greedy or not

isGreedy() - Method in interface revxrsal.commands.parameter.ParameterType

Returns whether this parameter is greedy or not.

isGreedy() - Method in class revxrsal.commands.parameter.StringParameterType

isKotlinClass(Class<?>) - Static method in class revxrsal.commands.reflect.ktx.KotlinConstants

Tests whether is the given class a Kotlin-generated class

isLast() - Method in interface revxrsal.commands.node.CommandNode

Tests whether is this node the last one in the command tree it belongs to

isLastInMethod() - Method in interface revxrsal.commands.command.CommandParameter

Tests whether is this parameter the last in the method or not

isLiteral() - Method in interface revxrsal.commands.node.CommandNode

Tests whether this node is a LiteralNode

isLiteral() - Method in interface revxrsal.commands.node.LiteralNode

Tests whether this node is a LiteralNode.

isLiteral() - Method in interface revxrsal.commands.node.ParameterNode

Tests whether this node is a LiteralNode.

isMutable() - Method in class revxrsal.commands.stream.MutableStringStreamImpl

Tests whether is this stream mutable or not

isMutable() - Method in interface revxrsal.commands.stream.StringStream

Tests whether is this stream mutable or not

isOptional() - Method in interface revxrsal.commands.command.CommandParameter

Tests whether is this parameter optional or not.

isOptional() - Method in interface revxrsal.commands.node.ParameterNode

Tests whether is this parameter optional or not.

isParameter() - Method in interface revxrsal.commands.node.CommandNode

Tests whether this node is a ParameterNode

isParameter() - Method in interface revxrsal.commands.node.LiteralNode

Tests whether this node is a ParameterNode.

isParameter() - Method in interface revxrsal.commands.node.ParameterNode

Tests whether this node is a ParameterNode.

isParameterType() - Method in class revxrsal.commands.parameter.ParameterResolver

isParentOf(ExecutableCommand<A>) - Method in interface revxrsal.commands.command.ExecutableCommand

Tests whether the provided command is a child of this command.

isParsingLiteral() - Method in interface revxrsal.commands.exception.context.ErrorContext

Tests whether the error occurred during parsing a literal

isParsingParameter() - Method in interface revxrsal.commands.exception.context.ErrorContext

Tests whether the error occurred during parsing a parameter

isRelatedTo(ExecutableCommand<A>) - Method in interface revxrsal.commands.command.ExecutableCommand

Tests whether is the provided command related to this command or not.

isRequired() - Method in interface revxrsal.commands.node.ParameterNode

Tests whether is this parameter required or not.

isSecret() - Method in interface revxrsal.commands.command.ExecutableCommand

Tests whether this command is secret or not.

isSenderType(CommandParameter) - Method in enum revxrsal.commands.parameter.CommandActorSenderResolver

isSenderType(CommandParameter) - Method in interface revxrsal.commands.process.SenderResolver

Tests whether is the specified type a custom sender type or not

isSiblingOf(ExecutableCommand<A>) - Method in interface revxrsal.commands.command.ExecutableCommand

Tests whether are these two commands siblings.

isStaticFinal(int) - Static method in class revxrsal.commands.reflect.ktx.KotlinConstants

Tests whether the given element has static final modifiers.

isSuspend() - Method in interface revxrsal.commands.reflect.ktx.KotlinFunction

Tests whether is this function suspend or not

isSwitch() - Method in interface revxrsal.commands.node.ParameterNode

Tests whether this parameter is a switch

isVisibleTo(A) - Method in interface revxrsal.commands.command.ExecutableCommand

Tests whether this command is visible to the actor or not.

isWrapperType(Class<?>) - Static method in class revxrsal.commands.util.Classes

Returns true if the specified type is one of the nine primitive-wrapper types, such as Integer.

items() - Method in exception revxrsal.commands.exception.InvalidListSizeException

Returns the list of items that caused this exception to be thrown.

iterator() - Method in interface revxrsal.commands.annotation.list.AnnotationList

Returns an unmodifiable Iterator for this annotation list

iterator() - Method in interface revxrsal.commands.node.CommandRegistry

Returns an immutable iterator of all entries in this registry.

iterator() - Method in class revxrsal.commands.node.parser.BaseCommandRegistry

K

KotlinConstants - Class in revxrsal.commands.reflect.ktx

A utility that abstracts away certain Kotlin constant values and classes

KotlinFeatureRegistry - Enum in revxrsal.commands.ktx

Registries for Kotlin features.

KotlinFunction - Interface in revxrsal.commands.reflect.ktx

A simple wrapper around a function declared in Kotlin.

kotlinFunctions() - Static method in interface revxrsal.commands.reflect.MethodCallerFactory

Returns a MethodCallerFactory that allows invocation of Kotlin functions with their default values.

KotlinSingletons - Class in revxrsal.commands.reflect.ktx

A utility for finding the singleton inside a class

L

lamp() - Method in interface revxrsal.commands.command.CommandActor

Returns the Lamp instance that constructed this actor.

lamp() - Method in interface revxrsal.commands.command.CommandFunction

Returns the Lamp instance that created this function.

lamp() - Method in interface revxrsal.commands.command.ExecutableCommand

Returns the Lamp instance that created this command

lamp() - Method in interface revxrsal.commands.exception.context.ErrorContext

Returns the Lamp instance

Lamp<A extends CommandActor> - Class in revxrsal.commands

The main entrypoint to command registration.

Lamp(Lamp.Builder<A>) - Constructor for class revxrsal.commands.Lamp

lamp() - Method in interface revxrsal.commands.node.CommandNode

Returns the Lamp instance that constructed this node

lamp() - Method in interface revxrsal.commands.node.CommandRegistry

Returns the underlying Lamp instance of this registry.

lamp() - Method in interface revxrsal.commands.node.ExecutionContext

Returns the Lamp instance that is executing this command

lamp() - Method in class revxrsal.commands.node.parser.BaseCommandRegistry

Lamp.Builder<A extends CommandActor> - Class in revxrsal.commands

LampBuilderVisitor<A extends CommandActor> - Interface in revxrsal.commands

Represents a visitor for a Lamp.Builder object.

LampVisitor<A extends CommandActor> - Interface in revxrsal.commands

Represents a visitor for a Lamp object.

lastNode() - Method in interface revxrsal.commands.command.ExecutableCommand

Returns the very last node in this command.

Lazy - Class in revxrsal.commands.util

Re-adapted from Guava's Suppliers class, to use the MemoizingSupplier (renamed to LazySupplier)

Length - Annotation Type in revxrsal.commands.annotation

An annotation that requires String parameters to have size in the range of Length.min() and Length.max() (both inclusive)

LengthChecker - Enum in revxrsal.commands.parameter

A parameter validator that checks for the @Length annotation.

ListParameterTypeFactory - Class in revxrsal.commands.parameter.builtins

literal() - Method in interface revxrsal.commands.exception.context.ErrorContext.ParsingLiteral

LiteralNode<A extends CommandActor> - Interface in revxrsal.commands.node

Represents a literal node, i.e.

LiteralToken - Class in revxrsal.commands.stream.token

LiteralToken(String) - Constructor for class revxrsal.commands.stream.token.LiteralToken

LONG_FORMAT_PREFIX - Static variable in class revxrsal.commands.node.DispatcherSettings

The default long format for flags and switches

LongParameterType - Class in revxrsal.commands.parameter.primitives

A basic ParameterType for parsing long types

LongParameterType() - Constructor for class revxrsal.commands.parameter.primitives.LongParameterType

lowerCaseWithSeparator(String) - Static method in interface revxrsal.commands.node.ParameterNamingStrategy

Converts the parameter name from lower-camel case to lower case, separated by a custom separator.

lowerCaseWithSpace() - Static method in interface revxrsal.commands.node.ParameterNamingStrategy

Converts the parameter name from lower-camel case to lower case, separated by a space.

lowerThan(Class<? extends ParameterType<?, ?>>) - Method in class revxrsal.commands.parameter.PrioritySpec.Builder

Declares this parameter to have lower priority than the specified parameter type

lowest() - Static method in class revxrsal.commands.parameter.PrioritySpec

Represents a PrioritySpec that will always come last.

M

map(Class<T>, Function<T, R>) - Method in interface revxrsal.commands.annotation.list.AnnotationList

Performs a map function on the annotation if it is present, otherwise returns null if the annotation is not present.

map(Iterable<U>, Function<U, T>) - Static method in class revxrsal.commands.util.Collections

mapKeys(Map<K, V>, Function<K, L>) - Static method in class revxrsal.commands.util.Collections

Applies a mapping function to a given map's keys, and returns a new map that contains the mapped keys to their values

mapOr(Class<T>, Function<T, R>, R) - Method in interface revxrsal.commands.annotation.list.AnnotationList

Performs a map function on the annotation if it is present, otherwise returns defaultValue if the annotation is not present.

mapOrGet(Class<T>, Function<T, R>, Supplier<R>) - Method in interface revxrsal.commands.annotation.list.AnnotationList

Performs a map function on the annotation if it is present, otherwise supplies the value in defaultValue if the annotation is not present.

mapToLinkedList(Iterable<U>, Function<U, T>) - Static method in class revxrsal.commands.util.Collections

matchType(Type, Class<?>) - Method in class revxrsal.commands.parameter.builtins.ArrayParameterTypeFactory

matchType(Type, Class<?>) - Method in class revxrsal.commands.parameter.builtins.ListParameterTypeFactory

matchType(Type, Class<?>) - Method in class revxrsal.commands.parameter.builtins.SetParameterTypeFactory

maximum() - Method in exception revxrsal.commands.exception.InvalidListSizeException

Returns the maximum allowed size of the list.

maximum() - Method in exception revxrsal.commands.exception.InvalidStringSizeException

Returns the maximum allowed size of the list.

maximum() - Method in exception revxrsal.commands.exception.NumberNotInRangeException

The maximum value of the range

maximumFailedAttempts(int) - Method in class revxrsal.commands.node.DispatcherSettings.Builder

Sets the number of failed attempts after which Lamp will stop testing out commands (for efficiency) and invoke the DispatcherSettings.failureHandler().

maximumFailedAttempts() - Method in class revxrsal.commands.node.DispatcherSettings

The number of failed attempts after which Lamp will stop testing out commands (for efficiency) and invoke the DispatcherSettings.failureHandler().

messageSender() - Method in class revxrsal.commands.Lamp

Returns the MessageSender responsible for sending messages using CommandActor.reply(String)

MessageSender<A extends CommandActor,T> - Interface in revxrsal.commands.process

An interface that determines how messages are sent to the given actor.

method() - Method in interface revxrsal.commands.command.CommandFunction

Returns the underlying Method of this function

method() - Method in interface revxrsal.commands.command.CommandParameter

Returns the method associated with this parameter.

method() - Method in class revxrsal.commands.reflect.ktx.CallableMethod

MethodCaller - Interface in revxrsal.commands.reflect

A high-level wrapper, responsible for invoking methods reflectively.

MethodCaller.BoundMethodCaller - Interface in revxrsal.commands.reflect

Represents a MethodCaller that is attached to an instance

MethodCallerFactory - Interface in revxrsal.commands.reflect

Factory for creating MethodCallers for methods.

methodHandles() - Static method in interface revxrsal.commands.reflect.MethodCallerFactory

Returns a MethodCallerFactory that uses the new method handles API to create method callers.

methodIndex() - Method in interface revxrsal.commands.command.CommandParameter

Returns the index of this parameter in the method.

minimum() - Method in exception revxrsal.commands.exception.InvalidListSizeException

Returns the minimum allowed size of the list.

minimum() - Method in exception revxrsal.commands.exception.InvalidStringSizeException

Returns the minimum allowed size of the list.

minimum() - Method in exception revxrsal.commands.exception.NumberNotInRangeException

The minimum value of the range

MissingArgumentException - Exception in revxrsal.commands.exception

Thrown when a parameter is missing (not specified) inside a command

MissingArgumentException(ParameterNode<A, ?>, ExecutableCommand<A>) - Constructor for exception revxrsal.commands.exception.MissingArgumentException

moveBackward() - Method in interface revxrsal.commands.stream.MutableStringStream

Moves the cursor 1 step backward

moveBackward(int) - Method in interface revxrsal.commands.stream.MutableStringStream

Moves the cursor by the given steps backward

moveBackward() - Method in class revxrsal.commands.stream.MutableStringStreamImpl

moveBackward(int) - Method in class revxrsal.commands.stream.MutableStringStreamImpl

moveForward() - Method in interface revxrsal.commands.stream.MutableStringStream

Moves the cursor 1 step forward

moveForward(int) - Method in interface revxrsal.commands.stream.MutableStringStream

Moves the cursor by the given steps forward

moveForward() - Method in class revxrsal.commands.stream.MutableStringStreamImpl

moveForward(int) - Method in class revxrsal.commands.stream.MutableStringStreamImpl

MutableExecutionContext<A extends CommandActor> - Interface in revxrsal.commands.node

Represents the context of the execution of the command.

MutableStringStream - Interface in revxrsal.commands.stream

An interface that aids in parsing a stream of characters.

MutableStringStreamImpl - Class in revxrsal.commands.stream

N

name() - Method in interface revxrsal.commands.command.CommandActor

Returns the name of this actor.

name() - Method in interface revxrsal.commands.command.CommandFunction

Returns the function name

name() - Method in interface revxrsal.commands.command.CommandParameter

Returns the name of the parameter.

name() - Method in exception revxrsal.commands.exception.UnknownParameterException

name() - Method in interface revxrsal.commands.node.CommandNode

Returns the name of this node.

name() - Method in class revxrsal.commands.stream.token.ParameterToken

Named - Annotation Type in revxrsal.commands.annotation

An annotation used to override the names of command parameters.

node() - Method in exception revxrsal.commands.exception.ExpectedLiteralException

Returns the literal node that we were trying to match with

node() - Method in exception revxrsal.commands.exception.MissingArgumentException

nodes() - Method in interface revxrsal.commands.command.ExecutableCommand

Returns an immutable List containing all the nodes in this command.

none() - Static method in class revxrsal.commands.util.StackTraceSanitizer

Returns the empty sanitizer

noOp() - Static method in interface revxrsal.commands.response.ResponseHandler

Returns a basic ResponseHandler that does nothing.

NoPermissionException - Exception in revxrsal.commands.exception

Thrown when a CommandActor lacks the required permission to execute the given command or category.

NoPermissionException(RequiresPermission<?>) - Constructor for exception revxrsal.commands.exception.NoPermissionException

notEmpty(T[], String) - Static method in class revxrsal.commands.util.Preconditions

Ensures that the given array is not empty

nothing() - Static method in interface revxrsal.commands.LampBuilderVisitor

Returns a LampBuilderVisitor that does nothing

nothing() - Static method in interface revxrsal.commands.LampVisitor

Returns a LampVisitor that does nothing

notNull(T, String) - Static method in class revxrsal.commands.util.Preconditions

Checks that the specified object reference is not null.

NotSender - Annotation Type in revxrsal.commands.annotation

Marks a parameter that comes at the very beginning of a command method that it should not be evaluated as a sender, and should be treated as if it were a standard command parameter,

NotSender.ImpliesNotSender - Annotation Type in revxrsal.commands.annotation

A marker annotation that is added to other annotations whose presence implies that the parameter they are annotating is definitely not a sender parameter, for example a ParseWith.

NumberNotInRangeException - Exception in revxrsal.commands.exception

Thrown when a numerical parameter that is annotated with Range gets a value outside its allowed range.

NumberNotInRangeException(Number, double, double) - Constructor for exception revxrsal.commands.exception.NumberNotInRangeException

numberOfPages() - Method in exception revxrsal.commands.exception.InvalidHelpPageException

Returns the number of pages this list would generate if it were to be split pages where each page contains InvalidHelpPageException.elementsPerPage() elements.

numberOfPages(int) - Method in interface revxrsal.commands.help.Help.CommandList

Returns the number of pages this list would generate if it were to be split pages where each page contains elementsPerPage elements.

numberOfPages(int, int) - Static method in interface revxrsal.commands.help.Help

Returns the number of pages this list would generate if it were to be split pages where each page contains elementsPerPage elements.

Numbers - Class in revxrsal.commands.util

O

of(String...) - Static method in interface revxrsal.commands.autocomplete.SuggestionProvider

Returns a SuggestionProvider that provides a static list of suggestions

of(List<String>) - Static method in interface revxrsal.commands.autocomplete.SuggestionProvider

Returns a SuggestionProvider that provides a static list of suggestions

of(Supplier<T>) - Static method in class revxrsal.commands.util.Lazy

Creates a Supplier that fetches the value upon request at first, then serves it in subsequent calls.

onCommandExecuted(CommandExecutedHook<? super A>) - Method in class revxrsal.commands.hook.Hooks.Builder

Adds a hook that runs before a command is executed

onCommandExecuted(ExecutableCommand<A>, ExecutionContext<A>) - Method in class revxrsal.commands.hook.Hooks

Calls all execution hooks.

onCommandInvocation(CommandInvocationException, A) - Method in class revxrsal.commands.exception.DefaultExceptionHandler

onCommandRegistered(CommandRegisteredHook<? super A>) - Method in class revxrsal.commands.hook.Hooks.Builder

Adds a hook that runs after a command is registered

onCommandRegistered(ExecutableCommand<A>) - Method in class revxrsal.commands.hook.Hooks

Calls all registration hooks.

onCommandUnregistered(CommandUnregisteredHook<? super A>) - Method in class revxrsal.commands.hook.Hooks.Builder

Adds a hook that runs after a command is unregistered

onCommandUnregistered(ExecutableCommand<A>) - Method in class revxrsal.commands.hook.Hooks

Calls all un-registration hooks.

onEnumNotFound(EnumNotFoundException, A) - Method in class revxrsal.commands.exception.DefaultExceptionHandler

onExecuted(ExecutableCommand<A>, ExecutionContext<A>, CancelHandle) - Method in interface revxrsal.commands.hook.CommandExecutedHook

Invokes the hook for a command whose action is about to be executed

onExpectedLiteral(ExpectedLiteralException, A) - Method in class revxrsal.commands.exception.DefaultExceptionHandler

onInputParse(InputParseException, A) - Method in class revxrsal.commands.exception.DefaultExceptionHandler

onInvalidBoolean(InvalidBooleanException, A) - Method in class revxrsal.commands.exception.DefaultExceptionHandler

onInvalidDecimal(InvalidDecimalException, A) - Method in class revxrsal.commands.exception.DefaultExceptionHandler

onInvalidHelpPage(InvalidHelpPageException, A) - Method in class revxrsal.commands.exception.DefaultExceptionHandler

onInvalidInteger(InvalidIntegerException, A) - Method in class revxrsal.commands.exception.DefaultExceptionHandler

onInvalidListSize(InvalidListSizeException, A, ParameterNode<A, ?>) - Method in class revxrsal.commands.exception.DefaultExceptionHandler

onInvalidStringSize(InvalidStringSizeException, A, ParameterNode<A, ?>) - Method in class revxrsal.commands.exception.DefaultExceptionHandler

onInvalidUUID(InvalidUUIDException, A) - Method in class revxrsal.commands.exception.DefaultExceptionHandler

onMissingArgument(MissingArgumentException, A, ParameterNode<A, ?>) - Method in class revxrsal.commands.exception.DefaultExceptionHandler

onNoPermission(NoPermissionException, A) - Method in class revxrsal.commands.exception.DefaultExceptionHandler

onNumberNotInRange(NumberNotInRangeException, A, ParameterNode<A, Number>) - Method in class revxrsal.commands.exception.DefaultExceptionHandler

onRegistered(ExecutableCommand<A>, CancelHandle) - Method in interface revxrsal.commands.hook.CommandRegisteredHook

Invokes the hook for a command that is about to be registered

onSendable(SendableException, A) - Method in class revxrsal.commands.exception.DefaultExceptionHandler

onUnknownCommand(UnknownCommandException, A) - Method in class revxrsal.commands.exception.DefaultExceptionHandler

onUnknownParameter(UnknownParameterException, A) - Method in class revxrsal.commands.exception.DefaultExceptionHandler

onUnregistered(ExecutableCommand<A>, CancelHandle) - Method in interface revxrsal.commands.hook.CommandUnregisteredHook

Invokes the hook for a command that is about to be unregistered

Optional - Annotation Type in revxrsal.commands.annotation

Marks a parameter as optional and does not need to be explicitly specified by the sender.

optionalParameters() - Method in interface revxrsal.commands.command.ExecutableCommand

Returns the number of optional parameters in this command

OptionalParameterTypeFactory - Enum in revxrsal.commands.parameter.builtins

Handles parameters of type Optional and is effectively the same as using @Optional on such annotations

OptionalResponseHandler - Enum in revxrsal.commands.response

A ResponseHandler.Factory that creates ResponseHandlers for {@code Optional} where T is any type that has a registered response handler.

OrphanCommand - Interface in revxrsal.commands.orphan

Represents a command that has no parent known at compile-time.

OrphanRegistry - Class in revxrsal.commands.orphan

Represents an orphan command that has finally found its parent path.

OrphanRegistry(List<String>, OrphanCommand) - Constructor for class revxrsal.commands.orphan.OrphanRegistry

Orphans - Class in revxrsal.commands.orphan

Represents the entrypoint to creation of OrphanCommands.

Orphans(List<String>) - Constructor for class revxrsal.commands.orphan.Orphans

P

page() - Method in exception revxrsal.commands.exception.InvalidHelpPageException

Returns the page number

paginate(int, int) - Method in interface revxrsal.commands.help.Help.CommandList

Returns the list of commands that belong to a specific page after paginating this list.

paginate(List<ExecutableCommand<A>>, int, int) - Static method in interface revxrsal.commands.help.Help

Returns the list of commands that belong to a specific page after paginating this list.

parameter(String) - Method in interface revxrsal.commands.command.CommandFunction

Returns the CommandParameter that has a given name, otherwise throws an error.

parameter() - Method in interface revxrsal.commands.command.CommandParameter

Returns the underlying Parameter

parameter(String) - Method in interface revxrsal.commands.command.ExecutableCommand

Returns the parameter with the given name, or throws IllegalArgumentException if it does not exist.

parameter() - Method in interface revxrsal.commands.exception.context.ErrorContext.ParsingParameter

parameter() - Method in interface revxrsal.commands.node.ParameterNode

Returns the underlying CommandParameter of this parameter node

ParameterFactory - Interface in revxrsal.commands.parameter

A common interface between ContextParameter.Factory and ParameterType.Factory

parameterNamingStrategy(ParameterNamingStrategy) - Method in class revxrsal.commands.Lamp.Builder

Sets the parameter naming strategy

parameterNamingStrategy() - Method in class revxrsal.commands.Lamp

Returns the parameter naming strategy for this Lamp instance

ParameterNamingStrategy - Interface in revxrsal.commands.node

An interface that allows customizing the way parameters are named

ParameterNode<A extends CommandActor,T> - Interface in revxrsal.commands.node

Represents a parameter node.

parameterOrNull(String) - Method in interface revxrsal.commands.command.ExecutableCommand

Returns the parameter with the given name, or null if it does not exist.

ParameterResolver<A extends CommandActor,T> - Class in revxrsal.commands.parameter

A utility class for simplifying the differences between a ParameterType and a ContextParameter, without having to deal with unnecessary casting or generics

parameters() - Method in interface revxrsal.commands.command.ExecutableCommand

Returns all the parameters in this command, in the same order they are declared in the command.

parametersByName() - Method in interface revxrsal.commands.command.CommandFunction

Returns an unmodifiable map of the parameters this function contains.

ParameterToken - Class in revxrsal.commands.stream.token

ParameterToken(String) - Constructor for class revxrsal.commands.stream.token.ParameterToken

parameterType() - Method in interface revxrsal.commands.node.ParameterNode

Returns the ParameterType of this parameter that will be used to parse the input.

parameterType() - Method in class revxrsal.commands.parameter.builtins.ClassContextParameterFactory

parameterType() - Method in class revxrsal.commands.parameter.builtins.ClassParameterTypeFactory

parameterType(ParameterType<A, T>) - Static method in class revxrsal.commands.parameter.ParameterResolver

ParameterType<A extends CommandActor,T> - Interface in revxrsal.commands.parameter

Represents a parameter type that produces values from the user input MutableStringStream.

ParameterType.Factory<A extends CommandActor> - Interface in revxrsal.commands.parameter

Represents a factory that constructs ParameterTypes dynamically

parameterTypes() - Method in class revxrsal.commands.Lamp.Builder

Returns the ParameterTypes builder

parameterTypes(Consumer<ParameterTypes.Builder<A>>) - Method in class revxrsal.commands.Lamp.Builder

Performs the given consumer on the Lamp.Builder.parameterTypes() builder.

parameterTypes() - Method in class revxrsal.commands.Lamp

Returns the parameter type registry

ParameterTypes<A extends CommandActor> - Class in revxrsal.commands.parameter

An immutable registry of ParameterTypes and ParameterType.Factories.

ParameterTypes.Builder<A extends CommandActor> - Class in revxrsal.commands.parameter

parameterValidator(Class<T>, ParameterValidator<? super A, T>) - Method in class revxrsal.commands.Lamp.Builder

Registers a ParameterValidator which validates certain types of parameters that get resolved by ParameterTypes

ParameterValidator<A extends CommandActor,T> - Interface in revxrsal.commands.process

A validator for a specific parameter type.

parameterValidators() - Method in class revxrsal.commands.Lamp

Returns an immutable list of the parameter resolvers registered in this Lamp instance

parse(MutableStringStream, ExecutionContext<A>) - Method in interface revxrsal.commands.node.ParameterNode

Parses the given input and produces the appropriate value for the input.

parse(CommandFunction, Lamp<A>, MutableStringStream) - Static method in class revxrsal.commands.node.parser.TreeParser

parse(MutableStringStream, ExecutionContext<A>) - Method in interface revxrsal.commands.parameter.ParameterType

Reads input from the given MutableStringStream, parses the object, or throws exceptions if needed.

parse(MutableStringStream, ExecutionContext<CommandActor>) - Method in class revxrsal.commands.parameter.primitives.BooleanParameterType

parse(MutableStringStream, ExecutionContext<CommandActor>) - Method in class revxrsal.commands.parameter.primitives.ByteParameterType

parse(MutableStringStream, ExecutionContext<CommandActor>) - Method in class revxrsal.commands.parameter.primitives.CharParameterType

parse(MutableStringStream, ExecutionContext<CommandActor>) - Method in class revxrsal.commands.parameter.primitives.DoubleParameterType

parse(MutableStringStream, ExecutionContext<CommandActor>) - Method in class revxrsal.commands.parameter.primitives.FloatParameterType

parse(MutableStringStream, ExecutionContext<CommandActor>) - Method in class revxrsal.commands.parameter.primitives.IntParameterType

parse(MutableStringStream, ExecutionContext<CommandActor>) - Method in class revxrsal.commands.parameter.primitives.LongParameterType

parse(MutableStringStream, ExecutionContext<CommandActor>) - Method in class revxrsal.commands.parameter.primitives.ShortParameterType

parse(MutableStringStream, ExecutionContext<CommandActor>) - Method in class revxrsal.commands.parameter.primitives.UUIDParameterType

parse(MutableStringStream, ExecutionContext<CommandActor>) - Method in class revxrsal.commands.parameter.StringParameterType

parseCommandAnnotations(Class<?>, CommandFunction) - Static method in class revxrsal.commands.util.CommandPaths

ParseException(String) - Constructor for exception revxrsal.commands.stream.token.TokenParser.ParseException

parseNextToken(MutableStringStream) - Static method in class revxrsal.commands.stream.token.TokenParser

Parses the next Token in the given stream

parsePriority() - Method in interface revxrsal.commands.parameter.ParameterType

The priority for an argument of this type over other candidate arguments.

parsePriority() - Method in class revxrsal.commands.parameter.primitives.BooleanParameterType

parsePriority() - Method in class revxrsal.commands.parameter.primitives.ByteParameterType

parsePriority() - Method in class revxrsal.commands.parameter.primitives.CharParameterType

parsePriority() - Method in class revxrsal.commands.parameter.primitives.IntParameterType

parsePriority() - Method in class revxrsal.commands.parameter.primitives.LongParameterType

parsePriority() - Method in class revxrsal.commands.parameter.primitives.ShortParameterType

parsePriority() - Method in class revxrsal.commands.parameter.StringParameterType

ParseWith - Annotation Type in revxrsal.commands.annotation

An annotation that instructs Lamp that certain parameters should be parsed using a specific ParameterType or a ParameterType.Factory.

ParseWithParameterTypeFactory - Enum in revxrsal.commands.parameter.builtins

parsingLiteral(ExecutionContext<A>, LiteralNode<A>) - Static method in interface revxrsal.commands.exception.context.ErrorContext

Creates a ErrorContext.ParsingLiteral context for the given literal node

parsingParameter(ExecutionContext<A>, ParameterNode<A, ?>, StringStream) - Static method in interface revxrsal.commands.exception.context.ErrorContext

Creates a ErrorContext.ParsingParameter context for the given parameter node

path() - Method in interface revxrsal.commands.command.ExecutableCommand

Returns the path of this command.

path(String...) - Static method in class revxrsal.commands.orphan.Orphans

Starts the registration of an orphan command.

paths() - Method in class revxrsal.commands.orphan.OrphanRegistry

paths() - Method in class revxrsal.commands.orphan.Orphans

peek() - Method in interface revxrsal.commands.stream.StringStream

Peeks the next character, without moving the cursor forward.

peek(int) - Method in interface revxrsal.commands.stream.StringStream

Peeks the next number of character, without moving the cursor forward.

peekOffset(int) - Method in interface revxrsal.commands.stream.StringStream

Peeks the character after offset chars, without moving the cursor forward.

peekRemaining() - Method in interface revxrsal.commands.stream.StringStream

Peeks the remainder of the string stream

peekString() - Method in interface revxrsal.commands.stream.StringStream

Peeks the next string.

peekUnquotedString() - Method in interface revxrsal.commands.stream.StringStream

Peeks a single, unquoted string.

permission() - Method in interface revxrsal.commands.node.RequiresPermission

The permission of this component

PermissionConditionChecker - Enum in revxrsal.commands.command

permissionFactory(CommandPermission.Factory<? super A>) - Method in class revxrsal.commands.Lamp.Builder

Registers a CommandPermission.Factory that creates CommandPermissions for commands and parameters

permissionForAnnotation(Class<T>, Function<T, CommandPermission<A>>) - Method in class revxrsal.commands.Lamp.Builder

Registers a CommandPermission function that creates CommandPermissions for commands and parameters that have the given

position() - Method in interface revxrsal.commands.stream.StringStream

Returns the cursor position

Potential<A extends CommandActor> - Interface in revxrsal.commands.command

Represents the result obtained from attempting to parse an ExecutableCommand with some MutableStringStream input.

Preconditions - Class in revxrsal.commands.util

A utility class to check for preconditions of functions, allowing to catch problematic user input early on.

preventsDuplicates() - Method in class revxrsal.commands.parameter.builtins.SetParameterTypeFactory

PrioritySpec - Class in revxrsal.commands.parameter

Represents a priority specification for a certain ParameterType.

PrioritySpec(Comparator<ParameterType<?, ?>>) - Constructor for class revxrsal.commands.parameter.PrioritySpec

PrioritySpec.Builder - Class in revxrsal.commands.parameter

A builder for creating a PrioritySpec.

provider(CommandParameter, Lamp<A>) - Method in class revxrsal.commands.autocomplete.SuggestionProviders

Returns the first SuggestionProvider that can create suggestions for the given parameter.

provider(Type, AnnotationList, Lamp<A>) - Method in class revxrsal.commands.autocomplete.SuggestionProviders

Returns the first SuggestionProvider that can create suggestions for the given type and annotations.

R

Range - Annotation Type in revxrsal.commands.annotation

An annotation that marks a numerical parameter as required to be in a specific range

RangeChecker - Enum in revxrsal.commands.parameter

A parameter validator that checks for the @Range annotation.

read() - Method in interface revxrsal.commands.stream.MutableStringStream

Reads the next character, and moves the cursor forward.

read(int) - Method in interface revxrsal.commands.stream.MutableStringStream

Reads the given number of characters, and moves the cursor forward.

read(int) - Method in class revxrsal.commands.stream.MutableStringStreamImpl

readBoolean() - Method in interface revxrsal.commands.stream.MutableStringStream

Parses the next token as a boolean.

readBoolean() - Method in class revxrsal.commands.stream.MutableStringStreamImpl

readByte() - Method in interface revxrsal.commands.stream.MutableStringStream

Parses the next token as a byte.

readByte() - Method in class revxrsal.commands.stream.MutableStringStreamImpl

readDouble() - Method in interface revxrsal.commands.stream.MutableStringStream

Parses the next token as a double.

readDouble() - Method in class revxrsal.commands.stream.MutableStringStreamImpl

readFloat() - Method in interface revxrsal.commands.stream.MutableStringStream

Parses the next token as a float.

readFloat() - Method in class revxrsal.commands.stream.MutableStringStreamImpl

readInt() - Method in interface revxrsal.commands.stream.MutableStringStream

Parses the next token as an int.

readInt() - Method in class revxrsal.commands.stream.MutableStringStreamImpl

readLong() - Method in interface revxrsal.commands.stream.MutableStringStream

Parses the next token as a long.

readLong() - Method in class revxrsal.commands.stream.MutableStringStreamImpl

readShort() - Method in interface revxrsal.commands.stream.MutableStringStream

Parses the next token as a short.

readShort() - Method in class revxrsal.commands.stream.MutableStringStreamImpl

readString() - Method in interface revxrsal.commands.stream.MutableStringStream

Reads the next string.

readUnquotedString() - Method in interface revxrsal.commands.stream.MutableStringStream

Reads a single, unquoted string.

readUntil(char) - Method in interface revxrsal.commands.stream.MutableStringStream

Reads a string until it encounters the given delimiter character.

readUntil(char) - Method in class revxrsal.commands.stream.MutableStringStreamImpl

readWhile(CharPredicate) - Method in interface revxrsal.commands.stream.MutableStringStream

Reads from the text stream until the given predicate returns false.

readWhile(CharPredicate) - Method in class revxrsal.commands.stream.MutableStringStreamImpl

ReflectionAction<A extends CommandActor> - Class in revxrsal.commands.node.parser

ReflectionAction(CommandFunction) - Constructor for class revxrsal.commands.node.parser.ReflectionAction

Reflections - Class in revxrsal.commands.util

register(Object...) - Method in class revxrsal.commands.Lamp

Registers the given instance to the command handler.

register(Class<?>, Object) - Method in class revxrsal.commands.node.parser.BaseCommandRegistry

register(Class<?>, Object, List<String>) - Method in class revxrsal.commands.node.parser.BaseCommandRegistry

registry() - Method in class revxrsal.commands.Lamp

Returns the command registry.

relatedCommands(A) - Method in interface revxrsal.commands.command.ExecutableCommand

Returns all related commands of this command.

relatedCommands() - Method in interface revxrsal.commands.command.ExecutableCommand

Returns all related commands of this command.

remaining() - Method in interface revxrsal.commands.stream.StringStream

Returns the characters remaining

removeRanges(String, List<Strings.StringRange>) - Static method in class revxrsal.commands.util.Strings

replaceAnnotation(AnnotatedElement, T) - Method in interface revxrsal.commands.annotation.dynamic.AnnotationReplacer

Returns a collection of annotations that will substitute the given annotation, and be accessible in AnnotationList.get(Class).

replaceAnnotations(AnnotatedElement, Map<Class<? extends Annotation>, Set<AnnotationReplacer<?>>>) - Method in interface revxrsal.commands.annotation.list.AnnotationList

Replaces the annotations in this type with any suitable AnnotationReplacers in the supplied replacers map, and returns a (possibly new) AnnotationList with the replaced annotations.

reply(String) - Method in interface revxrsal.commands.command.CommandActor

Replies to the sender with the specified message.

representation() - Method in interface revxrsal.commands.node.CommandNode

Returns the node string representation.

representation() - Method in interface revxrsal.commands.node.LiteralNode

Returns the string representation.

require(Class<T>, String) - Method in interface revxrsal.commands.annotation.list.AnnotationList

Gets the given annotation, otherwise throws an IllegalStateException if it is not present.

requireContextParameter() - Method in class revxrsal.commands.parameter.ParameterResolver

requireContextParameter(Type) - Method in class revxrsal.commands.parameter.ParameterResolver

requireContextParameter(String) - Method in class revxrsal.commands.parameter.ParameterResolver

requiredInput() - Method in interface revxrsal.commands.command.ExecutableCommand

Returns the number of required literals or parameters in this command

requireLiteralNode() - Method in interface revxrsal.commands.node.CommandNode

Requires this node to be a LiteralNode and automatically casts it, otherwise throws a IllegalStateException.

requireLiteralNode() - Method in interface revxrsal.commands.node.LiteralNode

Requires this node to be a LiteralNode and automatically casts it

requireLiteralNode() - Method in interface revxrsal.commands.node.ParameterNode

Requires this node to be a LiteralNode.

requireParameterNode() - Method in interface revxrsal.commands.node.CommandNode

Requires this node to be a ParameterNode and automatically casts it, otherwise throws a IllegalStateException.

requireParameterNode() - Method in interface revxrsal.commands.node.LiteralNode

Requires this node to be a ParameterNode.

requireParameterType() - Method in class revxrsal.commands.parameter.ParameterResolver

requireParameterType(Type) - Method in class revxrsal.commands.parameter.ParameterResolver

requireParameterType(String) - Method in class revxrsal.commands.parameter.ParameterResolver

RequiresPermission<A extends CommandActor> - Interface in revxrsal.commands.node

Represents a target that requires a permission to be used

resolve(CommandParameter, ExecutionContext<A>) - Method in class revxrsal.commands.parameter.builtins.SenderContextParameter

resolve(CommandParameter, ExecutionContext<A>) - Method in interface revxrsal.commands.parameter.ContextParameter

Reads input from the given MutableStringStream, parses the object, or throws exceptions if needed.

resolvedArguments() - Method in interface revxrsal.commands.node.ExecutionContext

Returns the arguments that have been resolved, each mapped to the parameter name.

resolver(CommandParameter) - Method in class revxrsal.commands.Lamp

Returns the first ParameterType that can parse the given parameter.

resolver(Type) - Method in class revxrsal.commands.Lamp

Returns the first ParameterType that can parse the given type.

resolver(Type, AnnotationList) - Method in class revxrsal.commands.Lamp

Returns the first ParameterType that can parse the given type and annotations.

resolver() - Method in class revxrsal.commands.parameter.builtins.SenderContextParameter

resolver(Type, AnnotationList, Lamp<A>) - Method in class revxrsal.commands.parameter.ParameterTypes

Returns the first ParameterType that can parse the given type and annotations.

responseHandler() - Method in interface revxrsal.commands.command.CommandFunction

Returns the response handler for this function

responseHandler(Class<T>, ResponseHandler<? super A, T>) - Method in class revxrsal.commands.Lamp.Builder

Registers a ResponseHandler that accepts the objects matching a certain type returned by command functions.

responseHandler(ResponseHandler.Factory<? super A>) - Method in class revxrsal.commands.Lamp.Builder

Registers a ResponseHandler.Factory that accepts returned by command functions.

responseHandler(Type, AnnotationList) - Method in class revxrsal.commands.Lamp

Returns the first ResponseHandler that can handle the given type and annotation list.

responseHandler() - Method in class revxrsal.commands.response.ClassResponseHandlerFactory

ResponseHandler<A extends CommandActor,T> - Interface in revxrsal.commands.response

A handler for post-handling command responses (results returned from the command methods)

ResponseHandler.Factory<A extends CommandActor> - Interface in revxrsal.commands.response

A factory that allows to create ResponseHandlers dynamically.

revxrsal.commands - package revxrsal.commands

revxrsal.commands.annotation - package revxrsal.commands.annotation

revxrsal.commands.annotation.dynamic - package revxrsal.commands.annotation.dynamic

revxrsal.commands.annotation.list - package revxrsal.commands.annotation.list

revxrsal.commands.autocomplete - package revxrsal.commands.autocomplete

revxrsal.commands.command - package revxrsal.commands.command

revxrsal.commands.exception - package revxrsal.commands.exception

revxrsal.commands.exception.context - package revxrsal.commands.exception.context

revxrsal.commands.help - package revxrsal.commands.help

revxrsal.commands.hook - package revxrsal.commands.hook

revxrsal.commands.ktx - package revxrsal.commands.ktx

revxrsal.commands.node - package revxrsal.commands.node

revxrsal.commands.node.parser - package revxrsal.commands.node.parser

revxrsal.commands.orphan - package revxrsal.commands.orphan

revxrsal.commands.parameter - package revxrsal.commands.parameter

revxrsal.commands.parameter.builtins - package revxrsal.commands.parameter.builtins

revxrsal.commands.parameter.primitives - package revxrsal.commands.parameter.primitives

revxrsal.commands.process - package revxrsal.commands.process

revxrsal.commands.reflect - package revxrsal.commands.reflect

revxrsal.commands.reflect.ktx - package revxrsal.commands.reflect.ktx

revxrsal.commands.response - package revxrsal.commands.response

revxrsal.commands.stream - package revxrsal.commands.stream

revxrsal.commands.stream.token - package revxrsal.commands.stream.token

revxrsal.commands.util - package revxrsal.commands.util

RuntimeExceptionAdapter<A extends CommandActor> - Class in revxrsal.commands.exception

A utility class that allows to easily handle individual exceptions by creating smaller functions that handle specific types of exceptions or deal with specific ErrorContexts.

RuntimeExceptionAdapter() - Constructor for class revxrsal.commands.exception.RuntimeExceptionAdapter

Registers all RuntimeExceptionAdapter.HandleException-annotated methods to this exception handler

RuntimeExceptionAdapter.HandleException - Annotation Type in revxrsal.commands.exception

Annotation for creating handler functions.

S

sanitize(Throwable) - Method in class revxrsal.commands.util.StackTraceSanitizer

Strips all the stack trace elements that meet the criteria of any filter.

SecretCommand - Annotation Type in revxrsal.commands.annotation

Marks a command as a "secret" command.

SelfHandledException<A extends CommandActor> - Interface in revxrsal.commands.exception

An interface designed for exceptions that wish to handle themselves, without having to be explicitly handled by an exception adapter.

send(A, T) - Method in interface revxrsal.commands.process.MessageSender

Sends the message to the actor

SendableException - Exception in revxrsal.commands.exception

Represents an exception that is purely used to send messages directly to the sender.

SendableException() - Constructor for exception revxrsal.commands.exception.SendableException

Constructs a new SendableException that does not send any message.

SendableException(String) - Constructor for exception revxrsal.commands.exception.SendableException

Constructs a new SendableException with an inferred actor

SenderContextParameter<A extends CommandActor,T> - Class in revxrsal.commands.parameter.builtins

SenderContextParameter(SenderResolver<A>) - Constructor for class revxrsal.commands.parameter.builtins.SenderContextParameter

senderResolver(SenderResolver<? super A>) - Method in class revxrsal.commands.Lamp.Builder

Registers a SenderResolver which is responsible for parsing the first parameter in the command and testing if it should be assumed the sender type

SenderResolver<A extends CommandActor> - Interface in revxrsal.commands.process

Represents a special resolver for parameters that are always first in command methods.

senderResolvers() - Method in class revxrsal.commands.Lamp

Returns an immutable list of the sender resolvers registered in this Lamp instance

SendMessageException - Exception in revxrsal.commands.exception

Used to directly send-and-return a message to the command actor.

SendMessageException() - Constructor for exception revxrsal.commands.exception.SendMessageException

Constructs a new SendMessageException that does not send any message.

SendMessageException(String) - Constructor for exception revxrsal.commands.exception.SendMessageException

Constructs a new SendMessageException with an inferred actor

sendRawError(String) - Method in interface revxrsal.commands.command.CommandActor

Sends an error message to the sender.

sendRawMessage(String) - Method in interface revxrsal.commands.command.CommandActor

Sends a message to the sender.

sendTo(CommandActor) - Method in exception revxrsal.commands.exception.CommandErrorException

Sends the message to the given actor

sendTo(CommandActor) - Method in exception revxrsal.commands.exception.SendableException

Sends the message to the given actor

sendTo(CommandActor) - Method in exception revxrsal.commands.exception.SendMessageException

Sends the message to the given actor

separateCamelCase(String, String) - Static method in class revxrsal.commands.util.BuiltInNamingStrategies

Converts the field name that uses camel-case define word separation into separate words that are separated by the provided separatorString.

SetParameterTypeFactory - Class in revxrsal.commands.parameter.builtins

setPosition(int) - Method in interface revxrsal.commands.stream.MutableStringStream

Sets the current position of the cursor

setPosition(int) - Method in class revxrsal.commands.stream.MutableStringStreamImpl

SHORT_FORMAT_PREFIX - Static variable in class revxrsal.commands.node.DispatcherSettings

The default short format for flags and switches

shorthand() - Method in exception revxrsal.commands.exception.UnknownParameterException

shorthand() - Method in interface revxrsal.commands.node.ParameterNode

Gets the shorthand defined from either Flag.shorthand() or Switch.shorthand().

ShortParameterType - Class in revxrsal.commands.parameter.primitives

A basic ParameterType for parsing short types

ShortParameterType() - Constructor for class revxrsal.commands.parameter.primitives.ShortParameterType

siblingCommands(A) - Method in interface revxrsal.commands.command.ExecutableCommand

Returns all siblings of this command

siblingCommands() - Method in interface revxrsal.commands.command.ExecutableCommand

Returns all siblings of this command

Single - Annotation Type in revxrsal.commands.annotation

Marker annotation to mark that a parameter should NOT be concatenated with the rest of the command arguments (which is the default behavior for trailing String arguments).

single() - Static method in class revxrsal.commands.parameter.StringParameterType

size() - Method in interface revxrsal.commands.command.ExecutableCommand

Returns the amount of nodes in this command.

Sized - Annotation Type in revxrsal.commands.annotation

An annotation that marks that collection-based annotation, such as List, Set, or a T[] array type, should have size in the range of Sized.min() and Sized.max() (both inclusive)

skipToEnd() - Method in interface revxrsal.commands.stream.MutableStringStream

Skips to the end of the stream

skipToEnd() - Method in class revxrsal.commands.stream.MutableStringStreamImpl

skipWhitespace() - Method in interface revxrsal.commands.stream.MutableStringStream

Skips all the upcoming whitespace

skipWhitespace() - Method in class revxrsal.commands.stream.MutableStringStreamImpl

SNOWFLAKE - Static variable in class revxrsal.commands.util.Strings

Pattern to extract snowflake IDs.

source() - Method in interface revxrsal.commands.stream.StringStream

Returns the original entire string source.

SPACE - Static variable in class revxrsal.commands.util.Strings

Pattern to split by whitespace

stackTraceSanitizer(StackTraceSanitizer) - Method in class revxrsal.commands.node.DispatcherSettings.Builder

Sets the stack-trace sanitizer.

stackTraceSanitizer() - Method in class revxrsal.commands.node.DispatcherSettings

The stack trace sanitizer for cleaning up stack-traces of errors thrown inside commands

StackTraceSanitizer - Class in revxrsal.commands.util

A utility for stripping stacktrace from local paths to classes.

StackTraceSanitizer.Builder - Class in revxrsal.commands.util

start() - Method in class revxrsal.commands.util.Strings.StringRange

StringParameterType - Class in revxrsal.commands.parameter

A basic ParameterType for parsing String types

StringRange(int, int) - Constructor for class revxrsal.commands.util.Strings.StringRange

Strings - Class in revxrsal.commands.util

General utilities for string operations

Strings.StringRange - Class in revxrsal.commands.util

StringStream - Interface in revxrsal.commands.stream

stripNamespace(String, String) - Static method in class revxrsal.commands.util.Strings

stripNamespace(String) - Static method in class revxrsal.commands.util.Strings

Subcommand - Annotation Type in revxrsal.commands.annotation

Marks a method as a subcommand that has a parent.

successful() - Method in interface revxrsal.commands.command.Potential

Tests whether the execution was successful or not

Suggest - Annotation Type in revxrsal.commands.annotation

An annotation that specifies the suggestions that a parameter will produce.

SuggestionProvider<A extends CommandActor> - Interface in revxrsal.commands.autocomplete

An interface that supplies completions for the user depending on their input.

suggestionProvider(Type) - Method in class revxrsal.commands.Lamp

Returns the first SuggestionProvider that can create suggestions for the given type and annotations.

suggestionProvider(Type, AnnotationList) - Method in class revxrsal.commands.Lamp

Returns the first SuggestionProvider that can create suggestions for the given type and annotations.

suggestionProvider(CommandParameter) - Method in class revxrsal.commands.Lamp

Returns the first SuggestionProvider that can create suggestions for the given parameter.

SuggestionProvider.Factory<A extends CommandActor> - Interface in revxrsal.commands.autocomplete

Represents a factory that creates SuggestionProviders dynamically.

SuggestionProviders<A extends CommandActor> - Class in revxrsal.commands.autocomplete

An immutable registry of SuggestionProviders and SuggestionProvider.Factories.

suggestionProviders() - Method in class revxrsal.commands.Lamp.Builder

Returns the SuggestionProviders builder

suggestionProviders(Consumer<SuggestionProviders.Builder<A>>) - Method in class revxrsal.commands.Lamp.Builder

Performs the given consumer on the Lamp.Builder.suggestionProviders() builder.

suggestionProviders() - Method in class revxrsal.commands.Lamp

Returns the suggestion provider registry

SuggestionProviders.Builder<A extends CommandActor> - Class in revxrsal.commands.autocomplete

suggestions() - Method in interface revxrsal.commands.node.ParameterNode

Returns the suggestion provider for this parameter node.

SuggestWith - Annotation Type in revxrsal.commands.annotation

An annotation that instructs Lamp that certain parameters should produce suggestions using a specific SuggestionProvider or a SuggestionProvider.Factory.

SupplierResponseHandler - Enum in revxrsal.commands.response

A ResponseHandler.Factory that creates ResponseHandlers for {@code Supplier} where T is any type that has a registered response handler.

Switch - Annotation Type in revxrsal.commands.annotation

Marks a (strictly) boolean parameter as a "switch", whose value will be set by "flags", such as "--silent", which will represent a boolean parameter annotated with @Switch("silent").

switchName() - Method in interface revxrsal.commands.node.ParameterNode

Gets the switch name defined in Switch.value().

T

target() - Method in exception revxrsal.commands.exception.NoPermissionException

test(A, MutableStringStream) - Method in interface revxrsal.commands.command.ExecutableCommand

Tests this command with the given input, returning a Potential which contains the parameters parsed as well as any other errors that occurred during execution.

test(ExecutionContext<CommandActor>) - Method in enum revxrsal.commands.command.PermissionConditionChecker

test(ExecutionContext<A>) - Method in interface revxrsal.commands.process.CommandCondition

Evaluates the condition.

test(char) - Method in interface revxrsal.commands.stream.CharPredicate

Tests whether the character matches the given predicate or not

ThrowableFromCommand - Annotation Type in revxrsal.commands.exception

Marks an exception class as throwable from inside the command.

toBuilder() - Method in class revxrsal.commands.autocomplete.SuggestionProviders

Creates a SuggestionProviders.Builder that contains the providers registered in this registry.

toBuilder() - Method in class revxrsal.commands.node.DispatcherSettings

Creates a new DispatcherSettings.Builder based on this DispatcherSettings instance

toBuilder() - Method in class revxrsal.commands.parameter.ParameterTypes

Creates a ParameterTypes.Builder that contains the factories registered in this registry.

toBuilder() - Method in class revxrsal.commands.parameter.PrioritySpec

Creates a new PrioritySpec.Builder from this priority specification

toImmutableCopy() - Method in interface revxrsal.commands.stream.MutableStringStream

Returns an StringStream copy of this string stream

toImmutableCopy() - Method in interface revxrsal.commands.stream.StringStream

Returns an StringStream copy of this string stream

Token - Interface in revxrsal.commands.stream.token

Represents a token in parsing the paths inside Command and Subcommand annotations

TokenParser - Class in revxrsal.commands.stream.token

A utility class for parsing Tokens in annotations

TokenParser() - Constructor for class revxrsal.commands.stream.token.TokenParser

TokenParser.ParseException - Exception in revxrsal.commands.stream.token

toMutableCopy() - Method in interface revxrsal.commands.stream.MutableStringStream

Returns a new, mutable MutableStringStream copy of this stream.

toMutableCopy() - Method in interface revxrsal.commands.stream.StringStream

Returns a new, mutable MutableStringStream copy of this stream.

toMutableMap() - Method in interface revxrsal.commands.annotation.list.AnnotationList

Returns a mutable map that contains the annotations contained in this annotation list

toString() - Method in class revxrsal.commands.orphan.OrphanRegistry

toString() - Method in class revxrsal.commands.orphan.Orphans

toString() - Method in class revxrsal.commands.parameter.builtins.ClassContextParameterFactory

toString() - Method in class revxrsal.commands.parameter.builtins.ClassParameterTypeFactory

toString() - Method in class revxrsal.commands.parameter.builtins.SenderContextParameter

toString() - Method in class revxrsal.commands.parameter.PrioritySpec

toString() - Method in class revxrsal.commands.reflect.ktx.CallableMethod

toString() - Method in class revxrsal.commands.response.ClassResponseHandlerFactory

toString() - Method in class revxrsal.commands.stream.token.LiteralToken

toString() - Method in class revxrsal.commands.stream.token.ParameterToken

toString() - Method in class revxrsal.commands.util.Strings.StringRange

totalSize() - Method in interface revxrsal.commands.stream.StringStream

Returns the size of the source

TreeParser<A extends CommandActor> - Class in revxrsal.commands.node.parser

type() - Method in interface revxrsal.commands.command.CommandParameter

Returns the raw class type of the parameter.

type() - Method in interface revxrsal.commands.node.ParameterNode

Returns the parameter Java type

type() - Method in class revxrsal.commands.parameter.builtins.ClassContextParameterFactory

type() - Method in class revxrsal.commands.parameter.builtins.ClassParameterTypeFactory

type() - Method in class revxrsal.commands.response.ClassResponseHandlerFactory

U

uniqueId() - Method in interface revxrsal.commands.command.CommandActor

Returns the unique UID of this subject.

unknownCommand(A) - Static method in interface revxrsal.commands.exception.context.ErrorContext

Creates an ErrorContext.UnknownCommand error context

UnknownCommandException - Exception in revxrsal.commands.exception

Thrown when an invalid root command is inputted.

UnknownCommandException(String) - Constructor for exception revxrsal.commands.exception.UnknownCommandException

unknownParameter(ExecutionContext<A>) - Static method in interface revxrsal.commands.exception.context.ErrorContext

Creates an ErrorContext.UnknownParameter error context

UnknownParameterException - Exception in revxrsal.commands.exception

UnknownParameterException(String, boolean) - Constructor for exception revxrsal.commands.exception.UnknownParameterException

unmodifiableIterator(Iterator<E>) - Static method in class revxrsal.commands.util.Collections

unregister() - Method in interface revxrsal.commands.command.ExecutableCommand

Unregisters this executable command.

unregister(ExecutableCommand<A>) - Method in class revxrsal.commands.Lamp

Unregisters the given executable command

unregister(ExecutableCommand<A>) - Method in interface revxrsal.commands.node.CommandRegistry

Unregisters the given command.

unregister(ExecutableCommand<A>) - Method in class revxrsal.commands.node.parser.BaseCommandRegistry

unregisterAllCommands() - Method in class revxrsal.commands.Lamp

Unregisters all the commands in this Lamp instance

unregisterIf(Predicate<ExecutableCommand<A>>) - Method in class revxrsal.commands.Lamp

Unregisters all the commands in this Lamp instance that match the given predicate

unregisterIf(Predicate<ExecutableCommand<A>>) - Method in interface revxrsal.commands.node.CommandRegistry

Unregisters all commands that match a certain Predicate criteria.

unregisterIf(Predicate<ExecutableCommand<A>>) - Method in class revxrsal.commands.node.parser.BaseCommandRegistry

unwrap(Class<T>) - Static method in class revxrsal.commands.util.Classes

Returns the corresponding primitive type of type if it is a wrapper type; otherwise returns the type itself.

upperCamelCase() - Static method in interface revxrsal.commands.node.ParameterNamingStrategy

Converts the parameter name from lower-camel case to upper-camel case.

upperCamelCaseWithSeparator(String) - Static method in interface revxrsal.commands.node.ParameterNamingStrategy

Converts the parameter name from lower-camel case to upper-camel case, separated by a custom separator.

upperCamelCaseWithSpace() - Static method in interface revxrsal.commands.node.ParameterNamingStrategy

Converts the parameter name from lower-camel case to upper-camel case, separated by spaces.

upperCaseFirstLetter(String) - Static method in class revxrsal.commands.util.BuiltInNamingStrategies

Ensures the parameter names begins with an upper case letter.

Usage - Annotation Type in revxrsal.commands.annotation

An annotation to give the ExecutableCommand a usage.

usage() - Method in interface revxrsal.commands.command.ExecutableCommand

Returns the usage of this command.

UUIDParameterType - Class in revxrsal.commands.parameter.primitives

A basic ParameterType for parsing UUID types

UUIDParameterType() - Constructor for class revxrsal.commands.parameter.primitives.UUIDParameterType

V

validate(A, T, ParameterNode<A, T>) - Method in class revxrsal.commands.Lamp

Validates a parameter by passing it into the registered ParameterValidators

validate(CommandActor, String, ParameterNode<CommandActor, String>, Lamp<CommandActor>) - Method in enum revxrsal.commands.parameter.LengthChecker

validate(CommandActor, Number, ParameterNode<CommandActor, Number>, Lamp<CommandActor>) - Method in enum revxrsal.commands.parameter.RangeChecker

validate(A, T, ParameterNode<A, T>, Lamp<A>) - Method in interface revxrsal.commands.process.ParameterValidator

Validates the specified value that was passed to a parameter.

value() - Method in class revxrsal.commands.stream.token.LiteralToken

valueOf(String) - Static method in enum revxrsal.commands.command.PermissionConditionChecker

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum revxrsal.commands.exception.InputParseException.Cause

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum revxrsal.commands.ktx.KotlinFeatureRegistry

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum revxrsal.commands.parameter.builtins.EnumParameterTypeFactory

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum revxrsal.commands.parameter.builtins.OptionalParameterTypeFactory

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum revxrsal.commands.parameter.builtins.ParseWithParameterTypeFactory

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum revxrsal.commands.parameter.CommandActorSenderResolver

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum revxrsal.commands.parameter.LengthChecker

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum revxrsal.commands.parameter.RangeChecker

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum revxrsal.commands.response.CompletionStageResponseHandler

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum revxrsal.commands.response.OptionalResponseHandler

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum revxrsal.commands.response.SupplierResponseHandler

Returns the enum constant of this type with the specified name.

values() - Static method in enum revxrsal.commands.command.PermissionConditionChecker

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum revxrsal.commands.exception.InputParseException.Cause

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum revxrsal.commands.ktx.KotlinFeatureRegistry

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum revxrsal.commands.parameter.builtins.EnumParameterTypeFactory

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum revxrsal.commands.parameter.builtins.OptionalParameterTypeFactory

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum revxrsal.commands.parameter.builtins.ParseWithParameterTypeFactory

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum revxrsal.commands.parameter.CommandActorSenderResolver

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum revxrsal.commands.parameter.LengthChecker

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum revxrsal.commands.parameter.RangeChecker

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum revxrsal.commands.response.CompletionStageResponseHandler

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum revxrsal.commands.response.OptionalResponseHandler

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum revxrsal.commands.response.SupplierResponseHandler

Returns an array containing the constants of this enum type, in the order they are declared.

visit(Lamp.Builder<CommandActor>) - Method in enum revxrsal.commands.ktx.KotlinFeatureRegistry

visit(Lamp.Builder<A>) - Method in interface revxrsal.commands.LampBuilderVisitor

Visits the given builder

visit(Lamp<A>) - Method in interface revxrsal.commands.LampVisitor

Visits the given Lamp

W

wasCancelled() - Method in interface revxrsal.commands.hook.CancelHandle

Tests whether this handle was cancelled or not

withAnnotations(boolean, Annotation...) - Method in interface revxrsal.commands.annotation.list.AnnotationList

Creates a new AnnotationList that contains these annotations as well as the given annotations.

withAnnotations(Annotation...) - Method in interface revxrsal.commands.annotation.list.AnnotationList

Creates a new AnnotationList that contains these annotations as well as the given annotations.

wrap(Method) - Static method in interface revxrsal.commands.reflect.ktx.KotlinFunction

Generates a KotlinFunction for the given Method.

wrap(Class<T>) - Static method in class revxrsal.commands.util.Classes

Returns the corresponding wrapper type of type if it is a primitive type; otherwise returns the type itself.

A B C D E F G H I K L M N O P R S T U V W