Index

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

A

accept(CommandPostprocessingContext<C>) - Method in class cloud.commandframework.execution.postprocessor.AcceptingCommandPostprocessor
 
accept(CommandPreprocessingContext<C>) - Method in class cloud.commandframework.execution.preprocessor.AcceptingCommandPreprocessor
 
AcceptingCommandPostprocessor<C> - Class in cloud.commandframework.execution.postprocessor
CommandPostprocessor that does nothing besides indicating that the context has been properly processed
AcceptingCommandPostprocessor() - Constructor for class cloud.commandframework.execution.postprocessor.AcceptingCommandPostprocessor
 
AcceptingCommandPreprocessor<C> - Class in cloud.commandframework.execution.preprocessor
CommandPreprocessor that does nothing besides indicating that the context has been properly processed
AcceptingCommandPreprocessor() - Constructor for class cloud.commandframework.execution.preprocessor.AcceptingCommandPreprocessor
 
addPreprocessor(BiFunction<CommandContext<C>, Queue<String>, ArgumentParseResult<Boolean>>) - Method in class cloud.commandframework.arguments.CommandArgument
Register a new preprocessor.
addPresenceFlag(CommandFlag<?>) - Method in class cloud.commandframework.arguments.flags.FlagContext
Indicate that a presence flag was supplied
addValueFlag(CommandFlag<T>, T) - Method in class cloud.commandframework.arguments.flags.FlagContext
Store a value associated with a value flag
AFTER_REGISTRATION - Enum constant in enum cloud.commandframework.CommandManager.RegistrationState
Once registration has been completed.
ALLOW_UNSAFE_REGISTRATION - Enum constant in enum cloud.commandframework.CommandManager.ManagerSettings
Allow registering commands even when doing so has the potential to produce inconsistent results.
AmbiguousNodeException - Exception in cloud.commandframework.exceptions
Exception thrown when a CommandContext is being inserted into a CommandTree and an ambiguity is detected.
AmbiguousNodeException(CommandArgument<?, ?>, CommandArgument<?, ?>, List<CommandArgument<?, ?>>) - Constructor for exception cloud.commandframework.exceptions.AmbiguousNodeException
Construct a new ambiguous node exception
and(CommandPermission) - Method in interface cloud.commandframework.permission.CommandPermission
Return a permission that matches this permission and the other permission.
and(CommandPermission...) - Method in interface cloud.commandframework.permission.CommandPermission
Return a permission that matches this permission and all of the other permissions.
AndPermission - Class in cloud.commandframework.permission
Accepts if every single permission is accepted.
annotation(Class<A>) - Method in interface cloud.commandframework.annotations.AnnotationAccessor
Get an annotation instance, if it's present.
annotation(Class<A>) - Method in class cloud.commandframework.annotations.AnnotationAccessor.NullAnnotationAccessor
 
AnnotationAccessor - Interface in cloud.commandframework.annotations
Managed access for Annotation instances
AnnotationAccessor.NullAnnotationAccessor - Class in cloud.commandframework.annotations
Annotation accessor that cannot access any annotations
annotations() - Method in interface cloud.commandframework.annotations.AnnotationAccessor
Get an immutable collection containing all of the annotations that are accessible using the annotation accessor
annotations() - Method in class cloud.commandframework.annotations.AnnotationAccessor.NullAnnotationAccessor
 
appendBlankSpace() - Method in class cloud.commandframework.arguments.StandardCommandSyntaxFormatter.FormattingInstance
Append a blank space
appendCompound(CompoundArgument<?, ?, ?>) - Method in class cloud.commandframework.arguments.StandardCommandSyntaxFormatter.FormattingInstance
Append a compound argument to the syntax string
appendFlag(FlagArgument<?>) - Method in class cloud.commandframework.arguments.StandardCommandSyntaxFormatter.FormattingInstance
Append a flag argument
appendLiteral(StaticArgument<?>) - Method in class cloud.commandframework.arguments.StandardCommandSyntaxFormatter.FormattingInstance
Append a literal to the syntax string
appendName(String) - Method in class cloud.commandframework.arguments.StandardCommandSyntaxFormatter.FormattingInstance
Append an argument name
appendOptional(CommandArgument<?, ?>) - Method in class cloud.commandframework.arguments.StandardCommandSyntaxFormatter.FormattingInstance
Append an optional argument
appendPipe() - Method in class cloud.commandframework.arguments.StandardCommandSyntaxFormatter.FormattingInstance
Append the pipe (|) character
appendRequired(CommandArgument<?, ?>) - Method in class cloud.commandframework.arguments.StandardCommandSyntaxFormatter.FormattingInstance
Append a required argument
apply(CommandContext<C>, Queue<String>) - Method in class cloud.commandframework.arguments.preprocessor.RegexPreprocessor
 
apply(CommandPreprocessingContext<C>, List<String>) - Method in class cloud.commandframework.execution.FilteringCommandSuggestionProcessor
 
apply(List<CommandArgument<C, ?>>, CommandTree.Node<CommandArgument<C, ?>>) - Method in interface cloud.commandframework.arguments.CommandSyntaxFormatter
Format the command arguments into a syntax string
apply(List<CommandArgument<C, ?>>, CommandTree.Node<CommandArgument<C, ?>>) - Method in class cloud.commandframework.arguments.StandardCommandSyntaxFormatter
Format the command arguments into a syntax string
argument(CommandArgument.Builder<C, T>) - Method in class cloud.commandframework.Command.Builder
Add a new command argument with an empty description to the command
argument(CommandArgument.Builder<C, T>, ArgumentDescription) - Method in class cloud.commandframework.Command.Builder
Add a new command argument to the command
argument(CommandArgument.Builder<C, T>, Description) - Method in class cloud.commandframework.Command.Builder
Deprecated.
argument(CommandArgument<C, T>) - Method in class cloud.commandframework.Command.Builder
Add a new command argument with an empty description to the command
argument(CommandArgument<C, T>, ArgumentDescription) - Method in class cloud.commandframework.Command.Builder
Add a new command argument to the command
argument(CommandArgument<C, T>, Description) - Method in class cloud.commandframework.Command.Builder
Deprecated.
argument(Class<T>, String, Consumer<CommandArgument.Builder<C, T>>) - Method in class cloud.commandframework.Command.Builder
Add a new command argument by interacting with a constructed command argument builder
ARGUMENT_PARSE_FAILURE_BOOLEAN - Static variable in class cloud.commandframework.captions.SimpleCaptionRegistry
ARGUMENT_PARSE_FAILURE_BOOLEAN - Static variable in class cloud.commandframework.captions.StandardCaptionKeys
Variables: {input}
ARGUMENT_PARSE_FAILURE_CHAR - Static variable in class cloud.commandframework.captions.SimpleCaptionRegistry
ARGUMENT_PARSE_FAILURE_CHAR - Static variable in class cloud.commandframework.captions.StandardCaptionKeys
Variables: {input}
ARGUMENT_PARSE_FAILURE_COLOR - Static variable in class cloud.commandframework.captions.SimpleCaptionRegistry
ARGUMENT_PARSE_FAILURE_COLOR - Static variable in class cloud.commandframework.captions.StandardCaptionKeys
Variables: {input}
ARGUMENT_PARSE_FAILURE_ENUM - Static variable in class cloud.commandframework.captions.SimpleCaptionRegistry
ARGUMENT_PARSE_FAILURE_ENUM - Static variable in class cloud.commandframework.captions.StandardCaptionKeys
Variables: {input}, {acceptableValues}
ARGUMENT_PARSE_FAILURE_FLAG_DUPLICATE_FLAG - Static variable in class cloud.commandframework.captions.SimpleCaptionRegistry
ARGUMENT_PARSE_FAILURE_FLAG_DUPLICATE_FLAG - Static variable in class cloud.commandframework.captions.StandardCaptionKeys
Variables: {flag}
ARGUMENT_PARSE_FAILURE_FLAG_MISSING_ARGUMENT - Static variable in class cloud.commandframework.captions.SimpleCaptionRegistry
ARGUMENT_PARSE_FAILURE_FLAG_MISSING_ARGUMENT - Static variable in class cloud.commandframework.captions.StandardCaptionKeys
Variables: {flag}
ARGUMENT_PARSE_FAILURE_FLAG_NO_FLAG_STARTED - Static variable in class cloud.commandframework.captions.SimpleCaptionRegistry
ARGUMENT_PARSE_FAILURE_FLAG_NO_FLAG_STARTED - Static variable in class cloud.commandframework.captions.StandardCaptionKeys
Variables: {input}
ARGUMENT_PARSE_FAILURE_FLAG_NO_PERMISSION - Static variable in class cloud.commandframework.captions.SimpleCaptionRegistry
ARGUMENT_PARSE_FAILURE_FLAG_NO_PERMISSION - Static variable in class cloud.commandframework.captions.StandardCaptionKeys
Variables: {flag}
ARGUMENT_PARSE_FAILURE_FLAG_UNKNOWN_FLAG - Static variable in class cloud.commandframework.captions.SimpleCaptionRegistry
ARGUMENT_PARSE_FAILURE_FLAG_UNKNOWN_FLAG - Static variable in class cloud.commandframework.captions.StandardCaptionKeys
Variables: {flag}
ARGUMENT_PARSE_FAILURE_NO_INPUT_PROVIDED - Static variable in class cloud.commandframework.captions.SimpleCaptionRegistry
ARGUMENT_PARSE_FAILURE_NO_INPUT_PROVIDED - Static variable in class cloud.commandframework.captions.StandardCaptionKeys
Variables: None
ARGUMENT_PARSE_FAILURE_NUMBER - Static variable in class cloud.commandframework.captions.SimpleCaptionRegistry
ARGUMENT_PARSE_FAILURE_NUMBER - Static variable in class cloud.commandframework.captions.StandardCaptionKeys
Variables: {input}, {min}, {max}
ARGUMENT_PARSE_FAILURE_REGEX - Static variable in class cloud.commandframework.captions.StandardCaptionKeys
Variables: {input}, {pattern}
ARGUMENT_PARSE_FAILURE_STRING - Static variable in class cloud.commandframework.captions.SimpleCaptionRegistry
ARGUMENT_PARSE_FAILURE_STRING - Static variable in class cloud.commandframework.captions.StandardCaptionKeys
Variables: {input}, {stringMode}
ARGUMENT_PARSE_FAILURE_UUID - Static variable in class cloud.commandframework.captions.SimpleCaptionRegistry
ARGUMENT_PARSE_FAILURE_UUID - Static variable in class cloud.commandframework.captions.StandardCaptionKeys
Variables: {input}
argumentBuilder(Class<T>, String) - Method in class cloud.commandframework.CommandManager
Create a new command argument builder.
ArgumentDescription - Interface in cloud.commandframework
A description for a CommandArgument
argumentPair(String, Pair<String, String>, Pair<Class<U>, Class<V>>, ArgumentDescription) - Method in class cloud.commandframework.Command.Builder
Create a new argument pair that maps to Pair
argumentPair(String, Pair<String, String>, Pair<Class<U>, Class<V>>, Description) - Method in class cloud.commandframework.Command.Builder
Deprecated.
argumentPair(String, TypeToken<O>, Pair<String, String>, Pair<Class<U>, Class<V>>, BiFunction<C, Pair<U, V>, O>, ArgumentDescription) - Method in class cloud.commandframework.Command.Builder
Create a new argument pair that maps to a custom type.
argumentPair(String, TypeToken<O>, Pair<String, String>, Pair<Class<U>, Class<V>>, BiFunction<C, Pair<U, V>, O>, Description) - Method in class cloud.commandframework.Command.Builder
ArgumentPair<C,U,V,O> - Class in cloud.commandframework.arguments.compound
A compound argument consisting of two inner arguments
ArgumentPair(boolean, String, Pair<String, String>, Pair<Class<U>, Class<V>>, Pair<ArgumentParser<C, U>, ArgumentParser<C, V>>, BiFunction<C, Pair<U, V>, O>, TypeToken<O>) - Constructor for class cloud.commandframework.arguments.compound.ArgumentPair
Create a new argument pair.
ArgumentPair.ArgumentPairIntermediaryBuilder<C,U,V> - Class in cloud.commandframework.arguments.compound
 
ArgumentParseException - Exception in cloud.commandframework.exceptions
 
ArgumentParseException(Throwable, Object, List<CommandArgument<?, ?>>) - Constructor for exception cloud.commandframework.exceptions.ArgumentParseException
Create a new command parse exception
ArgumentParser<C,T> - Interface in cloud.commandframework.arguments.parser
Parser that parses strings into values of a specific type
ArgumentParseResult<T> - Class in cloud.commandframework.arguments.parser
Result of the parsing done by a ArgumentParser
ArgumentTiming() - Constructor for class cloud.commandframework.context.CommandContext.ArgumentTiming
Created a new argument timing instance
ArgumentTiming(long) - Constructor for class cloud.commandframework.context.CommandContext.ArgumentTiming
Created a new argument timing instance without an end time
ArgumentTiming(long, long, boolean) - Constructor for class cloud.commandframework.context.CommandContext.ArgumentTiming
Created a new argument timing instance
argumentTriplet(String, Triplet<String, String, String>, Triplet<Class<U>, Class<V>, Class<W>>, ArgumentDescription) - Method in class cloud.commandframework.Command.Builder
Create a new argument pair that maps to Triplet
argumentTriplet(String, Triplet<String, String, String>, Triplet<Class<U>, Class<V>, Class<W>>, Description) - Method in class cloud.commandframework.Command.Builder
argumentTriplet(String, TypeToken<O>, Triplet<String, String, String>, Triplet<Class<U>, Class<V>, Class<W>>, BiFunction<C, Triplet<U, V, W>, O>, ArgumentDescription) - Method in class cloud.commandframework.Command.Builder
Create a new argument triplet that maps to a custom type.
argumentTriplet(String, TypeToken<O>, Triplet<String, String, String>, Triplet<Class<U>, Class<V>, Class<W>>, BiFunction<C, Triplet<U, V, W>, O>, Description) - Method in class cloud.commandframework.Command.Builder
ArgumentTriplet<C,U,V,W,O> - Class in cloud.commandframework.arguments.compound
A compound argument consisting of three inner arguments
ArgumentTriplet(boolean, String, Triplet<String, String, String>, Triplet<Class<U>, Class<V>, Class<W>>, Triplet<ArgumentParser<C, U>, ArgumentParser<C, V>, ArgumentParser<C, W>>, BiFunction<C, Triplet<U, V, W>, O>, TypeToken<O>) - Constructor for class cloud.commandframework.arguments.compound.ArgumentTriplet
Create a new argument triplet.
ArgumentTriplet.ArgumentTripletIntermediaryBuilder<C,U,V,W> - Class in cloud.commandframework.arguments.compound
 
asMap() - Method in class cloud.commandframework.context.CommandContext
Get the current state of this command context as a map of String to context value.
asOptional() - Method in class cloud.commandframework.arguments.CommandArgument.Builder
Indicates that the argument is optional.
asOptional() - Method in class cloud.commandframework.arguments.CommandArgument.TypedBuilder
Indicates that the argument is optional.
asOptionalWithDefault(byte) - Method in class cloud.commandframework.arguments.standard.ByteArgument.Builder
Sets the command argument to be optional, with the specified default value.
asOptionalWithDefault(double) - Method in class cloud.commandframework.arguments.standard.DoubleArgument.Builder
Sets the command argument to be optional, with the specified default value.
asOptionalWithDefault(float) - Method in class cloud.commandframework.arguments.standard.FloatArgument.Builder
Sets the command argument to be optional, with the specified default value.
asOptionalWithDefault(int) - Method in class cloud.commandframework.arguments.standard.IntegerArgument.Builder
Sets the command argument to be optional, with the specified default value.
asOptionalWithDefault(long) - Method in class cloud.commandframework.arguments.standard.LongArgument.Builder
Sets the command argument to be optional, with the specified default value.
asOptionalWithDefault(short) - Method in class cloud.commandframework.arguments.standard.ShortArgument.Builder
Sets the command argument to be optional, with the specified default value.
asOptionalWithDefault(String) - Method in class cloud.commandframework.arguments.CommandArgument.Builder
Indicates that the argument is optional.
asOptionalWithDefault(String) - Method in class cloud.commandframework.arguments.CommandArgument.TypedBuilder
Indicates that the argument is optional.
asRequired() - Method in class cloud.commandframework.arguments.CommandArgument.Builder
Indicates that the argument is required.
asRequired() - Method in class cloud.commandframework.arguments.CommandArgument.TypedBuilder
Indicates that the argument is required.
AsynchronousCommandExecutionCoordinator<C> - Class in cloud.commandframework.execution
Execution coordinator parses and/or executes commands on a separate thread from the calling thread
AsynchronousCommandExecutionCoordinator.Builder<C> - Class in cloud.commandframework.execution

B

BEFORE_REGISTRATION - Enum constant in enum cloud.commandframework.CommandManager.RegistrationState
The point when no commands have been registered yet.
BooleanArgument<C> - Class in cloud.commandframework.arguments.standard
 
BooleanArgument.BooleanParseException - Exception in cloud.commandframework.arguments.standard
Boolean parse exception
BooleanArgument.BooleanParser<C> - Class in cloud.commandframework.arguments.standard
 
BooleanArgument.Builder<C> - Class in cloud.commandframework.arguments.standard
 
BooleanParseException(String, boolean, CommandContext<?>) - Constructor for exception cloud.commandframework.arguments.standard.BooleanArgument.BooleanParseException
Construct a new boolean parse exception
BooleanParser(boolean) - Constructor for class cloud.commandframework.arguments.standard.BooleanArgument.BooleanParser
Construct a new boolean parser
build() - Method in class cloud.commandframework.arguments.CommandArgument.Builder
Construct a command argument from the builder settings
build() - Method in class cloud.commandframework.arguments.flags.CommandFlag.Builder
Build a new command flag instance
build() - Method in class cloud.commandframework.arguments.standard.BooleanArgument.Builder
Builder a new boolean argument
build() - Method in class cloud.commandframework.arguments.standard.ByteArgument.Builder
Builder a new byte argument
build() - Method in class cloud.commandframework.arguments.standard.CharArgument.Builder
Builder a new char argument
build() - Method in class cloud.commandframework.arguments.standard.DoubleArgument.Builder
Builder a new double argument
build() - Method in class cloud.commandframework.arguments.standard.EnumArgument.Builder
 
build() - Method in class cloud.commandframework.arguments.standard.FloatArgument.Builder
 
build() - Method in class cloud.commandframework.arguments.standard.IntegerArgument.Builder
 
build() - Method in class cloud.commandframework.arguments.standard.LongArgument.Builder
 
build() - Method in class cloud.commandframework.arguments.standard.ShortArgument.Builder
 
build() - Method in class cloud.commandframework.arguments.standard.StringArgument.Builder
Builder a new string argument
build() - Method in class cloud.commandframework.arguments.standard.UUIDArgument.Builder
Builder a new example component
build() - Method in class cloud.commandframework.Command.Builder
Build a command using the builder instance
build() - Method in class cloud.commandframework.execution.AsynchronousCommandExecutionCoordinator.Builder
Builder a function that generates a command execution coordinator using the options specified in this builder
build() - Method in class cloud.commandframework.meta.SimpleCommandMeta.Builder
Construct a new meta instance
builder() - Static method in class cloud.commandframework.meta.SimpleCommandMeta
Create a new meta builder
Builder(TypeToken<T>, String) - Constructor for class cloud.commandframework.arguments.CommandArgument.Builder
 
Builder(Class<T>, String) - Constructor for class cloud.commandframework.arguments.CommandArgument.Builder
 
ByteArgument<C> - Class in cloud.commandframework.arguments.standard
 
ByteArgument.Builder<C> - Class in cloud.commandframework.arguments.standard
 
ByteArgument.ByteParseException - Exception in cloud.commandframework.arguments.standard
Byte parse exception
ByteArgument.ByteParser<C> - Class in cloud.commandframework.arguments.standard
 
ByteParseException(String, byte, byte, CommandContext<?>) - Constructor for exception cloud.commandframework.arguments.standard.ByteArgument.ByteParseException
ByteParseException(String, ByteArgument.ByteParser<?>, CommandContext<?>) - Constructor for exception cloud.commandframework.arguments.standard.ByteArgument.ByteParseException
ByteParser(byte, byte) - Constructor for class cloud.commandframework.arguments.standard.ByteArgument.ByteParser
Construct a new byte parser

C

Caption - Class in cloud.commandframework.captions
This is a reference to a caption and does not contain any message itself
CaptionRegistry<C> - Interface in cloud.commandframework.captions
Registry that allows for messages to be configurable per-sender
CaptionVariable - Class in cloud.commandframework.captions
Key-value pair used to replace variables in captions
CaptionVariableReplacementHandler - Interface in cloud.commandframework.captions
Utility that replaces variables in captions
captionVariables() - Method in exception cloud.commandframework.exceptions.parsing.ParserException
Get a copy of the caption variables present in this parser exception.
CharacterParser() - Constructor for class cloud.commandframework.arguments.standard.CharArgument.CharacterParser
 
CharArgument<C> - Class in cloud.commandframework.arguments.standard
 
CharArgument.Builder<C> - Class in cloud.commandframework.arguments.standard
 
CharArgument.CharacterParser<C> - Class in cloud.commandframework.arguments.standard
 
CharArgument.CharParseException - Exception in cloud.commandframework.arguments.standard
Char parse exception
CharParseException(String, CommandContext<?>) - Constructor for exception cloud.commandframework.arguments.standard.CharArgument.CharParseException
Construct a new Char parse exception
cloud.commandframework - package cloud.commandframework
cloud API main package
cloud.commandframework.annotations - package cloud.commandframework.annotations
Annotation and annotation parsing related classes and utilities
cloud.commandframework.annotations.injection - package cloud.commandframework.annotations.injection
Classes related to parameter injection This package will be moved in a future release
cloud.commandframework.annotations.specifier - package cloud.commandframework.annotations.specifier
Standard annotations used to match ArgumentParser in ParserRegistry
cloud.commandframework.arguments - package cloud.commandframework.arguments
Command arguments that are used to build command parsing chains
cloud.commandframework.arguments.compound - package cloud.commandframework.arguments.compound
Argument types that consists of 2 or more sub-types
cloud.commandframework.arguments.flags - package cloud.commandframework.arguments.flags
Cloud flag system
cloud.commandframework.arguments.parser - package cloud.commandframework.arguments.parser
Parser classes used to parse CommandArgument
cloud.commandframework.arguments.preprocessor - package cloud.commandframework.arguments.preprocessor
Pre-made argument preprocessors
cloud.commandframework.arguments.standard - package cloud.commandframework.arguments.standard
Standard command argument types
cloud.commandframework.captions - package cloud.commandframework.captions
Classes allowing for the configuration of messages.
cloud.commandframework.context - package cloud.commandframework.context
Command context stores values for a command sender before and during command execution and parsing
cloud.commandframework.exceptions - package cloud.commandframework.exceptions
cloud related exceptions
cloud.commandframework.exceptions.parsing - package cloud.commandframework.exceptions.parsing
Parsing related exceptions
cloud.commandframework.execution - package cloud.commandframework.execution
Classes related to command execution and execution coordination
cloud.commandframework.execution.postprocessor - package cloud.commandframework.execution.postprocessor
Command postprocessing system
cloud.commandframework.execution.preprocessor - package cloud.commandframework.execution.preprocessor
Command preprocessing system
cloud.commandframework.extra.confirmation - package cloud.commandframework.extra.confirmation
Confirmation system
cloud.commandframework.internal - package cloud.commandframework.internal
Classes that should be used internally in command managers
cloud.commandframework.keys - package cloud.commandframework.keys
Type-safe named keys.
cloud.commandframework.meta - package cloud.commandframework.meta
Command meta are classes associated with commands that store arbitrary data
cloud.commandframework.permission - package cloud.commandframework.permission
Command permissions
cloud.commandframework.types.tuples - package cloud.commandframework.types.tuples
Generic immutable n-tuples with non-null values for 1 < n ≥ 6
cloud.commandframework.util - package cloud.commandframework.util
Utility classes
CloudKey<T> - Interface in cloud.commandframework.keys
A typed, named key
CloudKeyHolder<T> - Interface in cloud.commandframework.keys
Represents any object that holds a CloudKey
command(Command.Builder<C>) - Method in class cloud.commandframework.CommandManager
Register a new command
command(Command<C>) - Method in class cloud.commandframework.CommandManager
Register a new command to the command manager and insert it into the underlying command tree.
Command<C> - Class in cloud.commandframework
A command consists out of a chain of command arguments.
Command(List<CommandComponent<C>>, CommandExecutionHandler<C>, CommandPermission, CommandMeta) - Constructor for class cloud.commandframework.Command
Construct a new command
Command(List<CommandComponent<C>>, CommandExecutionHandler<C>, Class<? extends C>, CommandMeta) - Constructor for class cloud.commandframework.Command
Construct a new command
Command(List<CommandComponent<C>>, CommandExecutionHandler<C>, Class<? extends C>, CommandPermission, CommandMeta) - Constructor for class cloud.commandframework.Command
Construct a new command
Command(Map<CommandArgument<C, ?>, Description>, CommandExecutionHandler<C>, CommandPermission, CommandMeta) - Constructor for class cloud.commandframework.Command
Deprecated.
Map does not allow for the same literal or variable argument name to repeat
Command(Map<CommandArgument<C, ?>, Description>, CommandExecutionHandler<C>, Class<? extends C>, CommandMeta) - Constructor for class cloud.commandframework.Command
Deprecated.
Map does not allow for the same literal or variable argument name to repeat
Command(Map<CommandArgument<C, ?>, Description>, CommandExecutionHandler<C>, Class<? extends C>, CommandPermission, CommandMeta) - Constructor for class cloud.commandframework.Command
Deprecated.
Map does not allow for the same literal or variable argument name to repeat
Command.Builder<C> - Class in cloud.commandframework
Builder for Command instances.
CommandArgument<C,T> - Class in cloud.commandframework.arguments
A argument that belongs to a command
CommandArgument(boolean, String, ArgumentParser<C, T>, Class<T>) - Constructor for class cloud.commandframework.arguments.CommandArgument
Construct a new command argument
CommandArgument(boolean, String, ArgumentParser<C, T>, String, TypeToken<T>, BiFunction<CommandContext<C>, String, List<String>>) - Constructor for class cloud.commandframework.arguments.CommandArgument
Construct a new command argument
CommandArgument(boolean, String, ArgumentParser<C, T>, String, TypeToken<T>, BiFunction<CommandContext<C>, String, List<String>>, ArgumentDescription) - Constructor for class cloud.commandframework.arguments.CommandArgument
Construct a new command argument
CommandArgument(boolean, String, ArgumentParser<C, T>, String, TypeToken<T>, BiFunction<CommandContext<C>, String, List<String>>, ArgumentDescription, Collection<BiFunction<CommandContext<C>, Queue<String>, ArgumentParseResult<Boolean>>>) - Constructor for class cloud.commandframework.arguments.CommandArgument
Construct a new command argument
CommandArgument(boolean, String, ArgumentParser<C, T>, String, TypeToken<T>, BiFunction<CommandContext<C>, String, List<String>>, Collection<BiFunction<CommandContext<C>, Queue<String>, ArgumentParseResult<Boolean>>>) - Constructor for class cloud.commandframework.arguments.CommandArgument
Construct a new command argument
CommandArgument(boolean, String, ArgumentParser<C, T>, String, Class<T>, BiFunction<CommandContext<C>, String, List<String>>) - Constructor for class cloud.commandframework.arguments.CommandArgument
Construct a new command argument
CommandArgument(boolean, String, ArgumentParser<C, T>, String, Class<T>, BiFunction<CommandContext<C>, String, List<String>>, ArgumentDescription) - Constructor for class cloud.commandframework.arguments.CommandArgument
Construct a new command argument
CommandArgument.Builder<C,T> - Class in cloud.commandframework.arguments
Mutable builder for CommandArgument instances
CommandArgument.TypedBuilder<C,T,B extends CommandArgument.Builder<C,T>> - Class in cloud.commandframework.arguments
A variant of builders designed for subclassing, that returns a self type.
commandBuilder(String, ArgumentDescription, String...) - Method in class cloud.commandframework.CommandManager
Create a new command builder using default command meta created by CommandManager.createDefaultCommandMeta().
commandBuilder(String, Description, String...) - Method in class cloud.commandframework.CommandManager
Deprecated.
commandBuilder(String, CommandMeta, ArgumentDescription, String...) - Method in class cloud.commandframework.CommandManager
Create a new command builder.
commandBuilder(String, CommandMeta, Description, String...) - Method in class cloud.commandframework.CommandManager
commandBuilder(String, CommandMeta, String...) - Method in class cloud.commandframework.CommandManager
Create a new command builder with an empty description.
commandBuilder(String, String...) - Method in class cloud.commandframework.CommandManager
Create a new command builder using default command meta created by CommandManager.createDefaultCommandMeta(), and an empty description.
commandBuilder(String, Collection<String>, ArgumentDescription, CommandMeta) - Method in class cloud.commandframework.CommandManager
Create a new command builder.
commandBuilder(String, Collection<String>, Description, CommandMeta) - Method in class cloud.commandframework.CommandManager
Deprecated.
commandBuilder(String, Collection<String>, CommandMeta) - Method in class cloud.commandframework.CommandManager
Create a new command builder with an empty description.
CommandComponent<C> - Class in cloud.commandframework
A single literal or argument component of a command
CommandConfirmationManager<C> - Class in cloud.commandframework.extra.confirmation
Manager for the command confirmation system that enables the ability to add "confirmation" requirements to commands, such that they need to be confirmed in order to be executed.
CommandConfirmationManager(long, TimeUnit, Consumer<CommandPostprocessingContext<C>>, Consumer<C>) - Constructor for class cloud.commandframework.extra.confirmation.CommandConfirmationManager
Create a new confirmation manager instance
CommandContext<C> - Class in cloud.commandframework.context
Command context used to assist in the parsing of commands
CommandContext(boolean, C, CaptionRegistry<C>) - Constructor for class cloud.commandframework.context.CommandContext
Deprecated.
Provide a command manager instead of a caption registry
CommandContext(boolean, C, CommandManager<C>) - Constructor for class cloud.commandframework.context.CommandContext
Create a new command context instance
CommandContext(C, CaptionRegistry<C>) - Constructor for class cloud.commandframework.context.CommandContext
Deprecated.
Provide a command manager instead of a caption registry
CommandContext(C, CommandManager<C>) - Constructor for class cloud.commandframework.context.CommandContext
Create a new command context instance
CommandContext.ArgumentTiming - Class in cloud.commandframework.context
Used to track performance metrics related to command parsing.
CommandContextFactory<C> - Interface in cloud.commandframework.context
Factory for CommandContext instances
commandExecutionCoordinator() - Method in class cloud.commandframework.CommandManager
Returns the command execution coordinator used in this manager
CommandExecutionCoordinator<C> - Class in cloud.commandframework.execution
The command execution coordinator is responsible for coordinating command execution.
CommandExecutionCoordinator(CommandTree<C>) - Constructor for class cloud.commandframework.execution.CommandExecutionCoordinator
Construct a new command execution coordinator
CommandExecutionCoordinator.SimpleCoordinator<C> - Class in cloud.commandframework.execution
A simple command execution coordinator that executes all commands immediately, on the calling thread
CommandExecutionException - Exception in cloud.commandframework.exceptions
Exception thrown when there is an exception during execution of a command handler
CommandExecutionException(Throwable) - Constructor for exception cloud.commandframework.exceptions.CommandExecutionException
Exception thrown when there is an exception during execution of a command handler
CommandExecutionException(Throwable, CommandContext<?>) - Constructor for exception cloud.commandframework.exceptions.CommandExecutionException
Exception thrown when there is an exception during execution of a command handler
CommandExecutionHandler<C> - Interface in cloud.commandframework.execution
Handler that is invoked whenever a Command is executed by a command sender
CommandExecutionHandler.FutureCommandExecutionHandler<C> - Interface in cloud.commandframework.execution
Handler that is invoked whenever a Command is executed by a command sender
CommandExecutionHandler.NullCommandExecutionHandler<C> - Class in cloud.commandframework.execution
Command execution handler that does nothing
CommandFlag<T> - Class in cloud.commandframework.arguments.flags
A flag is an optional command argument that may have an associated parser, and is identified by its name.
CommandFlag.Builder<T> - Class in cloud.commandframework.arguments.flags
 
CommandHelpHandler<C> - Class in cloud.commandframework
 
CommandHelpHandler.HelpTopic<C> - Interface in cloud.commandframework
Something that can be returned as the result of a help query
CommandHelpHandler.IndexHelpTopic<C> - Class in cloud.commandframework
Index of available commands
CommandHelpHandler.MultiHelpTopic<C> - Class in cloud.commandframework
Help topic with multiple semi-verbose command descriptions
CommandHelpHandler.VerboseHelpEntry<C> - Class in cloud.commandframework
 
CommandHelpHandler.VerboseHelpTopic<C> - Class in cloud.commandframework
Verbose information about a specific Command
CommandInputTokenizer - Class in cloud.commandframework.internal
Tokenizer that splits command inputs into tokens.
CommandInputTokenizer(String) - Constructor for class cloud.commandframework.internal.CommandInputTokenizer
Create a new input tokenizer
CommandManager<C> - Class in cloud.commandframework
The manager is responsible for command registration, parsing delegation, etc.
CommandManager(Function<CommandTree<C>, CommandExecutionCoordinator<C>>, CommandRegistrationHandler) - Constructor for class cloud.commandframework.CommandManager
Create a new command manager instance
CommandManager.ManagerSettings - Enum in cloud.commandframework
Configurable command related settings
CommandManager.RegistrationState - Enum in cloud.commandframework
The point in the registration lifecycle for this commands manager
CommandMeta - Class in cloud.commandframework.meta
Object that is associated with a Command.
CommandMeta() - Constructor for class cloud.commandframework.meta.CommandMeta
 
CommandMeta.Key<V> - Interface in cloud.commandframework.meta
A key into the metadata map.
CommandParseException - Exception in cloud.commandframework.exceptions
Exception thrown when parsing user input into a command
CommandParseException(Object, List<CommandArgument<?, ?>>) - Constructor for exception cloud.commandframework.exceptions.CommandParseException
Construct a new command parse exception
commandPermission() - Method in class cloud.commandframework.Command.Builder
Get the required command permission for this builder
CommandPermission - Interface in cloud.commandframework.permission
A command permission representation.
CommandPostprocessingContext<C> - Class in cloud.commandframework.execution.postprocessor
CommandPostprocessingContext(CommandContext<C>, Command<C>) - Constructor for class cloud.commandframework.execution.postprocessor.CommandPostprocessingContext
Construct a new command postprocessing context
CommandPostprocessor<C> - Interface in cloud.commandframework.execution.postprocessor
Command postprocessor that acts on commands before execution
CommandPreprocessingContext<C> - Class in cloud.commandframework.execution.preprocessor
CommandPreprocessingContext(CommandContext<C>, LinkedList<String>) - Constructor for class cloud.commandframework.execution.preprocessor.CommandPreprocessingContext
Construct a new command preprocessing context
CommandPreprocessor<C> - Interface in cloud.commandframework.execution.preprocessor
Command preprocessor that gets to act on command input before it's sent to the command parser.
CommandRegistrationHandler - Interface in cloud.commandframework.internal
Utility that registers commands natively for whatever platform the library is used in.
CommandRegistrationHandler.NullCommandRegistrationHandler - Class in cloud.commandframework.internal
 
CommandResult<C> - Class in cloud.commandframework.execution
The result of a command execution
CommandResult(CommandContext<C>) - Constructor for class cloud.commandframework.execution.CommandResult
Construct a new command result instance
CommandSuggestionEngine<C> - Interface in cloud.commandframework.arguments
Handler that produces command suggestions depending on input
CommandSuggestionProcessor<C> - Interface in cloud.commandframework.execution
Processor that formats command suggestions
CommandSyntaxFormatter<C> - Interface in cloud.commandframework.arguments
Utility that formats chains of command arguments into syntax strings
CommandTree<C> - Class in cloud.commandframework
Tree containing all commands and command paths.
CommandTree.Node<T> - Class in cloud.commandframework
Very simple tree structure
compareTo(CommandArgument<?, ?>) - Method in class cloud.commandframework.arguments.CommandArgument
 
Completions - Annotation Type in cloud.commandframework.annotations.specifier
Command completions, separated by "," or ", "
COMPLETIONS - Static variable in class cloud.commandframework.arguments.parser.StandardParameters
Command completions
CompoundArgument<T extends Tuple,C,O> - Class in cloud.commandframework.arguments.compound
Compound argument
CompoundArgument(boolean, String, Tuple, Tuple, Tuple, BiFunction<C, T, O>, Function<Object[], T>, TypeToken<O>) - Constructor for class cloud.commandframework.arguments.compound.CompoundArgument
Construct a Compound Argument
CONFIRMATION - Static variable in class cloud.commandframework.arguments.parser.StandardParameters
Command confirmation
CONFIRMATION_REQUIRED_META - Static variable in class cloud.commandframework.extra.confirmation.CommandConfirmationManager
Deprecated.
for removal since 1.3.0. Use CommandConfirmationManager.META_CONFIRMATION_REQUIRED instead.
contains(CommandFlag<?>) - Method in class cloud.commandframework.arguments.flags.FlagContext
Check whether a flag is present.
contains(CloudKey<?>) - Method in class cloud.commandframework.context.CommandContext
Check if the context has a value stored for a key
contains(String) - Method in class cloud.commandframework.arguments.flags.FlagContext
Check whether a flag is present.
contains(String) - Method in class cloud.commandframework.context.CommandContext
Check if the context has a value stored for a key
coordinateExecution(CommandContext<C>, Queue<String>) - Method in class cloud.commandframework.execution.AsynchronousCommandExecutionCoordinator
 
coordinateExecution(CommandContext<C>, Queue<String>) - Method in class cloud.commandframework.execution.CommandExecutionCoordinator
Coordinate the execution of a command and return the result
coordinateExecution(CommandContext<C>, Queue<String>) - Method in class cloud.commandframework.execution.CommandExecutionCoordinator.SimpleCoordinator
 
copy() - Method in class cloud.commandframework.arguments.CommandArgument
Create a copy of the command argument
countCharOccurrences(String, char) - Static method in class cloud.commandframework.util.StringUtils
Count the occurrences of a character in a string
create() - Method in class cloud.commandframework.arguments.DelegatingCommandSuggestionEngineFactory
Create the engine instance
create() - Static method in class cloud.commandframework.arguments.flags.FlagContext
Create a new flag context instance
create() - Method in class cloud.commandframework.captions.SimpleCaptionRegistryFactory
Create a new simple caption registry instance
create(boolean, C, CaptionRegistry<C>) - Method in interface cloud.commandframework.context.CommandContextFactory
Deprecated.
Provide a command manager instead of a caption registry
create(boolean, C, CaptionRegistry<C>) - Method in class cloud.commandframework.context.StandardCommandContextFactory
 
create(boolean, C, CommandManager<C>) - Method in interface cloud.commandframework.context.CommandContextFactory
Create a new command context
create(boolean, C, CommandManager<C>) - Method in class cloud.commandframework.context.StandardCommandContextFactory
 
create(CommandContext<C>, AnnotationAccessor) - Method in interface cloud.commandframework.annotations.injection.ParameterInjector
Attempt to create a a value that should then be injected into the CommandMethod annotated method.
create(Injector) - Static method in class cloud.commandframework.annotations.injection.GuiceInjectionService
Create a new Guice injection service that wraps the given injector
createConfirmationExecutionHandler() - Method in class cloud.commandframework.extra.confirmation.CommandConfirmationManager
Create an execution handler for a confirmation command
createDefaultCommandMeta() - Method in class cloud.commandframework.CommandManager
Construct a default command meta instance
createInstance() - Method in class cloud.commandframework.arguments.StandardCommandSyntaxFormatter
Create a new formatting instance
createParser(TypeToken<T>, ParserParameters) - Method in interface cloud.commandframework.arguments.parser.ParserRegistry
Attempt to create a ArgumentParser for a specified type, using an instance of ParserParameter to configure the parser settings
createParser(TypeToken<T>, ParserParameters) - Method in class cloud.commandframework.arguments.parser.StandardParserRegistry
 
createParser(String, ParserParameters) - Method in interface cloud.commandframework.arguments.parser.ParserRegistry
Attempt to create a ArgumentParser for a specified type, using an instance of ParserParameter to configure the parser settings
createParser(String, ParserParameters) - Method in class cloud.commandframework.arguments.parser.StandardParserRegistry
 
createTiming(CommandArgument<C, ?>) - Method in class cloud.commandframework.context.CommandContext
Create an argument timing for a specific argument

D

decorate(SimpleCommandMeta.Builder) - Method in class cloud.commandframework.extra.confirmation.CommandConfirmationManager
Decorate a simple command meta builder, to require confirmation for a command
DEFAULT_ARGUMENT_COUNT - Static variable in interface cloud.commandframework.arguments.parser.ArgumentParser
Default amount of arguments that the parser expects to consume
DEFAULT_MAXIMUM - Static variable in class cloud.commandframework.arguments.standard.ByteArgument.ByteParser
Constant for the default/unset maximum value.
DEFAULT_MAXIMUM - Static variable in class cloud.commandframework.arguments.standard.DoubleArgument.DoubleParser
Constant for the default/unset maximum value.
DEFAULT_MAXIMUM - Static variable in class cloud.commandframework.arguments.standard.FloatArgument.FloatParser
Constant for the default/unset maximum value.
DEFAULT_MAXIMUM - Static variable in class cloud.commandframework.arguments.standard.IntegerArgument.IntegerParser
Constant for the default/unset maximum value.
DEFAULT_MAXIMUM - Static variable in class cloud.commandframework.arguments.standard.LongArgument.LongParser
Constant for the default/unset maximum value.
DEFAULT_MAXIMUM - Static variable in class cloud.commandframework.arguments.standard.ShortArgument.ShortParser
Constant for the default/unset maximum value.
DEFAULT_MINIMUM - Static variable in class cloud.commandframework.arguments.standard.ByteArgument.ByteParser
Constant for the default/unset minimum value.
DEFAULT_MINIMUM - Static variable in class cloud.commandframework.arguments.standard.DoubleArgument.DoubleParser
Constant for the default/unset minimum value.
DEFAULT_MINIMUM - Static variable in class cloud.commandframework.arguments.standard.FloatArgument.FloatParser
Constant for the default/unset minimum value.
DEFAULT_MINIMUM - Static variable in class cloud.commandframework.arguments.standard.IntegerArgument.IntegerParser
Constant for the default/unset minimum value.
DEFAULT_MINIMUM - Static variable in class cloud.commandframework.arguments.standard.LongArgument.LongParser
Constant for the default/unset minimum value.
DEFAULT_MINIMUM - Static variable in class cloud.commandframework.arguments.standard.ShortArgument.ShortParser
Constant for the default/unset minimum value.
DelegatingCommandSuggestionEngine<C> - Class in cloud.commandframework.arguments
Command suggestion engine that delegates to a CommandTree
DelegatingCommandSuggestionEngineFactory<C> - Class in cloud.commandframework.arguments
Factory that produces DelegatingCommandSuggestionEngine instances
DelegatingCommandSuggestionEngineFactory(CommandManager<C>) - Constructor for class cloud.commandframework.arguments.DelegatingCommandSuggestionEngineFactory
Create a new delegating command suggestion engine factory
Description - Class in cloud.commandframework
Deprecated.
to become package-private since 1.4.0. Use ArgumentDescription instead.
DESCRIPTION - Static variable in class cloud.commandframework.arguments.parser.StandardParameters
Command description
DESCRIPTION - Static variable in class cloud.commandframework.meta.CommandMeta
 
DoubleArgument<C> - Class in cloud.commandframework.arguments.standard
 
DoubleArgument.Builder<C> - Class in cloud.commandframework.arguments.standard
 
DoubleArgument.DoubleParseException - Exception in cloud.commandframework.arguments.standard
 
DoubleArgument.DoubleParser<C> - Class in cloud.commandframework.arguments.standard
 
DoubleParseException(String, double, double, CommandContext<?>) - Constructor for exception cloud.commandframework.arguments.standard.DoubleArgument.DoubleParseException
DoubleParseException(String, DoubleArgument.DoubleParser<?>, CommandContext<?>) - Constructor for exception cloud.commandframework.arguments.standard.DoubleArgument.DoubleParseException
DoubleParser(double, double) - Constructor for class cloud.commandframework.arguments.standard.DoubleArgument.DoubleParser
Construct a new double parser
DUPLICATE_FLAG - Enum constant in enum cloud.commandframework.arguments.compound.FlagArgument.FailureReason
 
DynamicTuple - Class in cloud.commandframework.types.tuples
Dynamic sized tuple backed by a Object[]

E

empty() - Static method in interface cloud.commandframework.annotations.AnnotationAccessor
Get a AnnotationAccessor that cannot access any annotations
empty() - Static method in interface cloud.commandframework.ArgumentDescription
Get an empty command description.
empty() - Static method in class cloud.commandframework.arguments.parser.ParserParameters
Get an empty ParserParameters instance
empty() - Static method in class cloud.commandframework.Description
Deprecated.
for removal since 1.4.0. See ArgumentDescription.empty()
empty() - Static method in class cloud.commandframework.meta.SimpleCommandMeta
Create an empty simple command meta instance
empty() - Static method in class cloud.commandframework.permission.Permission
Get an empty command permission
ENFORCE_INTERMEDIARY_PERMISSIONS - Enum constant in enum cloud.commandframework.CommandManager.ManagerSettings
Do not create a compound permission and do not look greedily for child permission values, if a preceding command in the tree path has a command handler attached
EnumArgument<C,E extends Enum<E>> - Class in cloud.commandframework.arguments.standard
Argument type that recognizes enums
EnumArgument(Class<E>, boolean, String, String, BiFunction<CommandContext<C>, String, List<String>>, ArgumentDescription) - Constructor for class cloud.commandframework.arguments.standard.EnumArgument
 
EnumArgument.Builder<C,E extends Enum<E>> - Class in cloud.commandframework.arguments.standard
 
EnumArgument.EnumParseException - Exception in cloud.commandframework.arguments.standard
 
EnumArgument.EnumParser<C,E extends Enum<E>> - Class in cloud.commandframework.arguments.standard
 
EnumParseException(String, Class<? extends Enum<?>>, CommandContext<?>) - Constructor for exception cloud.commandframework.arguments.standard.EnumArgument.EnumParseException
Construct a new enum parse exception
EnumParser(Class<E>) - Constructor for class cloud.commandframework.arguments.standard.EnumArgument.EnumParser
Construct a new enum parser
equals(Object) - Method in class cloud.commandframework.arguments.parser.MappedArgumentParser
 
equals(Object) - Method in class cloud.commandframework.arguments.CommandArgument
 
equals(Object) - Method in class cloud.commandframework.arguments.flags.CommandFlag
 
equals(Object) - Method in class cloud.commandframework.arguments.parser.ParserParameter
 
equals(Object) - Method in class cloud.commandframework.captions.Caption
 
equals(Object) - Method in class cloud.commandframework.CommandComponent
 
equals(Object) - Method in class cloud.commandframework.CommandTree.Node
 
equals(Object) - Method in class cloud.commandframework.execution.postprocessor.CommandPostprocessingContext
 
equals(Object) - Method in class cloud.commandframework.execution.preprocessor.CommandPreprocessingContext
 
equals(Object) - Method in class cloud.commandframework.keys.SimpleCloudKey
 
equals(Object) - Method in class cloud.commandframework.meta.SimpleCommandMeta
 
equals(Object) - Method in class cloud.commandframework.permission.AndPermission
 
equals(Object) - Method in class cloud.commandframework.permission.OrPermission
 
equals(Object) - Method in class cloud.commandframework.permission.Permission
 
equals(Object) - Method in class cloud.commandframework.types.tuples.Pair
 
equals(Object) - Method in class cloud.commandframework.types.tuples.Quartet
 
equals(Object) - Method in class cloud.commandframework.types.tuples.Quintet
 
equals(Object) - Method in class cloud.commandframework.types.tuples.Sextet
 
equals(Object) - Method in class cloud.commandframework.types.tuples.Triplet
 
errorCaption() - Method in exception cloud.commandframework.exceptions.parsing.ParserException
Get the error caption for this parser exception
execute(CommandContext<C>) - Method in interface cloud.commandframework.execution.CommandExecutionHandler
Handle command execution
execute(CommandContext<C>) - Method in interface cloud.commandframework.execution.CommandExecutionHandler.FutureCommandExecutionHandler
 
execute(CommandContext<C>) - Method in class cloud.commandframework.execution.CommandExecutionHandler.NullCommandExecutionHandler
 
executeCommand(C, String) - Method in class cloud.commandframework.CommandManager
Execute a command and get a future that completes with the result.
executeFuture(CommandContext<C>) - Method in interface cloud.commandframework.execution.CommandExecutionHandler
Handle command execution
executeFuture(CommandContext<C>) - Method in interface cloud.commandframework.execution.CommandExecutionHandler.FutureCommandExecutionHandler
 

F

FactoryDelegatingCaptionRegistry<C> - Interface in cloud.commandframework.captions
Caption registry that delegates to factory methods
failure(Throwable) - Static method in class cloud.commandframework.arguments.parser.ArgumentParseResult
Indicate that the parsing failed
fillInStackTrace() - Method in exception cloud.commandframework.exceptions.NoPermissionException
 
fillInStackTrace() - Method in exception cloud.commandframework.exceptions.NoSuchCommandException
 
FilteringCommandSuggestionProcessor<C> - Class in cloud.commandframework.execution
Command suggestions processor that checks the input queue head and filters based on that
FilteringCommandSuggestionProcessor() - Constructor for class cloud.commandframework.execution.FilteringCommandSuggestionProcessor
 
flag(CommandFlag.Builder<T>) - Method in class cloud.commandframework.Command.Builder
Register a new command flag
flag(CommandFlag<T>) - Method in class cloud.commandframework.Command.Builder
Register a new command flag
FLAG_META - Static variable in class cloud.commandframework.arguments.compound.FlagArgument
Deprecated.
FLAG_META_KEY - Static variable in class cloud.commandframework.arguments.compound.FlagArgument
Meta data for the last argument that was suggested
FLAG_PARSE_RESULT_OBJECT - Static variable in class cloud.commandframework.arguments.compound.FlagArgument
Dummy object that indicates that flags were parsed successfully
FLAG_PRESENCE_VALUE - Static variable in class cloud.commandframework.arguments.flags.FlagContext
Dummy object stored as a flag value when the flag has no associated parser
FlagArgument<C> - Class in cloud.commandframework.arguments.compound
Container for flag parsing logic.
FlagArgument(Collection<CommandFlag<?>>) - Constructor for class cloud.commandframework.arguments.compound.FlagArgument
Construct a new flag argument
FlagArgument.FailureReason - Enum in cloud.commandframework.arguments.compound
Reasons for which flag parsing may fail
FlagArgument.FlagArgumentParser<C> - Class in cloud.commandframework.arguments.compound
 
FlagArgument.FlagParseException - Exception in cloud.commandframework.arguments.compound
Flag parse exception
flagBuilder(String) - Method in class cloud.commandframework.CommandManager
Create a new command flag builder
FlagContext - Class in cloud.commandframework.arguments.flags
Flag value mappings
FlagParseException(String, FlagArgument.FailureReason, CommandContext<?>) - Constructor for exception cloud.commandframework.arguments.compound.FlagArgument.FlagParseException
Construct a new flag parse exception
flags() - Method in class cloud.commandframework.context.CommandContext
Get the associated FlagContext instance
flatMapParsedValue(Function<T, ArgumentParseResult<U>>) - Method in class cloud.commandframework.arguments.parser.ArgumentParseResult
If this result is successful, transform the output value, returning another parse result.
FloatArgument<C> - Class in cloud.commandframework.arguments.standard
 
FloatArgument.Builder<C> - Class in cloud.commandframework.arguments.standard
 
FloatArgument.FloatParseException - Exception in cloud.commandframework.arguments.standard
 
FloatArgument.FloatParser<C> - Class in cloud.commandframework.arguments.standard
 
FloatParseException(String, float, float, CommandContext<?>) - Constructor for exception cloud.commandframework.arguments.standard.FloatArgument.FloatParseException
FloatParseException(String, FloatArgument.FloatParser<?>, CommandContext<?>) - Constructor for exception cloud.commandframework.arguments.standard.FloatArgument.FloatParseException
FloatParser(float, float) - Constructor for class cloud.commandframework.arguments.standard.FloatArgument.FloatParser
Construct a new float parser
FORCE_SUGGESTION - Enum constant in enum cloud.commandframework.CommandManager.ManagerSettings
Force sending of an empty suggestion (i.e.
formatMessage(Caption, CaptionVariable...) - Method in class cloud.commandframework.context.CommandContext
Format a caption
FormattingInstance() - Constructor for class cloud.commandframework.arguments.StandardCommandSyntaxFormatter.FormattingInstance
Create a new formatting instance

G

get(CommandArgument<C, T>) - Method in class cloud.commandframework.context.CommandContext
Get a required argument from the context.
get(CommandFlag<T>) - Method in class cloud.commandframework.arguments.flags.FlagContext
Get a flag value
get(ParserParameter<T>, T) - Method in class cloud.commandframework.arguments.parser.ParserParameters
Get a value from the parameter map, if it is stored, else return a default value
get(CloudKey<T>) - Method in class cloud.commandframework.context.CommandContext
Get a required argument from the context.
get(CloudKeyHolder<T>) - Method in class cloud.commandframework.context.CommandContext
Get a required argument from the context.
get(CommandMeta.Key<V>) - Method in class cloud.commandframework.meta.CommandMeta
Get the value associated with a key.
get(CommandMeta.Key<V>) - Method in class cloud.commandframework.meta.SimpleCommandMeta
 
get(String) - Method in class cloud.commandframework.arguments.flags.FlagContext
Get a flag value
get(String) - Method in class cloud.commandframework.context.CommandContext
Get a required argument from the context.
getAliases() - Method in class cloud.commandframework.arguments.flags.CommandFlag
Get all flag aliases.
getAliases() - Method in class cloud.commandframework.arguments.StaticArgument
Get an immutable view of the aliases
getAll() - Method in class cloud.commandframework.arguments.parser.ParserParameters
Get an immutable view of the internal map
getAll() - Method in class cloud.commandframework.meta.CommandMeta
Deprecated.
for removal since 1.3.0, use CommandMeta.getAllValues() instead.
getAll() - Method in class cloud.commandframework.meta.SimpleCommandMeta
Deprecated.
getAllCommands() - Method in class cloud.commandframework.CommandHelpHandler
Get exact syntax hints for all commands
getAllValues() - Method in class cloud.commandframework.meta.CommandMeta
Get a copy of the meta map, without type information.
getAllValues() - Method in class cloud.commandframework.meta.SimpleCommandMeta
 
getAlternativeAliases() - Method in class cloud.commandframework.arguments.StaticArgument
Get an immutable list of all aliases that are not the main literal
getAmbiguousNode() - Method in exception cloud.commandframework.exceptions.AmbiguousNodeException
Get the ambiguous node
getArgument() - Method in class cloud.commandframework.CommandComponent
Gets the command component argument details
getArgumentDescription() - Method in class cloud.commandframework.arguments.flags.CommandFlag
Get the flag description.
getArgumentDescription() - Method in class cloud.commandframework.CommandComponent
Gets the command component description
getArgumentDescription(CommandArgument<C, ?>) - Method in class cloud.commandframework.Command
Deprecated.
More than one matching command argument may exist per command. Use Command.getArguments() and search in that, instead.
getArgumentParserClass() - Method in exception cloud.commandframework.exceptions.parsing.ParserException
Get the argument parser
getArguments() - Method in class cloud.commandframework.Command
Return a copy of the command argument array
getArgumentTimings() - Method in class cloud.commandframework.context.CommandContext
Get an immutable view of the argument timings map
getBaseParser() - Method in class cloud.commandframework.arguments.parser.MappedArgumentParser
Get the parser this one is derived from.
getCaption() - Method in enum cloud.commandframework.arguments.compound.FlagArgument.FailureReason
Get the caption used for this failure reason
getCaption(Caption, C) - Method in interface cloud.commandframework.captions.CaptionRegistry
Get a caption for a specific sender
getCaption(Caption, C) - Method in class cloud.commandframework.captions.SimpleCaptionRegistry
 
getCaptionRegistry() - Method in class cloud.commandframework.CommandManager
Get the caption registry
getCause() - Method in exception cloud.commandframework.exceptions.ArgumentParseException
Get the cause of the exception
getChildren() - Method in class cloud.commandframework.CommandTree.Node
Get an immutable copy of the node's child list
getChildren() - Method in exception cloud.commandframework.exceptions.AmbiguousNodeException
Get all children of the parent
getChildSuggestions() - Method in class cloud.commandframework.CommandHelpHandler.MultiHelpTopic
Get syntax hints for the node's children
getCommand() - Method in class cloud.commandframework.CommandHelpHandler.VerboseHelpEntry
Get the command
getCommand() - Method in class cloud.commandframework.CommandHelpHandler.VerboseHelpTopic
Get the command
getCommand() - Method in exception cloud.commandframework.exceptions.InvalidCommandSenderException
Get the Command which the sender is invalid for
getCommand() - Method in class cloud.commandframework.execution.postprocessor.CommandPostprocessingContext
Get the command instance
getCommandArgument() - Method in class cloud.commandframework.arguments.flags.CommandFlag
Get the command argument, if it exists
getCommandArgument() - Method in exception cloud.commandframework.exceptions.NoCommandInLeafException
Get the command argument
getCommandContext() - Method in exception cloud.commandframework.exceptions.CommandExecutionException
Get the CommandContext which led to this exception
getCommandContext() - Method in class cloud.commandframework.execution.CommandResult
Get the command context
getCommandContext() - Method in class cloud.commandframework.execution.postprocessor.CommandPostprocessingContext
Get the command context
getCommandContext() - Method in class cloud.commandframework.execution.preprocessor.CommandPreprocessingContext
Get the command context
getCommandExecutionHandler() - Method in class cloud.commandframework.Command
Get the command execution handler
getCommandHelpHandler() - Method in class cloud.commandframework.CommandManager
Get a command help handler instance.
getCommandHelpHandler(Predicate<Command<C>>) - Method in class cloud.commandframework.CommandManager
Get a command help handler instance.
getCommandManager() - Method in class cloud.commandframework.CommandTree
Get the command manager
getCommandMeta() - Method in class cloud.commandframework.Command
Get the command meta instance
getCommandPermission() - Method in class cloud.commandframework.Command
Get the command permission
getCommandRegistrationHandler() - Method in class cloud.commandframework.CommandManager
Get the command registration handler
getCommands() - Method in class cloud.commandframework.CommandManager
Get a collection containing all registered commands.
getCommandSender() - Method in exception cloud.commandframework.exceptions.CommandParseException
Get the command sender
getCommandSuggestionProcessor() - Method in class cloud.commandframework.CommandManager
Get the command suggestions processor instance currently used in this command manager
getCommandSyntaxFormatter() - Method in class cloud.commandframework.CommandManager
Get the command syntax formatter
getCommandTree() - Method in class cloud.commandframework.CommandManager
Get the internal command tree.
getCommandTree() - Method in class cloud.commandframework.execution.CommandExecutionCoordinator
Get the command tree
getComponents() - Method in class cloud.commandframework.Command
Returns a copy of the command component array
getContext() - Method in exception cloud.commandframework.exceptions.parsing.ParserException
Get the command context
getCorrectSyntax() - Method in exception cloud.commandframework.exceptions.InvalidSyntaxException
Get the correct syntax of the command
getCurrentArgument() - Method in class cloud.commandframework.context.CommandContext
Get the argument that is currently being parsed for this command context.
getCurrentChain() - Method in exception cloud.commandframework.exceptions.CommandParseException
Get the command chain leading up to the exception
getDefaultDescription() - Method in class cloud.commandframework.arguments.CommandArgument.Builder
 
getDefaultDescription() - Method in class cloud.commandframework.arguments.CommandArgument
Get the default description to use when registering and no other is provided.
getDefaultValue() - Method in class cloud.commandframework.arguments.CommandArgument.Builder
 
getDefaultValue() - Method in class cloud.commandframework.arguments.CommandArgument
Get the default value
getDescription() - Method in interface cloud.commandframework.ArgumentDescription
Get the plain-text description.
getDescription() - Method in class cloud.commandframework.arguments.flags.CommandFlag
Deprecated.
for removal since 1.4.0. Use CommandFlag.getArgumentDescription() instead.
getDescription() - Method in class cloud.commandframework.CommandComponent
Deprecated.
for removal since 1.4.0. Use CommandComponent.getArgumentDescription() instead.
getDescription() - Method in class cloud.commandframework.CommandHelpHandler.VerboseHelpEntry
Get the command description
getDescription() - Method in class cloud.commandframework.CommandHelpHandler.VerboseHelpTopic
Get the command description
getDescription() - Method in class cloud.commandframework.Description
Deprecated.
Get the command description
getElapsedTime() - Method in class cloud.commandframework.context.CommandContext.ArgumentTiming
Get the elapsed time
getEntries() - Method in class cloud.commandframework.CommandHelpHandler.IndexHelpTopic
Get help entries
getEnumClass() - Method in exception cloud.commandframework.arguments.standard.EnumArgument.EnumParseException
Get the enum class that was attempted to be parsed
getExceptionHandler(Class<E>) - Method in class cloud.commandframework.CommandManager
Get the exception handler for an exception type, if one has been registered
getExpectedType() - Method in class cloud.commandframework.arguments.parser.ParserParameter
Ge the type that is expected to be mapped to this parameter
getFailedString() - Method in exception cloud.commandframework.arguments.preprocessor.RegexPreprocessor.RegexValidationException
Get the string that failed the verification
getFailure() - Method in class cloud.commandframework.arguments.parser.ArgumentParseResult
Get the failure reason, if it exists
getFallbackDerivation() - Method in interface cloud.commandframework.meta.CommandMeta.Key
Get a function that can be used to compute a fallback based on existing meta.
getFifth() - Method in class cloud.commandframework.types.tuples.Quintet
Get the fifth value
getFifth() - Method in class cloud.commandframework.types.tuples.Sextet
Get the fifth value
getFirst() - Method in class cloud.commandframework.types.tuples.Pair
Get the first value
getFirst() - Method in class cloud.commandframework.types.tuples.Quartet
Get the first value
getFirst() - Method in class cloud.commandframework.types.tuples.Quintet
Get the first value
getFirst() - Method in class cloud.commandframework.types.tuples.Sextet
Get the first value
getFirst() - Method in class cloud.commandframework.types.tuples.Triplet
Get the first value
getFlags() - Method in class cloud.commandframework.arguments.compound.FlagArgument
Get the flags registered in the argument
getFourth() - Method in class cloud.commandframework.types.tuples.Quartet
Get the fourth value
getFourth() - Method in class cloud.commandframework.types.tuples.Quintet
Get the fourth value
getFourth() - Method in class cloud.commandframework.types.tuples.Sextet
Get the fourth value
getInjectable(Class<T>, CommandContext<C>, AnnotationAccessor) - Method in class cloud.commandframework.annotations.injection.ParameterInjectorRegistry
Attempt to get an injectable value for the given context.
getInput() - Method in exception cloud.commandframework.arguments.compound.FlagArgument.FlagParseException
Get the supplied input
getInput() - Method in exception cloud.commandframework.arguments.standard.BooleanArgument.BooleanParseException
Get the supplied input
getInput() - Method in exception cloud.commandframework.arguments.standard.CharArgument.CharParseException
Get the supplied input
getInput() - Method in exception cloud.commandframework.arguments.standard.EnumArgument.EnumParseException
Get the input provided by the sender
getInput() - Method in exception cloud.commandframework.arguments.standard.StringArgument.StringParseException
Get the input provided by the sender
getInput() - Method in exception cloud.commandframework.arguments.standard.UUIDArgument.UUIDParseException
Get the supplied input
getInput() - Method in exception cloud.commandframework.exceptions.parsing.NumberParseException
Get the input that failed to parse
getInputQueue() - Method in class cloud.commandframework.execution.preprocessor.CommandPreprocessingContext
Get the original input queue.
getKey() - Method in class cloud.commandframework.arguments.CommandArgument
 
getKey() - Method in class cloud.commandframework.arguments.parser.ParserParameter
Get the parameter key
getKey() - Method in class cloud.commandframework.captions.Caption
Get the caption key
getKey() - Method in class cloud.commandframework.captions.CaptionVariable
Get the variable key
getKey() - Method in interface cloud.commandframework.keys.CloudKeyHolder
Get the key that identifies this object.
getKey() - Method in interface cloud.commandframework.permission.PredicatePermission
 
getLongestPath() - Method in class cloud.commandframework.CommandHelpHandler.MultiHelpTopic
Get the longest shared path
getLongestSharedChains() - Method in class cloud.commandframework.CommandHelpHandler
Get a list of the longest shared command chains of all commands.
getMax() - Method in class cloud.commandframework.arguments.standard.ByteArgument.ByteParser
Get the max value
getMax() - Method in class cloud.commandframework.arguments.standard.ByteArgument
Get the maximum accepted byteeger that could have been parsed
getMax() - Method in class cloud.commandframework.arguments.standard.DoubleArgument.DoubleParser
Get the max value
getMax() - Method in class cloud.commandframework.arguments.standard.DoubleArgument
Get the maximum accepted double that could have been parsed
getMax() - Method in class cloud.commandframework.arguments.standard.FloatArgument.FloatParser
Get the max value
getMax() - Method in class cloud.commandframework.arguments.standard.FloatArgument
Get the maximum accepted float that could have been parsed
getMax() - Method in class cloud.commandframework.arguments.standard.IntegerArgument
Get the maximum accepted integer that could have been parsed
getMax() - Method in class cloud.commandframework.arguments.standard.IntegerArgument.IntegerParser
Get the maximum value accepted by this parser
getMax() - Method in class cloud.commandframework.arguments.standard.LongArgument
Get the maximum accepted long that could have been parsed
getMax() - Method in class cloud.commandframework.arguments.standard.LongArgument.LongParser
Get the maximum value accepted by this parser
getMax() - Method in class cloud.commandframework.arguments.standard.ShortArgument
Get the maximum accepted short that could have been parsed
getMax() - Method in class cloud.commandframework.arguments.standard.ShortArgument.ShortParser
Get the max value
getMax() - Method in exception cloud.commandframework.exceptions.parsing.NumberParseException
Get the maximum accepted integer that could have been parsed
getMessage() - Method in exception cloud.commandframework.arguments.preprocessor.RegexPreprocessor.RegexValidationException
 
getMessage() - Method in exception cloud.commandframework.exceptions.AmbiguousNodeException
 
getMessage() - Method in exception cloud.commandframework.exceptions.InvalidCommandSenderException
 
getMessage() - Method in exception cloud.commandframework.exceptions.InvalidSyntaxException
 
getMessage() - Method in exception cloud.commandframework.exceptions.NoPermissionException
 
getMessage() - Method in exception cloud.commandframework.exceptions.NoSuchCommandException
 
getMessage() - Method in exception cloud.commandframework.exceptions.parsing.ParserException
 
getMin() - Method in class cloud.commandframework.arguments.standard.ByteArgument.ByteParser
Get the min value
getMin() - Method in class cloud.commandframework.arguments.standard.ByteArgument
Get the minimum accepted byteeger that could have been parsed
getMin() - Method in class cloud.commandframework.arguments.standard.DoubleArgument.DoubleParser
Get the min value
getMin() - Method in class cloud.commandframework.arguments.standard.DoubleArgument
Get the minimum accepted double that could have been parsed
getMin() - Method in class cloud.commandframework.arguments.standard.FloatArgument.FloatParser
Get the min value
getMin() - Method in class cloud.commandframework.arguments.standard.FloatArgument
Get the minimum accepted float that could have been parsed
getMin() - Method in class cloud.commandframework.arguments.standard.IntegerArgument
Get the minimum accepted integer that could have been parsed
getMin() - Method in class cloud.commandframework.arguments.standard.IntegerArgument.IntegerParser
Get the minimum value accepted by this parser
getMin() - Method in class cloud.commandframework.arguments.standard.LongArgument
Get the minimum accepted long that could have been parsed
getMin() - Method in class cloud.commandframework.arguments.standard.LongArgument.LongParser
Get the minimum value accepted by this parser
getMin() - Method in class cloud.commandframework.arguments.standard.ShortArgument
Get the minimum accepted short that could have been parsed
getMin() - Method in class cloud.commandframework.arguments.standard.ShortArgument.ShortParser
Get the min value
getMin() - Method in exception cloud.commandframework.exceptions.parsing.NumberParseException
Get the minimum accepted integer that could have been parsed
getMissingPermission() - Method in exception cloud.commandframework.exceptions.NoPermissionException
Get the missing permission node
getName() - Method in class cloud.commandframework.arguments.CommandArgument.Builder
 
getName() - Method in class cloud.commandframework.arguments.CommandArgument
Get the command argument name;
getName() - Method in class cloud.commandframework.arguments.flags.CommandFlag
Get the flag name
getName() - Method in interface cloud.commandframework.keys.CloudKey
Get the name of the key.
getName() - Method in class cloud.commandframework.keys.SimpleCloudKey
 
getName() - Method in interface cloud.commandframework.meta.CommandMeta.Key
Get the name of this key
getNamedNode(String) - Method in class cloud.commandframework.CommandTree
Get a named root node, if it exists
getNames() - Method in class cloud.commandframework.arguments.compound.CompoundArgument
Get the argument names
getNodeMeta() - Method in class cloud.commandframework.CommandTree.Node
Get the node meta instance
getNumberType() - Method in exception cloud.commandframework.arguments.standard.ByteArgument.ByteParseException
 
getNumberType() - Method in exception cloud.commandframework.arguments.standard.DoubleArgument.DoubleParseException
 
getNumberType() - Method in exception cloud.commandframework.arguments.standard.FloatArgument.FloatParseException
 
getNumberType() - Method in exception cloud.commandframework.arguments.standard.IntegerArgument.IntegerParseException
 
getNumberType() - Method in exception cloud.commandframework.arguments.standard.LongArgument.LongParseException
 
getNumberType() - Method in exception cloud.commandframework.arguments.standard.ShortArgument.ShortParseException
 
getNumberType() - Method in exception cloud.commandframework.exceptions.parsing.NumberParseException
Get the number type
getOptional(CommandArgument<C, T>) - Method in class cloud.commandframework.context.CommandContext
Get a value from its key.
getOptional(CloudKey<T>) - Method in class cloud.commandframework.context.CommandContext
Get a value from its key.
getOptional(CloudKeyHolder<T>) - Method in class cloud.commandframework.context.CommandContext
Get a value from its key.
getOptional(String) - Method in class cloud.commandframework.context.CommandContext
Get a value from its key.
getOptionalPrefix() - Method in class cloud.commandframework.arguments.StandardCommandSyntaxFormatter.FormattingInstance
Get the optional argument prefix
getOptionalSuffix() - Method in class cloud.commandframework.arguments.StandardCommandSyntaxFormatter.FormattingInstance
Get the optional argument suffix
getOrDefault(CommandArgument<C, T>, T) - Method in class cloud.commandframework.context.CommandContext
Get a value if it exists, else return the provided default value
getOrDefault(CloudKey<T>, T) - Method in class cloud.commandframework.context.CommandContext
Get a value if it exists, else return the provided default value
getOrDefault(CommandMeta.Key<V>, V) - Method in class cloud.commandframework.meta.CommandMeta
Get the value if it exists, else return the default value.
getOrDefault(CommandMeta.Key<V>, V) - Method in class cloud.commandframework.meta.SimpleCommandMeta
 
getOrDefault(String, String) - Method in class cloud.commandframework.meta.CommandMeta
Deprecated.
for removal since 1.3.0, see typesafe variant at CommandMeta.getOrDefault(Key, Object) instead
getOrDefault(String, String) - Method in class cloud.commandframework.meta.SimpleCommandMeta
Deprecated.
getOrDefault(String, T) - Method in class cloud.commandframework.context.CommandContext
Get a value if it exists, else return the provided default value
getOrSupplyDefault(CloudKey<T>, Supplier<T>) - Method in class cloud.commandframework.context.CommandContext
Get a value if it exists, else return the value supplied by the given supplier
getOrSupplyDefault(String, Supplier<T>) - Method in class cloud.commandframework.context.CommandContext
Get a value if it exists, else return the value supplied by the given supplier
getOwningCommand() - Method in class cloud.commandframework.arguments.CommandArgument
Get the owning command
getParent() - Method in class cloud.commandframework.CommandTree.Node
Get the parent node
getParentNode() - Method in exception cloud.commandframework.exceptions.AmbiguousNodeException
Get the parent node
getParsedValue() - Method in class cloud.commandframework.arguments.parser.ArgumentParseResult
Get the parsed value, if it exists
getParser() - Method in class cloud.commandframework.arguments.CommandArgument.Builder
 
getParser() - Method in class cloud.commandframework.arguments.CommandArgument
Get the parser that is used to parse the command input into the corresponding command type
getParserRegistry() - Method in class cloud.commandframework.CommandManager
Get the parser registry instance.
getParserTuple() - Method in class cloud.commandframework.arguments.compound.CompoundArgument
Get the tuple containing the internal parsers
getPattern() - Method in exception cloud.commandframework.arguments.preprocessor.RegexPreprocessor.RegexValidationException
Get the pattern that caused the string to fail
getPending(C) - Method in class cloud.commandframework.extra.confirmation.CommandConfirmationManager
Get a pending context if one is stored for the sender
getPermission() - Method in class cloud.commandframework.permission.Permission
Get the command permission
getPermissions() - Method in class cloud.commandframework.permission.AndPermission
 
getPermissions() - Method in interface cloud.commandframework.permission.CommandPermission
Get the permission nodes
getPermissions() - Method in class cloud.commandframework.permission.OrPermission
 
getPermissions() - Method in class cloud.commandframework.permission.Permission
 
getPermissions() - Method in interface cloud.commandframework.permission.PredicatePermission
 
getRawInput() - Method in class cloud.commandframework.context.CommandContext
Get the raw input.
getRawInputJoined() - Method in class cloud.commandframework.context.CommandContext
Get the raw input as a joined string
getRegistrationState() - Method in class cloud.commandframework.CommandManager
Get the active registration state for this manager.
getRequestedArgumentCount() - Method in interface cloud.commandframework.arguments.parser.ArgumentParser
Get the amount of arguments that this parsers seeks to consume
getRequestedArgumentCount() - Method in class cloud.commandframework.arguments.parser.MappedArgumentParser
 
getRequiredPrefix() - Method in class cloud.commandframework.arguments.StandardCommandSyntaxFormatter.FormattingInstance
Get the required argument prefix
getRequiredSender() - Method in exception cloud.commandframework.exceptions.InvalidCommandSenderException
Get the required sender type
getRequiredSuffix() - Method in class cloud.commandframework.arguments.StandardCommandSyntaxFormatter.FormattingInstance
Get the required argument suffix
getRootNodes() - Method in class cloud.commandframework.CommandTree
Get an immutable collection containing all of the root nodes in the tree
getSecond() - Method in class cloud.commandframework.types.tuples.Pair
Get the second value
getSecond() - Method in class cloud.commandframework.types.tuples.Quartet
Get the second value
getSecond() - Method in class cloud.commandframework.types.tuples.Quintet
Get the second value
getSecond() - Method in class cloud.commandframework.types.tuples.Sextet
Get the second value
getSecond() - Method in class cloud.commandframework.types.tuples.Triplet
Get the second value
getSender() - Method in class cloud.commandframework.context.CommandContext
Get the sender that executed the command
getSenderType() - Method in class cloud.commandframework.Command
Get the required sender type, if one has been specified
getSetting(CommandManager.ManagerSettings) - Method in class cloud.commandframework.CommandManager
Get a command manager setting
getSixth() - Method in class cloud.commandframework.types.tuples.Sextet
Get the sixth value
getSize() - Method in class cloud.commandframework.types.tuples.DynamicTuple
 
getSize() - Method in class cloud.commandframework.types.tuples.Pair
 
getSize() - Method in class cloud.commandframework.types.tuples.Quartet
 
getSize() - Method in class cloud.commandframework.types.tuples.Quintet
 
getSize() - Method in class cloud.commandframework.types.tuples.Sextet
 
getSize() - Method in class cloud.commandframework.types.tuples.Triplet
 
getSize() - Method in interface cloud.commandframework.types.tuples.Tuple
Get the tuple size
getStandardCaptionKeys() - Static method in class cloud.commandframework.captions.StandardCaptionKeys
Get an immutable collection containing all standard caption keys
getStringMode() - Method in class cloud.commandframework.arguments.standard.StringArgument
Get the string mode
getStringMode() - Method in exception cloud.commandframework.arguments.standard.StringArgument.StringParseException
Get the string mode
getStringMode() - Method in class cloud.commandframework.arguments.standard.StringArgument.StringParser
Get the string mode
getSuggestionProvider(String) - Method in interface cloud.commandframework.arguments.parser.ParserRegistry
Get a named suggestion provider, if a suggestion provider with the given name exists in the registry
getSuggestionProvider(String) - Method in class cloud.commandframework.arguments.parser.StandardParserRegistry
 
getSuggestions(long, long, String) - Static method in class cloud.commandframework.arguments.standard.IntegerArgument.IntegerParser
Get integer suggestions.
getSuggestions(CommandContext<C>, String) - Method in interface cloud.commandframework.arguments.CommandSuggestionEngine
Get command suggestions for the "next" argument that would yield a correctly parsing command input
getSuggestions(CommandContext<C>, String) - Method in class cloud.commandframework.arguments.DelegatingCommandSuggestionEngine
 
getSuggestions(CommandContext<C>, Queue<String>) - Method in class cloud.commandframework.CommandTree
Get suggestions from the input queue
getSuggestionsProvider() - Method in class cloud.commandframework.arguments.CommandArgument.Builder
 
getSuggestionsProvider() - Method in class cloud.commandframework.arguments.CommandArgument
Get the argument suggestions provider
getSuppliedCommand() - Method in exception cloud.commandframework.exceptions.NoSuchCommandException
Get the supplied command
getSyntaxString() - Method in class cloud.commandframework.CommandHelpHandler.VerboseHelpEntry
Get the syntax string
getThird() - Method in class cloud.commandframework.types.tuples.Quartet
Get the third value
getThird() - Method in class cloud.commandframework.types.tuples.Quintet
Get the third value
getThird() - Method in class cloud.commandframework.types.tuples.Sextet
Get the third value
getThird() - Method in class cloud.commandframework.types.tuples.Triplet
Get the third value
getType() - Method in interface cloud.commandframework.keys.CloudKey
Get the type of the value that this key holds.
getType() - Method in class cloud.commandframework.keys.SimpleCloudKey
 
getType() - Method in interface cloud.commandframework.meta.CommandMeta.Key
 
getTypes() - Method in class cloud.commandframework.arguments.compound.CompoundArgument
Get the parser types
getValue() - Method in class cloud.commandframework.captions.CaptionVariable
Get the variable value
getValue() - Method in class cloud.commandframework.CommandTree.Node
Get the node value
getValue(CommandFlag<T>) - Method in class cloud.commandframework.arguments.flags.FlagContext
Get a flag value as an optional.
getValue(CommandFlag<T>, T) - Method in class cloud.commandframework.arguments.flags.FlagContext
Get a flag value
getValue(String) - Method in class cloud.commandframework.arguments.flags.FlagContext
Get a flag value as an optional.
getValue(String) - Method in class cloud.commandframework.meta.CommandMeta
Deprecated.
for removal since 1.3.0, see typesafe variant at CommandMeta.get(Key) instead
getValue(String) - Method in class cloud.commandframework.meta.SimpleCommandMeta
Deprecated.
getValue(String, T) - Method in class cloud.commandframework.arguments.flags.FlagContext
Get a flag value
getValueType() - Method in class cloud.commandframework.arguments.CommandArgument.Builder
 
getValueType() - Method in class cloud.commandframework.arguments.CommandArgument
Get the type of this argument's value
getValueType() - Method in interface cloud.commandframework.meta.CommandMeta.Key
Get a representation of the type of value this key holds.
greedy() - Method in class cloud.commandframework.arguments.standard.StringArgument.Builder
Set the string mode to greedy
greedy(String) - Static method in class cloud.commandframework.arguments.standard.StringArgument
Create a new required command argument with the 'greedy' parsing mode
Greedy - Annotation Type in cloud.commandframework.annotations.specifier
Annotation used to make string arguments greedy
GREEDY - Enum constant in enum cloud.commandframework.arguments.standard.StringArgument.StringMode
 
GREEDY - Static variable in class cloud.commandframework.arguments.parser.StandardParameters
Indicates that a string argument should be greedy
GuiceInjectionService<C> - Class in cloud.commandframework.annotations.injection
Injection service that injects using a Guice Injector

H

handle(Triplet<CommandContext<C>, Class<?>, AnnotationAccessor>) - Method in class cloud.commandframework.annotations.injection.GuiceInjectionService
 
handle(Triplet<CommandContext<C>, Class<?>, AnnotationAccessor>) - Method in class cloud.commandframework.annotations.injection.ParameterInjectorRegistry
 
handleException(C, Class<E>, E, BiConsumer<C, E>) - Method in class cloud.commandframework.CommandManager
Handle an exception using the registered exception handler for the exception type, or using the provided default handler if no exception handler has been registered for the exception type
handler(CommandExecutionHandler<C>) - Method in class cloud.commandframework.Command.Builder
Specify the command execution handler
has(ParserParameter<T>) - Method in class cloud.commandframework.arguments.parser.ParserParameters
Check if this instance contains a parameter-object pair for a given parameter
hasDefaultValue() - Method in class cloud.commandframework.arguments.CommandArgument
Check if the argument has a default value
hasFlag(CommandFlag<?>) - Method in class cloud.commandframework.arguments.flags.FlagContext
Check whether a flag is present.
hasFlag(String) - Method in class cloud.commandframework.arguments.flags.FlagContext
Check whether a flag is present.
hashCode() - Method in class cloud.commandframework.arguments.CommandArgument
 
hashCode() - Method in class cloud.commandframework.arguments.flags.CommandFlag
 
hashCode() - Method in class cloud.commandframework.arguments.parser.MappedArgumentParser
 
hashCode() - Method in class cloud.commandframework.arguments.parser.ParserParameter
 
hashCode() - Method in class cloud.commandframework.captions.Caption
 
hashCode() - Method in class cloud.commandframework.CommandComponent
 
hashCode() - Method in class cloud.commandframework.CommandTree.Node
 
hashCode() - Method in class cloud.commandframework.execution.postprocessor.CommandPostprocessingContext
 
hashCode() - Method in class cloud.commandframework.execution.preprocessor.CommandPreprocessingContext
 
hashCode() - Method in class cloud.commandframework.keys.SimpleCloudKey
 
hashCode() - Method in class cloud.commandframework.meta.SimpleCommandMeta
 
hashCode() - Method in class cloud.commandframework.permission.AndPermission
 
hashCode() - Method in class cloud.commandframework.permission.OrPermission
 
hashCode() - Method in class cloud.commandframework.permission.Permission
 
hashCode() - Method in class cloud.commandframework.types.tuples.Pair
 
hashCode() - Method in class cloud.commandframework.types.tuples.Quartet
 
hashCode() - Method in class cloud.commandframework.types.tuples.Quintet
 
hashCode() - Method in class cloud.commandframework.types.tuples.Sextet
 
hashCode() - Method in class cloud.commandframework.types.tuples.Triplet
 
hasMax() - Method in exception cloud.commandframework.arguments.standard.ByteArgument.ByteParseException
 
hasMax() - Method in class cloud.commandframework.arguments.standard.ByteArgument.ByteParser
Get whether this parser has a maximum set.
hasMax() - Method in exception cloud.commandframework.arguments.standard.DoubleArgument.DoubleParseException
 
hasMax() - Method in class cloud.commandframework.arguments.standard.DoubleArgument.DoubleParser
Get whether this parser has a maximum set.
hasMax() - Method in exception cloud.commandframework.arguments.standard.FloatArgument.FloatParseException
 
hasMax() - Method in class cloud.commandframework.arguments.standard.FloatArgument.FloatParser
Get whether this parser has a maximum set.
hasMax() - Method in exception cloud.commandframework.arguments.standard.IntegerArgument.IntegerParseException
 
hasMax() - Method in class cloud.commandframework.arguments.standard.IntegerArgument.IntegerParser
Get whether this parser has a maximum set.
hasMax() - Method in exception cloud.commandframework.arguments.standard.LongArgument.LongParseException
 
hasMax() - Method in class cloud.commandframework.arguments.standard.LongArgument.LongParser
Get whether this parser has a maximum set.
hasMax() - Method in exception cloud.commandframework.arguments.standard.ShortArgument.ShortParseException
 
hasMax() - Method in class cloud.commandframework.arguments.standard.ShortArgument.ShortParser
Get whether this parser has a maximum set.
hasMax() - Method in exception cloud.commandframework.exceptions.parsing.NumberParseException
If the parser had a maximum value
hasMin() - Method in exception cloud.commandframework.arguments.standard.ByteArgument.ByteParseException
 
hasMin() - Method in class cloud.commandframework.arguments.standard.ByteArgument.ByteParser
Get whether this parser has a minimum set.
hasMin() - Method in exception cloud.commandframework.arguments.standard.DoubleArgument.DoubleParseException
 
hasMin() - Method in class cloud.commandframework.arguments.standard.DoubleArgument.DoubleParser
Get whether this parser has a minimum set.
hasMin() - Method in exception cloud.commandframework.arguments.standard.FloatArgument.FloatParseException
 
hasMin() - Method in class cloud.commandframework.arguments.standard.FloatArgument.FloatParser
Get whether this parser has a minimum set.
hasMin() - Method in exception cloud.commandframework.arguments.standard.IntegerArgument.IntegerParseException
 
hasMin() - Method in class cloud.commandframework.arguments.standard.IntegerArgument.IntegerParser
Get whether this parser has a minimum set.
hasMin() - Method in exception cloud.commandframework.arguments.standard.LongArgument.LongParseException
 
hasMin() - Method in class cloud.commandframework.arguments.standard.LongArgument.LongParser
Get whether this parser has a minimum set.
hasMin() - Method in exception cloud.commandframework.arguments.standard.ShortArgument.ShortParseException
 
hasMin() - Method in class cloud.commandframework.arguments.standard.ShortArgument.ShortParser
Get whether this parser has a minimum set.
hasMin() - Method in exception cloud.commandframework.exceptions.parsing.NumberParseException
If the parser had a minimum value
hasPermission(CommandPermission) - Method in class cloud.commandframework.context.CommandContext
Check whether the sender that executed the command has a permission.
hasPermission(C, CommandPermission) - Method in class cloud.commandframework.CommandManager
Check if the command sender has the required permission.
hasPermission(C, String) - Method in class cloud.commandframework.CommandManager
Check if the command sender has the required permission.
hasPermission(String) - Method in class cloud.commandframework.context.CommandContext
Check whether the sender that executed the command has a permission.
hasPermission(C) - Method in interface cloud.commandframework.permission.PredicatePermission
Check whether or not the given sender has this permission
hidden() - Method in class cloud.commandframework.Command.Builder
Indicate that the command should be hidden from help menus and other places where commands are exposed to users
HIDDEN - Static variable in class cloud.commandframework.arguments.parser.StandardParameters
The command should be hidden from help menus, etc
HIDDEN - Static variable in class cloud.commandframework.meta.CommandMeta
 

I

initCause(Throwable) - Method in exception cloud.commandframework.exceptions.NoPermissionException
 
initCause(Throwable) - Method in exception cloud.commandframework.exceptions.NoSuchCommandException
 
inject(Class<T>) - Method in class cloud.commandframework.context.CommandContext
Attempt to retrieve a value that has been registered to the associated command manager's ParameterInjectorRegistry
InjectionService<C> - Interface in cloud.commandframework.annotations.injection
Service that can be registered to the ParameterInjectorRegistry in order to provide custom injection support.
injectors(Class<T>) - Method in class cloud.commandframework.annotations.injection.ParameterInjectorRegistry
Deprecated.
Inject directly instead of relying on this list
insertCommand(Command<C>) - Method in class cloud.commandframework.CommandTree
Insert a new command into the command tree
IntegerArgument<C> - Class in cloud.commandframework.arguments.standard
 
IntegerArgument.Builder<C> - Class in cloud.commandframework.arguments.standard
 
IntegerArgument.IntegerParseException - Exception in cloud.commandframework.arguments.standard
 
IntegerArgument.IntegerParser<C> - Class in cloud.commandframework.arguments.standard
 
IntegerParseException(String, int, int, CommandContext<?>) - Constructor for exception cloud.commandframework.arguments.standard.IntegerArgument.IntegerParseException
IntegerParseException(String, IntegerArgument.IntegerParser<?>, CommandContext<?>) - Constructor for exception cloud.commandframework.arguments.standard.IntegerArgument.IntegerParseException
IntegerParser(int, int) - Constructor for class cloud.commandframework.arguments.standard.IntegerArgument.IntegerParser
Construct a new integer parser
InvalidCommandSenderException - Exception in cloud.commandframework.exceptions
Exception thrown when an invalid command sender tries to execute a command
InvalidCommandSenderException(Object, Class<?>, List<CommandArgument<?, ?>>) - Constructor for exception cloud.commandframework.exceptions.InvalidCommandSenderException
Construct a new command parse exception
InvalidCommandSenderException(Object, Class<?>, List<CommandArgument<?, ?>>, Command<?>) - Constructor for exception cloud.commandframework.exceptions.InvalidCommandSenderException
Construct a new command parse exception
InvalidSyntaxException - Exception in cloud.commandframework.exceptions
Exception sent when a command sender inputs invalid command syntax
InvalidSyntaxException(String, Object, List<CommandArgument<?, ?>>) - Constructor for exception cloud.commandframework.exceptions.InvalidSyntaxException
Create a new invalid syntax exception instance
isArgumentRegistered() - Method in class cloud.commandframework.arguments.CommandArgument
Check whether or not the argument has been used in a command
isCommandRegistrationAllowed() - Method in class cloud.commandframework.CommandManager
Check if command registration is allowed.
isContextFree() - Method in interface cloud.commandframework.arguments.parser.ArgumentParser
Check whether or not this argument parser is context free.
isContextFree() - Method in class cloud.commandframework.arguments.parser.MappedArgumentParser
 
isContextFree() - Method in class cloud.commandframework.arguments.standard.BooleanArgument.BooleanParser
 
isContextFree() - Method in class cloud.commandframework.arguments.standard.ByteArgument.ByteParser
 
isContextFree() - Method in class cloud.commandframework.arguments.standard.CharArgument.CharacterParser
 
isContextFree() - Method in class cloud.commandframework.arguments.standard.DoubleArgument.DoubleParser
 
isContextFree() - Method in class cloud.commandframework.arguments.standard.EnumArgument.EnumParser
 
isContextFree() - Method in class cloud.commandframework.arguments.standard.FloatArgument.FloatParser
 
isContextFree() - Method in class cloud.commandframework.arguments.standard.IntegerArgument.IntegerParser
 
isContextFree() - Method in class cloud.commandframework.arguments.standard.LongArgument.LongParser
 
isContextFree() - Method in class cloud.commandframework.arguments.standard.ShortArgument.ShortParser
 
isContextFree() - Method in class cloud.commandframework.arguments.standard.StringArgument.StringParser
 
isContextFree() - Method in class cloud.commandframework.arguments.standard.UUIDArgument.UUIDParser
 
isEmpty() - Method in interface cloud.commandframework.ArgumentDescription
Get whether or not this description contains contents.
isEmpty() - Method in class cloud.commandframework.CommandHelpHandler.IndexHelpTopic
Check if the help topic is entry
isHidden() - Method in class cloud.commandframework.Command
Check whether or not the command is hidden
isLeaf() - Method in class cloud.commandframework.CommandTree.Node
Check if the node is a leaf node
isLiberal() - Method in exception cloud.commandframework.arguments.standard.BooleanArgument.BooleanParseException
Get the liberal boolean value
isLiberal() - Method in class cloud.commandframework.arguments.standard.BooleanArgument
Get the liberal boolean
isPresent(CommandFlag<Void>) - Method in class cloud.commandframework.arguments.flags.FlagContext
Check whether a presence flag is present.
isPresent(String) - Method in class cloud.commandframework.arguments.flags.FlagContext
Check whether a presence flag is present.
isRequired() - Method in class cloud.commandframework.arguments.CommandArgument.Builder
 
isRequired() - Method in class cloud.commandframework.arguments.CommandArgument
Check whether or not the command argument is required
isSuggestions() - Method in class cloud.commandframework.context.CommandContext
Check if this context was created for tab completion purposes

L

Liberal - Annotation Type in cloud.commandframework.annotations.specifier
Annotation used to set the parsing mode of a boolean argument to liberal.
LIBERAL - Static variable in class cloud.commandframework.arguments.parser.StandardParameters
Indicates that a boolean argument should be liberal.
literal(String, ArgumentDescription, String...) - Method in class cloud.commandframework.Command.Builder
Inserts a required StaticArgument into the command chain
literal(String, Description, String...) - Method in class cloud.commandframework.Command.Builder
Deprecated.
literal(String, String...) - Method in class cloud.commandframework.Command.Builder
Inserts a required StaticArgument into the command chain
LockableCommandManager<C> - Class in cloud.commandframework
Deprecated.
Use a normal CommandManager's registration state instead
LockableCommandManager(Function<CommandTree<C>, CommandExecutionCoordinator<C>>, CommandRegistrationHandler) - Constructor for class cloud.commandframework.LockableCommandManager
Deprecated.
Create a new command manager instance
lockRegistration() - Method in class cloud.commandframework.CommandManager
lockWrites() - Method in class cloud.commandframework.LockableCommandManager
Deprecated.
Lock writing.
LONG_DESCRIPTION - Static variable in class cloud.commandframework.meta.CommandMeta
 
LongArgument<C> - Class in cloud.commandframework.arguments.standard
 
LongArgument.Builder<C> - Class in cloud.commandframework.arguments.standard
 
LongArgument.LongParseException - Exception in cloud.commandframework.arguments.standard
 
LongArgument.LongParser<C> - Class in cloud.commandframework.arguments.standard
 
LongParseException(String, long, long, CommandContext<?>) - Constructor for exception cloud.commandframework.arguments.standard.LongArgument.LongParseException
LongParseException(String, LongArgument.LongParser<?>, CommandContext<?>) - Constructor for exception cloud.commandframework.arguments.standard.LongArgument.LongParseException
LongParser(long, long) - Constructor for class cloud.commandframework.arguments.standard.LongArgument.LongParser
Construct a new long parser

M

manager(CommandManager<C>) - Method in class cloud.commandframework.arguments.CommandArgument.Builder
Set the command manager.
manager(CommandManager<C>) - Method in class cloud.commandframework.arguments.CommandArgument.TypedBuilder
Set the command manager.
manager(CommandManager<C>) - Method in class cloud.commandframework.Command.Builder
Supply a command manager instance to the builder.
map(BiFunction<CommandContext<C>, O, ArgumentParseResult<O1>>) - Method in class cloud.commandframework.arguments.parser.MappedArgumentParser
 
map(BiFunction<CommandContext<C>, T, ArgumentParseResult<O>>) - Method in interface cloud.commandframework.arguments.parser.ArgumentParser
Create a derived argument parser preserving all properties of this parser, but converting the output type.
mapFailure(Function<Throwable, Throwable>) - Method in class cloud.commandframework.arguments.parser.ArgumentParseResult
If this result is a failure, transform the exception.
mapParsedValue(Function<T, U>) - Method in class cloud.commandframework.arguments.parser.ArgumentParseResult
If this result is successful, transform the output value.
MappedArgumentParser<C,I,O> - Class in cloud.commandframework.arguments.parser
An argument parser which wraps another argument parser, converting the output type.
max() - Element in annotation type cloud.commandframework.annotations.specifier.Range
Maximum value accepted by the parser
merge(ParserParameters) - Method in class cloud.commandframework.arguments.parser.ParserParameters
Attempt to merge two ParserParameters instances.
meta(CommandMeta.Key<V>, V) - Method in class cloud.commandframework.Command.Builder
Add command meta to the internal command meta map
meta(String, String) - Method in class cloud.commandframework.Command.Builder
Deprecated.
for removal since 1.2.0, use the typesafe variant at Command.Builder.meta(CommandMeta.Key, Object) instead.
META_CONFIRMATION_REQUIRED - Static variable in class cloud.commandframework.extra.confirmation.CommandConfirmationManager
Meta data stored for commands that require confirmation
min() - Element in annotation type cloud.commandframework.annotations.specifier.Range
Minimum value accepted by the parser
MISSING_ARGUMENT - Enum constant in enum cloud.commandframework.arguments.compound.FlagArgument.FailureReason
 

N

newBuilder() - Static method in class cloud.commandframework.execution.AsynchronousCommandExecutionCoordinator
newBuilder(Class<E>, String) - Static method in class cloud.commandframework.arguments.standard.EnumArgument
Create a new builder
newBuilder(String) - Static method in class cloud.commandframework.arguments.flags.CommandFlag
Create a new flag builder
newBuilder(String) - Static method in class cloud.commandframework.arguments.standard.BooleanArgument
Create a new builder
newBuilder(String) - Static method in class cloud.commandframework.arguments.standard.ByteArgument
Create a new ByteArgument.Builder.
newBuilder(String) - Static method in class cloud.commandframework.arguments.standard.CharArgument
Create a new builder
newBuilder(String) - Static method in class cloud.commandframework.arguments.standard.DoubleArgument
newBuilder(String) - Static method in class cloud.commandframework.arguments.standard.FloatArgument
Create a new FloatArgument.Builder.
newBuilder(String) - Static method in class cloud.commandframework.arguments.standard.IntegerArgument
newBuilder(String) - Static method in class cloud.commandframework.arguments.standard.LongArgument
Create a new LongArgument.Builder.
newBuilder(String) - Static method in class cloud.commandframework.arguments.standard.ShortArgument
Create a new ShortArgument.Builder.
newBuilder(String) - Static method in class cloud.commandframework.arguments.standard.StringArgument
Create a new builder
newBuilder(String) - Static method in class cloud.commandframework.arguments.standard.UUIDArgument
Create a new builder
newBuilder(String, CommandMeta, ArgumentDescription, String...) - Static method in class cloud.commandframework.Command
Create a new command builder.
newBuilder(String, CommandMeta, Description, String...) - Static method in class cloud.commandframework.Command
Deprecated.
newBuilder(String, CommandMeta, String...) - Static method in class cloud.commandframework.Command
Create a new command builder.
newTree(CommandManager<C>) - Static method in class cloud.commandframework.CommandTree
Create a new command tree instance
NO_FLAG_STARTED - Enum constant in enum cloud.commandframework.arguments.compound.FlagArgument.FailureReason
 
NO_PERMISSION - Enum constant in enum cloud.commandframework.arguments.compound.FlagArgument.FailureReason
 
NoCommandInLeafException - Exception in cloud.commandframework.exceptions
Thrown when a CommandArgument that is registered as a leaf node, does not contain an owning Command
NoCommandInLeafException(CommandArgument<?, ?>) - Constructor for exception cloud.commandframework.exceptions.NoCommandInLeafException
Create a new no command in leaf exception instance
NoInputProvidedException - Exception in cloud.commandframework.exceptions.parsing
An exception which is thrown when an argument's input is unexpectedly null or empty
NoInputProvidedException(Class<?>, CommandContext<?>) - Constructor for exception cloud.commandframework.exceptions.parsing.NoInputProvidedException
Construct a new NoInputProvidedException
NoPermissionException - Exception in cloud.commandframework.exceptions
Exception thrown when a command sender misses a permission required to execute a Command
NoPermissionException(CommandPermission, Object, List<CommandArgument<?, ?>>) - Constructor for exception cloud.commandframework.exceptions.NoPermissionException
Construct a new no permission exception
NoSuchCommandException - Exception in cloud.commandframework.exceptions
Exception thrown when a command sender tries to execute a command that doesn't exist
NoSuchCommandException(Object, List<CommandArgument<?, ?>>, String) - Constructor for exception cloud.commandframework.exceptions.NoSuchCommandException
Construct a no such command exception
NullAnnotationAccessor() - Constructor for class cloud.commandframework.annotations.AnnotationAccessor.NullAnnotationAccessor
 
NullCommandExecutionHandler() - Constructor for class cloud.commandframework.execution.CommandExecutionHandler.NullCommandExecutionHandler
 
nullCommandRegistrationHandler() - Static method in interface cloud.commandframework.internal.CommandRegistrationHandler
Create a new CommandRegistrationHandler that does nothing
NumberParseException - Exception in cloud.commandframework.exceptions.parsing
 
NumberParseException(String, Number, Number, Class<?>, CommandContext<?>) - Constructor for exception cloud.commandframework.exceptions.parsing.NumberParseException
Construct a new number parse exception

O

of(AnnotationAccessor...) - Static method in interface cloud.commandframework.annotations.AnnotationAccessor
Get a AnnotationAccessor instance that delegates to multiple AnnotatedElement instances.
of(CommandArgument<C, ?>, ArgumentDescription) - Static method in class cloud.commandframework.CommandComponent
Creates a new CommandComponent with the provided argument and description
of(CommandArgument<C, ?>, Description) - Static method in class cloud.commandframework.CommandComponent
Deprecated.
for removal since 1.4.0. Use CommandComponent.of(CommandArgument, ArgumentDescription) instead.
of(CommandManager<C>, String, Pair<String, String>, Pair<Class<U>, Class<V>>) - Static method in class cloud.commandframework.arguments.compound.ArgumentPair
Construct a builder for an argument pair
of(CommandManager<C>, String, Triplet<String, String, String>, Triplet<Class<U>, Class<V>, Class<W>>) - Static method in class cloud.commandframework.arguments.compound.ArgumentTriplet
Construct a builder for an argument triplet
of(CloudKey<Void>, Predicate<C>) - Static method in interface cloud.commandframework.permission.PredicatePermission
Create a new predicate permission
of(TypeToken<T>, String) - Static method in interface cloud.commandframework.meta.CommandMeta.Key
Create a new metadata key.
of(TypeToken<T>, String, Function<CommandMeta, T>) - Static method in interface cloud.commandframework.meta.CommandMeta.Key
Create a new metadata key.
of(Class<E>, String) - Static method in class cloud.commandframework.arguments.standard.EnumArgument
Create a new required command argument
of(Class<T>, String) - Static method in interface cloud.commandframework.meta.CommandMeta.Key
Create a new metadata key.
of(Class<T>, String, Function<CommandMeta, T>) - Static method in interface cloud.commandframework.meta.CommandMeta.Key
Create a new metadata key.
of(Object...) - Static method in class cloud.commandframework.types.tuples.DynamicTuple
Create a new dynamic tuple, containing the given elements
of(AnnotatedElement) - Static method in interface cloud.commandframework.annotations.AnnotationAccessor
Get a AnnotationAccessor instance for a AnnotatedElement, such as a Class or a Method.
of(String) - Static method in interface cloud.commandframework.ArgumentDescription
Create a command description instance.
of(String) - Static method in class cloud.commandframework.arguments.preprocessor.RegexPreprocessor
Create a new preprocessor using StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_REGEX as the failure caption
of(String) - Static method in class cloud.commandframework.arguments.standard.BooleanArgument
Create a new required command argument
of(String) - Static method in class cloud.commandframework.arguments.standard.ByteArgument
Create a new required ByteArgument.
of(String) - Static method in class cloud.commandframework.arguments.standard.CharArgument
Create a new required command argument
of(String) - Static method in class cloud.commandframework.arguments.standard.DoubleArgument
Create a new required DoubleArgument.
of(String) - Static method in class cloud.commandframework.arguments.standard.FloatArgument
Create a new required FloatArgument.
of(String) - Static method in class cloud.commandframework.arguments.standard.IntegerArgument
Create a new required IntegerArgument.
of(String) - Static method in class cloud.commandframework.arguments.standard.LongArgument
Create a new required LongArgument.
of(String) - Static method in class cloud.commandframework.arguments.standard.ShortArgument
Create a new required ShortArgument.
of(String) - Static method in class cloud.commandframework.arguments.standard.StringArgument
Create a new required single string command argument
of(String) - Static method in class cloud.commandframework.arguments.standard.UUIDArgument
Create a new required command component
of(String) - Static method in class cloud.commandframework.captions.Caption
Create a new caption with a given key
of(String) - Static method in class cloud.commandframework.Description
Deprecated.
for removal since 1.4.0. See ArgumentDescription.of(String)
of(String) - Static method in class cloud.commandframework.keys.SimpleCloudKey
Create a new type-less simple cloud key
of(String) - Static method in class cloud.commandframework.permission.Permission
Create a command permission instance
of(String, StringArgument.StringMode) - Static method in class cloud.commandframework.arguments.standard.StringArgument
Create a new required command argument
of(String, Caption) - Static method in class cloud.commandframework.arguments.preprocessor.RegexPreprocessor
Create a new preprocessor
of(String, TypeToken<T>) - Static method in class cloud.commandframework.keys.SimpleCloudKey
Create a new simple cloud key
of(String, String) - Static method in class cloud.commandframework.captions.CaptionVariable
Create a new caption variable instance
of(String, String...) - Static method in class cloud.commandframework.arguments.StaticArgument
Create a new static argument instance for a required command argument
of(String, BiFunction<CommandContext<C>, String, List<String>>) - Static method in class cloud.commandframework.arguments.standard.StringArrayArgument
Create a new required string array argument
of(Collection<CommandPermission>) - Static method in class cloud.commandframework.permission.AndPermission
Create a new OR permission
of(Collection<CommandPermission>) - Static method in class cloud.commandframework.permission.OrPermission
Create a new OR permission
of(U, V, W) - Static method in class cloud.commandframework.types.tuples.Triplet
Create a new 3-tuple
of(U, V, W, X) - Static method in class cloud.commandframework.types.tuples.Quartet
Create a new 4-tuple
of(U, V, W, X, Y) - Static method in class cloud.commandframework.types.tuples.Quintet
Create a new 5-tuple
of(U, V, W, X, Y, Z) - Static method in class cloud.commandframework.types.tuples.Sextet
Create a new 6-tuple
of(U, V) - Static method in class cloud.commandframework.types.tuples.Pair
Create a new 2-tuple
ofType(TypeToken<T>, String) - Static method in class cloud.commandframework.arguments.CommandArgument
Create a new command argument
ofType(Class<T>, String) - Static method in class cloud.commandframework.arguments.CommandArgument
Create a new command argument
optional(Class<E>, String) - Static method in class cloud.commandframework.arguments.standard.EnumArgument
Create a new optional command argument
optional(Class<E>, String, E) - Static method in class cloud.commandframework.arguments.standard.EnumArgument
Create a new optional command argument with a default value
optional(String) - Static method in class cloud.commandframework.arguments.standard.BooleanArgument
Create a new optional command argument
optional(String) - Static method in class cloud.commandframework.arguments.standard.ByteArgument
Create a new optional ByteArgument.
optional(String) - Static method in class cloud.commandframework.arguments.standard.CharArgument
Create a new optional command argument
optional(String) - Static method in class cloud.commandframework.arguments.standard.DoubleArgument
Create a new optional DoubleArgument.
optional(String) - Static method in class cloud.commandframework.arguments.standard.FloatArgument
Create a new optional FloatArgument.
optional(String) - Static method in class cloud.commandframework.arguments.standard.IntegerArgument
Create a new optional IntegerArgument.
optional(String) - Static method in class cloud.commandframework.arguments.standard.LongArgument
Create a new optional LongArgument.
optional(String) - Static method in class cloud.commandframework.arguments.standard.ShortArgument
Create a new optional ShortArgument.
optional(String) - Static method in class cloud.commandframework.arguments.standard.StringArgument
Create a new optional single string command argument
optional(String) - Static method in class cloud.commandframework.arguments.standard.UUIDArgument
Create a new optional command component
optional(String, boolean) - Static method in class cloud.commandframework.arguments.standard.BooleanArgument
Create a new required command argument with a default value
optional(String, byte) - Static method in class cloud.commandframework.arguments.standard.ByteArgument
Create a new optional ByteArgument with the specified default value.
optional(String, double) - Static method in class cloud.commandframework.arguments.standard.DoubleArgument
Create a new optional DoubleArgument with the specified default value.
optional(String, float) - Static method in class cloud.commandframework.arguments.standard.FloatArgument
Create a new optional FloatArgument with the specified default value.
optional(String, int) - Static method in class cloud.commandframework.arguments.standard.IntegerArgument
Create a new required IntegerArgument with the specified default value.
optional(String, long) - Static method in class cloud.commandframework.arguments.standard.LongArgument
Create a new optional LongArgument with the specified default value.
optional(String, short) - Static method in class cloud.commandframework.arguments.standard.ShortArgument
Create a new required ShortArgument with the specified default value.
optional(String, StringArgument.StringMode) - Static method in class cloud.commandframework.arguments.standard.StringArgument
Create a new optional command argument
optional(String, String) - Static method in class cloud.commandframework.arguments.standard.CharArgument
Create a new required command argument with a default value
optional(String, String) - Static method in class cloud.commandframework.arguments.standard.StringArgument
Create a new required command argument with a default value
optional(String, BiFunction<CommandContext<C>, String, List<String>>) - Static method in class cloud.commandframework.arguments.standard.StringArrayArgument
Create a new optional string array argument
optional(String, UUID) - Static method in class cloud.commandframework.arguments.standard.UUIDArgument
Create a new required command component with a default value
or(CommandPermission) - Method in interface cloud.commandframework.permission.CommandPermission
Return a permission that matches either this permission or the other permission.
or(CommandPermission...) - Method in interface cloud.commandframework.permission.CommandPermission
Return a permission that matches either this permission or any of the other permissions.
OrPermission - Class in cloud.commandframework.permission
Accepts as long as at least one of the permissions is accepted
OVERRIDE_EXISTING_COMMANDS - Enum constant in enum cloud.commandframework.CommandManager.ManagerSettings
Enables overriding of existing commands on supported platforms.

P

Pair<U,V> - Class in cloud.commandframework.types.tuples
Immutable generic 2-tuple
Pair(U, V) - Constructor for class cloud.commandframework.types.tuples.Pair
 
ParameterInjector<C,T> - Interface in cloud.commandframework.annotations.injection
Injector that injects parameters into CommandMethod annotated methods
parameterInjectorRegistry() - Method in class cloud.commandframework.CommandManager
Get the parameter injector registry instance
ParameterInjectorRegistry<C> - Class in cloud.commandframework.annotations.injection
Registry containing mappings between classes and injectors
ParameterInjectorRegistry() - Constructor for class cloud.commandframework.annotations.injection.ParameterInjectorRegistry
Create a new parameter injector registry
parse(CommandContext<C>, Queue<String>) - Method in class cloud.commandframework.arguments.compound.FlagArgument.FlagArgumentParser
 
parse(CommandContext<C>, Queue<String>) - Method in interface cloud.commandframework.arguments.parser.ArgumentParser
Parse command input into a command result.
parse(CommandContext<C>, Queue<String>) - Method in class cloud.commandframework.arguments.parser.MappedArgumentParser
 
parse(CommandContext<C>, Queue<String>) - Method in class cloud.commandframework.arguments.standard.StringArrayArgument.StringArrayParser
 
parse(CommandContext<C>, Queue<String>) - Method in class cloud.commandframework.arguments.standard.BooleanArgument.BooleanParser
 
parse(CommandContext<C>, Queue<String>) - Method in class cloud.commandframework.arguments.standard.ByteArgument.ByteParser
 
parse(CommandContext<C>, Queue<String>) - Method in class cloud.commandframework.arguments.standard.CharArgument.CharacterParser
 
parse(CommandContext<C>, Queue<String>) - Method in class cloud.commandframework.arguments.standard.DoubleArgument.DoubleParser
 
parse(CommandContext<C>, Queue<String>) - Method in class cloud.commandframework.arguments.standard.EnumArgument.EnumParser
 
parse(CommandContext<C>, Queue<String>) - Method in class cloud.commandframework.arguments.standard.IntegerArgument.IntegerParser
 
parse(CommandContext<C>, Queue<String>) - Method in class cloud.commandframework.arguments.standard.LongArgument.LongParser
 
parse(CommandContext<C>, Queue<String>) - Method in class cloud.commandframework.arguments.standard.ShortArgument.ShortParser
 
parse(CommandContext<C>, Queue<String>) - Method in class cloud.commandframework.arguments.standard.StringArgument.StringParser
 
parse(CommandContext<C>, Queue<String>) - Method in class cloud.commandframework.arguments.standard.UUIDArgument.UUIDParser
 
parse(CommandContext<C>, Queue<String>) - Method in class cloud.commandframework.CommandTree
Attempt to parse string input into a command
parse(CommandContext<C>, Queue<String>) - Method in class cloud.commandframework.arguments.standard.FloatArgument.FloatParser
 
parseAnnotations(TypeToken<?>, Collection<? extends Annotation>) - Method in interface cloud.commandframework.arguments.parser.ParserRegistry
Parse annotations into ParserParameters
parseAnnotations(TypeToken<?>, Collection<? extends Annotation>) - Method in class cloud.commandframework.arguments.parser.StandardParserRegistry
 
parseCurrentFlag(CommandContext<C>, Queue<String>) - Method in class cloud.commandframework.arguments.compound.FlagArgument.FlagArgumentParser
Parse command input to figure out what flag is currently being typed at the end of the input queue.
ParserException - Exception in cloud.commandframework.exceptions.parsing
 
ParserException(Class<?>, CommandContext<?>, Caption, CaptionVariable...) - Constructor for exception cloud.commandframework.exceptions.parsing.ParserException
 
ParserParameter<T> - Class in cloud.commandframework.arguments.parser
Parser parameter used when retrieving parsers from the ParserRegistry
ParserParameter(String, TypeToken<T>) - Constructor for class cloud.commandframework.arguments.parser.ParserParameter
Create a new parser parameter
ParserParameters - Class in cloud.commandframework.arguments.parser
Collection of parameter-object pairs
ParserParameters() - Constructor for class cloud.commandframework.arguments.parser.ParserParameters
 
ParserRegistry<C> - Interface in cloud.commandframework.arguments.parser
Registry of ArgumentParser that allows these arguments to be referenced by a Class (or really, a TypeToken) or a String key
PARSING_ARGUMENT_KEY - Static variable in class cloud.commandframework.CommandTree
Stores the index of the argument that is currently being parsed when parsing a CompoundArgument
permission() - Method in class cloud.commandframework.arguments.flags.CommandFlag
Get the permission required to use this flag, if it exists
permission(CommandPermission) - Method in class cloud.commandframework.Command.Builder
Specify a command permission
permission(PredicatePermission<C>) - Method in class cloud.commandframework.Command.Builder
Specify a command permission
permission(String) - Method in class cloud.commandframework.Command.Builder
Specify a command permission
Permission - Class in cloud.commandframework.permission
CommandArgument permission
postprocessContext(CommandContext<C>, Command<C>) - Method in class cloud.commandframework.CommandManager
Postprocess a command context instance
PredicatePermission<C> - Interface in cloud.commandframework.permission
A functional CommandPermission implementation
preprocess(CommandContext<C>, Queue<String>) - Method in class cloud.commandframework.arguments.CommandArgument
Preprocess command input.
preprocessContext(CommandContext<C>, LinkedList<String>) - Method in class cloud.commandframework.CommandManager
Preprocess a command context instance
PROCESSED_INDICATOR_KEY - Static variable in class cloud.commandframework.execution.postprocessor.AcceptingCommandPostprocessor
Key used to access the context meta that indicates that the context has been fully processed
PROCESSED_INDICATOR_KEY - Static variable in class cloud.commandframework.execution.preprocessor.AcceptingCommandPreprocessor
Key used to access the context meta that indicates that the context has been fully processed
proxies(Command<C>) - Method in class cloud.commandframework.Command.Builder
Make the current command be a proxy of the supplied command.

Q

Quartet<U,V,W,X> - Class in cloud.commandframework.types.tuples
Immutable generic 5-tuple
Quartet(U, V, W, X) - Constructor for class cloud.commandframework.types.tuples.Quartet
 
queryHelp(String) - Method in class cloud.commandframework.CommandHelpHandler
Query for help
queryHelp(C, String) - Method in class cloud.commandframework.CommandHelpHandler
Query for help
Quintet<U,V,W,X,Y> - Class in cloud.commandframework.types.tuples
Immutable generic 5-tuple
Quintet(U, V, W, X, Y) - Constructor for class cloud.commandframework.types.tuples.Quintet
 
quoted() - Method in class cloud.commandframework.arguments.standard.StringArgument.Builder
Set the string mode to greedy
quoted(String) - Static method in class cloud.commandframework.arguments.standard.StringArgument
Create a new required command argument with the 'quoted' parsing mode
Quoted - Annotation Type in cloud.commandframework.annotations.specifier
Annotation used to set the parsing mode of a string argument to quoted.
QUOTED - Enum constant in enum cloud.commandframework.arguments.standard.StringArgument.StringMode
 
QUOTED - Static variable in class cloud.commandframework.arguments.parser.StandardParameters
Indicates that a string argument should be quoted.

R

Range - Annotation Type in cloud.commandframework.annotations.specifier
Used to specify min and max values of numerical parsers
RANGE_MAX - Static variable in class cloud.commandframework.arguments.parser.StandardParameters
Maximum value accepted by a numerical parser
RANGE_MIN - Static variable in class cloud.commandframework.arguments.parser.StandardParameters
Minimum value accepted by a numerical parser
RegexPreprocessor<C> - Class in cloud.commandframework.arguments.preprocessor
Command preprocessor that filters based on regular expressions
RegexPreprocessor.RegexValidationException - Exception in cloud.commandframework.arguments.preprocessor
Exception thrown when input fails regex matching in RegexPreprocessor
registerAlias(String) - Method in class cloud.commandframework.arguments.StaticArgument
Register a new alias
registerAnnotationMapper(Class<A>, BiFunction<A, TypeToken<?>, ParserParameters>) - Method in interface cloud.commandframework.arguments.parser.ParserRegistry
Register a mapper that maps annotation instances to a map of parameter-object pairs
registerAnnotationMapper(Class<A>, BiFunction<A, TypeToken<?>, ParserParameters>) - Method in class cloud.commandframework.arguments.parser.StandardParserRegistry
 
registerCommand(Command<?>) - Method in class cloud.commandframework.internal.CommandRegistrationHandler.NullCommandRegistrationHandler
 
registerCommand(Command<?>) - Method in interface cloud.commandframework.internal.CommandRegistrationHandler
Attempt to register the command
registerCommandPostProcessor(CommandPostprocessor<C>) - Method in class cloud.commandframework.CommandManager
Register a new command postprocessor.
registerCommandPreProcessor(CommandPreprocessor<C>) - Method in class cloud.commandframework.CommandManager
Register a new command preprocessor.
registerConfirmationProcessor(CommandManager<C>) - Method in class cloud.commandframework.extra.confirmation.CommandConfirmationManager
Register the confirmation processor in the command manager
registerDefaultCaptions(CaptionRegistry<C>) - Method in class cloud.commandframework.CommandManager
Deprecated.
registerExceptionHandler(Class<E>, BiConsumer<C, E>) - Method in class cloud.commandframework.CommandManager
Register an exception handler for an exception type.
REGISTERING - Enum constant in enum cloud.commandframework.CommandManager.RegistrationState
When at least one command has been registered, and more commands have been registered.
registerInjectionService(InjectionService<C>) - Method in class cloud.commandframework.annotations.injection.ParameterInjectorRegistry
Register an injection service that will be able to provide injections using ParameterInjectorRegistry.getInjectable(Class, CommandContext, AnnotationAccessor).
registerInjector(Class<T>, ParameterInjector<C, T>) - Method in class cloud.commandframework.annotations.injection.ParameterInjectorRegistry
Register an injector for a particular type
registerMessageFactory(Caption, BiFunction<Caption, C, String>) - Method in interface cloud.commandframework.captions.FactoryDelegatingCaptionRegistry
Register a message factory
registerMessageFactory(Caption, BiFunction<Caption, C, String>) - Method in class cloud.commandframework.captions.SimpleCaptionRegistry
 
registerNamedParserSupplier(String, Function<ParserParameters, ArgumentParser<C, ?>>) - Method in interface cloud.commandframework.arguments.parser.ParserRegistry
Register a named parser supplier
registerNamedParserSupplier(String, Function<ParserParameters, ArgumentParser<C, ?>>) - Method in class cloud.commandframework.arguments.parser.StandardParserRegistry
 
registerParserSupplier(TypeToken<T>, Function<ParserParameters, ArgumentParser<C, ?>>) - Method in interface cloud.commandframework.arguments.parser.ParserRegistry
Register a parser supplier
registerParserSupplier(TypeToken<T>, Function<ParserParameters, ArgumentParser<C, ?>>) - Method in class cloud.commandframework.arguments.parser.StandardParserRegistry
 
registerSuggestionProvider(String, BiFunction<CommandContext<C>, String, List<String>>) - Method in interface cloud.commandframework.arguments.parser.ParserRegistry
Register a new named suggestion provider
registerSuggestionProvider(String, BiFunction<CommandContext<C>, String, List<String>>) - Method in class cloud.commandframework.arguments.parser.StandardParserRegistry
 
remove(CloudKey<?>) - Method in class cloud.commandframework.context.CommandContext
Remove a stored value from the context
remove(String) - Method in class cloud.commandframework.context.CommandContext
Remove a stored value from the context
replaceVariables(String, CaptionVariable...) - Method in interface cloud.commandframework.captions.CaptionVariableReplacementHandler
Replace the variables in a message and return the result
replaceVariables(String, CaptionVariable...) - Method in class cloud.commandframework.captions.SimpleCaptionVariableReplacementHandler
 
requireState(CommandManager.RegistrationState) - Method in class cloud.commandframework.CommandManager
Require that the commands manager is in a certain state.

S

self() - Method in class cloud.commandframework.arguments.CommandArgument.TypedBuilder
 
senderType() - Method in class cloud.commandframework.Command.Builder
Get the required sender type for this builder
senderType(Class<? extends C>) - Method in class cloud.commandframework.Command.Builder
Specify a required sender type
set(CloudKey<T>, T) - Method in class cloud.commandframework.context.CommandContext
Store or remove a value in the context map.
set(String, T) - Method in class cloud.commandframework.context.CommandContext
Store or remove a value in the context map.
setArgumentRegistered() - Method in class cloud.commandframework.arguments.CommandArgument
Indicate that the argument has been associated with a command
setCaptionRegistry(CaptionRegistry<C>) - Method in class cloud.commandframework.CommandManager
Replace the caption registry.
setCommandRegistrationHandler(CommandRegistrationHandler) - Method in class cloud.commandframework.CommandManager
 
setCommandSuggestionProcessor(CommandSuggestionProcessor<C>) - Method in class cloud.commandframework.CommandManager
Set the command suggestions processor for this command manager.
setCommandSyntaxFormatter(CommandSyntaxFormatter<C>) - Method in class cloud.commandframework.CommandManager
Set the command syntax formatter
setCurrentArgument(CommandArgument<C, ?>) - Method in class cloud.commandframework.context.CommandContext
Set the argument that is currently being parsed for this command context.
setEnd(long, boolean) - Method in class cloud.commandframework.context.CommandContext.ArgumentTiming
Set the end time
setOwningCommand(Command<C>) - Method in class cloud.commandframework.arguments.CommandArgument
Set the owning command
setParent(CommandTree.Node<T>) - Method in class cloud.commandframework.CommandTree.Node
Set the parent node
setSetting(CommandManager.ManagerSettings, boolean) - Method in class cloud.commandframework.CommandManager
Update a command manager setting
setStart(long) - Method in class cloud.commandframework.context.CommandContext.ArgumentTiming
Set the start time
Sextet<U,V,W,X,Y,Z> - Class in cloud.commandframework.types.tuples
Immutable generic 6-tuple
Sextet(U, V, W, X, Y, Z) - Constructor for class cloud.commandframework.types.tuples.Sextet
 
ShortArgument<C> - Class in cloud.commandframework.arguments.standard
 
ShortArgument.Builder<C> - Class in cloud.commandframework.arguments.standard
 
ShortArgument.ShortParseException - Exception in cloud.commandframework.arguments.standard
 
ShortArgument.ShortParser<C> - Class in cloud.commandframework.arguments.standard
 
ShortParseException(String, short, short, CommandContext<?>) - Constructor for exception cloud.commandframework.arguments.standard.ShortArgument.ShortParseException
ShortParseException(String, ShortArgument.ShortParser<?>, CommandContext<?>) - Constructor for exception cloud.commandframework.arguments.standard.ShortArgument.ShortParseException
ShortParser(short, short) - Constructor for class cloud.commandframework.arguments.standard.ShortArgument.ShortParser
Construct a new short parser
simple() - Method in class cloud.commandframework.arguments.compound.ArgumentPair.ArgumentPairIntermediaryBuilder
Create a simple argument pair that maps to a pair
simple() - Method in class cloud.commandframework.arguments.compound.ArgumentTriplet.ArgumentTripletIntermediaryBuilder
Create a simple argument triplet that maps to a triplet
simple() - Static method in class cloud.commandframework.meta.CommandMeta
Create a new simple command meta builder
SimpleCaptionRegistry<C> - Class in cloud.commandframework.captions
Caption registry that uses bi-functions to produce messages
SimpleCaptionRegistry() - Constructor for class cloud.commandframework.captions.SimpleCaptionRegistry
 
SimpleCaptionRegistryFactory<C> - Class in cloud.commandframework.captions
Factory creating SimpleCaptionRegistry instances
SimpleCaptionRegistryFactory() - Constructor for class cloud.commandframework.captions.SimpleCaptionRegistryFactory
 
SimpleCaptionVariableReplacementHandler - Class in cloud.commandframework.captions
Simple implementation of CaptionVariableReplacementHandler
SimpleCaptionVariableReplacementHandler() - Constructor for class cloud.commandframework.captions.SimpleCaptionVariableReplacementHandler
 
SimpleCloudKey<T> - Class in cloud.commandframework.keys
Simple immutable implementation of CloudKey.
SimpleCommandMeta - Class in cloud.commandframework.meta
A simple immutable string-string map containing command meta
SimpleCommandMeta(Map<String, String>) - Constructor for class cloud.commandframework.meta.SimpleCommandMeta
Deprecated.
SimpleCommandMeta(SimpleCommandMeta) - Constructor for class cloud.commandframework.meta.SimpleCommandMeta
 
SimpleCommandMeta.Builder - Class in cloud.commandframework.meta
Builder for SimpleCommandMeta
simpleCoordinator() - Static method in class cloud.commandframework.execution.CommandExecutionCoordinator
Returns a simple command execution coordinator that executes all commands immediately, on the calling thread
single() - Method in class cloud.commandframework.arguments.standard.StringArgument.Builder
Set the string mode to single
single(ParserParameter<T>, T) - Static method in class cloud.commandframework.arguments.parser.ParserParameters
Create a ParserParameters instance containing a single key-value par
single(String) - Static method in class cloud.commandframework.arguments.standard.StringArgument
Create a new required command argument with the 'single' parsing mode
SINGLE - Enum constant in enum cloud.commandframework.arguments.standard.StringArgument.StringMode
 
StandardCaptionKeys - Class in cloud.commandframework.captions
Caption instances for messages in cloud-core
StandardCommandContextFactory<C> - Class in cloud.commandframework.context
 
StandardCommandContextFactory() - Constructor for class cloud.commandframework.context.StandardCommandContextFactory
 
StandardCommandSyntaxFormatter<C> - Class in cloud.commandframework.arguments
CommandSyntaxFormatter implementation that uses the following rules: static arguments are serialized as their name, without a bracket required arguments are serialized as their name, surrounded by angle brackets optional arguments are serialized as their name, surrounded by square brackets
StandardCommandSyntaxFormatter() - Constructor for class cloud.commandframework.arguments.StandardCommandSyntaxFormatter
 
StandardCommandSyntaxFormatter.FormattingInstance - Class in cloud.commandframework.arguments
Instance that is used when building command syntax
StandardParameters - Class in cloud.commandframework.arguments.parser
Common parser parameters used when resolving types in the ParserRegistry
StandardParserRegistry<C> - Class in cloud.commandframework.arguments.parser
Standard implementation of ParserRegistry
StandardParserRegistry() - Constructor for class cloud.commandframework.arguments.parser.StandardParserRegistry
Construct a new StandardParserRegistry instance.
StaticArgument<C> - Class in cloud.commandframework.arguments
CommandArgument type that recognizes fixed strings.
store(CommandArgument<C, T>, T) - Method in class cloud.commandframework.context.CommandContext
Store a value in the context map.
store(ParserParameter<T>, T) - Method in class cloud.commandframework.arguments.parser.ParserParameters
Store a parameter-object pair
store(CloudKey<T>, T) - Method in class cloud.commandframework.context.CommandContext
Store a value in the context map.
store(CloudKeyHolder<T>, T) - Method in class cloud.commandframework.context.CommandContext
Store a value in the context map.
store(String, T) - Method in class cloud.commandframework.context.CommandContext
Store a value in the context map.
StringArgument<C> - Class in cloud.commandframework.arguments.standard
 
StringArgument.Builder<C> - Class in cloud.commandframework.arguments.standard
 
StringArgument.StringMode - Enum in cloud.commandframework.arguments.standard
 
StringArgument.StringParseException - Exception in cloud.commandframework.arguments.standard
 
StringArgument.StringParser<C> - Class in cloud.commandframework.arguments.standard
 
StringArrayArgument<C> - Class in cloud.commandframework.arguments.standard
This is a command argument type that essentially mimics StringArgument.greedy(String), but then splits the input string into a string array.
StringArrayArgument.StringArrayParser<C> - Class in cloud.commandframework.arguments.standard
Parser that parses input into a string array
StringArrayParser() - Constructor for class cloud.commandframework.arguments.standard.StringArrayArgument.StringArrayParser
 
StringParseException(String, StringArgument.StringMode, CommandContext<?>) - Constructor for exception cloud.commandframework.arguments.standard.StringArgument.StringParseException
Construct a new string parse exception
StringParser(StringArgument.StringMode, BiFunction<CommandContext<C>, String, List<String>>) - Constructor for class cloud.commandframework.arguments.standard.StringArgument.StringParser
Construct a new string parser
StringUtils - Class in cloud.commandframework.util
String utilities
success(T) - Static method in class cloud.commandframework.arguments.parser.ArgumentParseResult
Indicate that the parsing succeeded
suggest(C, String) - Method in class cloud.commandframework.CommandManager
Get command suggestions for the "next" argument that would yield a correctly parsing command input.
suggestions(CommandContext<C>, String) - Method in class cloud.commandframework.arguments.compound.FlagArgument.FlagArgumentParser
 
suggestions(CommandContext<C>, String) - Method in interface cloud.commandframework.arguments.parser.ArgumentParser
Get a list of suggested arguments that would be correctly parsed by this parser
suggestions(CommandContext<C>, String) - Method in class cloud.commandframework.arguments.parser.MappedArgumentParser
 
suggestions(CommandContext<C>, String) - Method in class cloud.commandframework.arguments.standard.BooleanArgument.BooleanParser
 
suggestions(CommandContext<C>, String) - Method in class cloud.commandframework.arguments.standard.ByteArgument.ByteParser
 
suggestions(CommandContext<C>, String) - Method in class cloud.commandframework.arguments.standard.EnumArgument.EnumParser
 
suggestions(CommandContext<C>, String) - Method in class cloud.commandframework.arguments.standard.IntegerArgument.IntegerParser
 
suggestions(CommandContext<C>, String) - Method in class cloud.commandframework.arguments.standard.LongArgument.LongParser
 
suggestions(CommandContext<C>, String) - Method in class cloud.commandframework.arguments.standard.ShortArgument.ShortParser
 
suggestions(CommandContext<C>, String) - Method in class cloud.commandframework.arguments.standard.StringArgument.StringParser
 

T

toArray() - Method in class cloud.commandframework.types.tuples.DynamicTuple
 
toArray() - Method in class cloud.commandframework.types.tuples.Pair
 
toArray() - Method in class cloud.commandframework.types.tuples.Quartet
 
toArray() - Method in class cloud.commandframework.types.tuples.Quintet
 
toArray() - Method in class cloud.commandframework.types.tuples.Sextet
 
toArray() - Method in class cloud.commandframework.types.tuples.Triplet
 
toArray() - Method in interface cloud.commandframework.types.tuples.Tuple
Turn the tuple into a type erased array
tokenize() - Method in class cloud.commandframework.internal.CommandInputTokenizer
Turn the input into tokens
toString() - Method in class cloud.commandframework.arguments.CommandArgument
 
toString() - Method in class cloud.commandframework.arguments.flags.CommandFlag
 
toString() - Method in class cloud.commandframework.arguments.parser.MappedArgumentParser
 
toString() - Method in class cloud.commandframework.arguments.StandardCommandSyntaxFormatter.FormattingInstance
 
toString() - Method in class cloud.commandframework.captions.Caption
 
toString() - Method in class cloud.commandframework.Command
 
toString() - Method in class cloud.commandframework.CommandComponent
 
toString() - Method in class cloud.commandframework.CommandTree.Node
 
toString() - Method in class cloud.commandframework.Description
Deprecated.
Get the command description
toString() - Method in class cloud.commandframework.keys.SimpleCloudKey
 
toString() - Method in class cloud.commandframework.meta.CommandMeta
 
toString() - Method in class cloud.commandframework.permission.AndPermission
 
toString() - Method in interface cloud.commandframework.permission.CommandPermission
Get a string representation of the permission
toString() - Method in class cloud.commandframework.permission.OrPermission
 
toString() - Method in class cloud.commandframework.permission.Permission
Get the command permission
toString() - Method in class cloud.commandframework.types.tuples.Pair
 
toString() - Method in class cloud.commandframework.types.tuples.Quartet
 
toString() - Method in class cloud.commandframework.types.tuples.Quintet
 
toString() - Method in class cloud.commandframework.types.tuples.Sextet
 
toString() - Method in class cloud.commandframework.types.tuples.Triplet
 
transitionIfPossible(CommandManager.RegistrationState, CommandManager.RegistrationState) - Method in class cloud.commandframework.CommandManager
Transition from the in state to the out state, if the manager is not already in that state.
transitionOrThrow(CommandManager.RegistrationState, CommandManager.RegistrationState) - Method in class cloud.commandframework.CommandManager
Transition from the in state to the out state, if the manager is not already in that state.
Triplet<U,V,W> - Class in cloud.commandframework.types.tuples
Immutable generic 3-tuple
Triplet(U, V, W) - Constructor for class cloud.commandframework.types.tuples.Triplet
 
Tuple - Interface in cloud.commandframework.types.tuples
Tuple type
TypedBuilder(TypeToken<T>, String) - Constructor for class cloud.commandframework.arguments.CommandArgument.TypedBuilder
 
TypedBuilder(Class<T>, String) - Constructor for class cloud.commandframework.arguments.CommandArgument.TypedBuilder
 

U

UNKNOWN_FLAG - Enum constant in enum cloud.commandframework.arguments.compound.FlagArgument.FailureReason
 
UUIDArgument<C> - Class in cloud.commandframework.arguments.standard
 
UUIDArgument.Builder<C> - Class in cloud.commandframework.arguments.standard
 
UUIDArgument.UUIDParseException - Exception in cloud.commandframework.arguments.standard
 
UUIDArgument.UUIDParser<C> - Class in cloud.commandframework.arguments.standard
 
UUIDParseException(String, CommandContext<?>) - Constructor for exception cloud.commandframework.arguments.standard.UUIDArgument.UUIDParseException
Construct a new UUID parse exception
UUIDParser() - Constructor for class cloud.commandframework.arguments.standard.UUIDArgument.UUIDParser
 

V

value() - Element in annotation type cloud.commandframework.annotations.specifier.Completions
Command completions
valueOf(String) - Static method in enum cloud.commandframework.arguments.compound.FlagArgument.FailureReason
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum cloud.commandframework.arguments.standard.StringArgument.StringMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum cloud.commandframework.CommandManager.ManagerSettings
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum cloud.commandframework.CommandManager.RegistrationState
Returns the enum constant of this type with the specified name.
values() - Static method in enum cloud.commandframework.arguments.compound.FlagArgument.FailureReason
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum cloud.commandframework.arguments.standard.StringArgument.StringMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum cloud.commandframework.CommandManager.ManagerSettings
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum cloud.commandframework.CommandManager.RegistrationState
Returns an array containing the constants of this enum type, in the order they are declared.
verifyAndRegister() - Method in class cloud.commandframework.CommandTree
Go through all commands and register them, and verify the command tree contracts

W

wasSuccess() - Method in class cloud.commandframework.context.CommandContext.ArgumentTiming
Check whether or not the value was parsed successfully
with(CommandMeta) - Method in class cloud.commandframework.meta.SimpleCommandMeta.Builder
Copy all values from another command meta instance
with(CommandMeta.Key<V>, V) - Method in class cloud.commandframework.meta.SimpleCommandMeta.Builder
Store a new key-value pair in the meta map
with(String, String) - Method in class cloud.commandframework.meta.SimpleCommandMeta.Builder
Deprecated.
For removal since 1.3.0, use the typesafe alternative instead
withAliases(String...) - Method in class cloud.commandframework.arguments.flags.CommandFlag.Builder
Create a new builder instance using the given flag aliases.
withArgument(CommandArgument.Builder<?, N>) - Method in class cloud.commandframework.arguments.flags.CommandFlag.Builder
Create a new builder instance using the given command argument
withArgument(CommandArgument<?, N>) - Method in class cloud.commandframework.arguments.flags.CommandFlag.Builder
Create a new builder instance using the given command argument
withAsynchronousParsing() - Method in class cloud.commandframework.execution.AsynchronousCommandExecutionCoordinator.Builder
Both command parsing and execution will run using the executor
withDefaultDescription(ArgumentDescription) - Method in class cloud.commandframework.arguments.CommandArgument.Builder
Set the default description to be used for this argument.
withDescription(ArgumentDescription) - Method in class cloud.commandframework.arguments.flags.CommandFlag.Builder
Create a new builder instance using the given flag description
withDescription(Description) - Method in class cloud.commandframework.arguments.flags.CommandFlag.Builder
Deprecated.
for removal since 1.4.0. Use CommandFlag.Builder.withDescription(ArgumentDescription) instead.
withExecutor(Executor) - Method in class cloud.commandframework.execution.AsynchronousCommandExecutionCoordinator.Builder
Specify an executor that will be used to coordinate tasks.
withLiberal(boolean) - Method in class cloud.commandframework.arguments.standard.BooleanArgument.Builder
Set the liberal toggle
withMapper(TypeToken<O>, BiFunction<C, Pair<U, V>, O>) - Method in class cloud.commandframework.arguments.compound.ArgumentPair.ArgumentPairIntermediaryBuilder
Create an argument pair that maps to a specific type
withMapper(TypeToken<O>, BiFunction<C, Triplet<U, V, W>, O>) - Method in class cloud.commandframework.arguments.compound.ArgumentTriplet.ArgumentTripletIntermediaryBuilder
Create an argument triplet that maps to a specific type
withMapper(Class<O>, BiFunction<C, Pair<U, V>, O>) - Method in class cloud.commandframework.arguments.compound.ArgumentPair.ArgumentPairIntermediaryBuilder
Create an argument pair that maps to a specific type
withMapper(Class<O>, BiFunction<C, Triplet<U, V, W>, O>) - Method in class cloud.commandframework.arguments.compound.ArgumentTriplet.ArgumentTripletIntermediaryBuilder
Create an argument triplet that maps to a specific type
withMax(byte) - Method in class cloud.commandframework.arguments.standard.ByteArgument.Builder
Set a maximum value
withMax(int) - Method in class cloud.commandframework.arguments.standard.DoubleArgument.Builder
Set a maximum value
withMax(int) - Method in class cloud.commandframework.arguments.standard.FloatArgument.Builder
Set a maximum value
withMax(int) - Method in class cloud.commandframework.arguments.standard.IntegerArgument.Builder
Set a maximum value
withMax(long) - Method in class cloud.commandframework.arguments.standard.LongArgument.Builder
Set a maximum value
withMax(short) - Method in class cloud.commandframework.arguments.standard.ShortArgument.Builder
Set a maximum value
withMin(byte) - Method in class cloud.commandframework.arguments.standard.ByteArgument.Builder
Set a minimum value
withMin(int) - Method in class cloud.commandframework.arguments.standard.DoubleArgument.Builder
Set a minimum value
withMin(int) - Method in class cloud.commandframework.arguments.standard.FloatArgument.Builder
Set a minimum value
withMin(int) - Method in class cloud.commandframework.arguments.standard.IntegerArgument.Builder
Set a minimum value
withMin(long) - Method in class cloud.commandframework.arguments.standard.LongArgument.Builder
Set a minimum value
withMin(short) - Method in class cloud.commandframework.arguments.standard.ShortArgument.Builder
Set a minimum value
withParser(ArgumentParser<C, T>) - Method in class cloud.commandframework.arguments.CommandArgument.Builder
Set the argument parser
withParser(ArgumentParser<C, T>) - Method in class cloud.commandframework.arguments.CommandArgument.TypedBuilder
Set the argument parser
withPermission(CommandPermission) - Method in class cloud.commandframework.arguments.flags.CommandFlag.Builder
Create a new builder instance using the given flag permission
withSuggestionsProvider(BiFunction<CommandContext<C>, String, List<String>>) - Method in class cloud.commandframework.arguments.standard.StringArgument.Builder
Set the suggestions provider
withSuggestionsProvider(BiFunction<CommandContext<C>, String, List<String>>) - Method in class cloud.commandframework.arguments.CommandArgument.Builder
Set the suggestions provider
withSuggestionsProvider(BiFunction<CommandContext<C>, String, List<String>>) - Method in class cloud.commandframework.arguments.CommandArgument.TypedBuilder
Set the suggestions provider
withSynchronousParsing() - Method in class cloud.commandframework.execution.AsynchronousCommandExecutionCoordinator.Builder
This forces the command parsing to run on the calling thread, and only the actual command execution will run using the executor
A B C D E F G H I L M N O P Q R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form