Index (cloud-core 2.0.0 API)

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

A

accept(CommandPostprocessingContext<C>) - Method in class org.incendo.cloud.execution.postprocessor.AcceptingCommandPostprocessor
accept(CommandPreprocessingContext<C>) - Method in class org.incendo.cloud.execution.preprocessor.AcceptingCommandPreprocessor
acceptAll() - Static method in interface org.incendo.cloud.help.CommandPredicate: Returns a new predicate which accepts all commands.
acceptedValues() - Method in class org.incendo.cloud.parser.standard.EnumParser: Returns a collection containing all accepted values.
AcceptingCommandPostprocessor<C> - Class in org.incendo.cloud.execution.postprocessor: CommandPostprocessor that does nothing besides indicating that the context has been properly processed
AcceptingCommandPostprocessor() - Constructor for class org.incendo.cloud.execution.postprocessor.AcceptingCommandPostprocessor
AcceptingCommandPreprocessor<C> - Class in org.incendo.cloud.execution.preprocessor: CommandPreprocessor that does nothing besides indicating that the context has been properly processed
AcceptingCommandPreprocessor() - Constructor for class org.incendo.cloud.execution.preprocessor.AcceptingCommandPreprocessor
addChild(CommandComponent<C>) - Method in class org.incendo.cloud.internal.CommandNode: Adds the given component as a child of this node
addPreprocessor(ComponentPreprocessor<C>) - Method in class org.incendo.cloud.component.CommandComponent: Registers a new preprocessor.
addPresenceFlag(CommandFlag<?>) - Method in class org.incendo.cloud.parser.flag.FlagContext: Indicate that a presence flag was supplied
addSuggestion(Suggestion) - Method in class org.incendo.cloud.internal.SuggestionContext: Adds the given suggestion to the stored suggestions
addSuggestions(Iterable<? extends Suggestion>) - Method in class org.incendo.cloud.internal.SuggestionContext: Adds all the given suggestions to the stored suggestions
addValueFlag(CommandFlag<T>, T) - Method in class org.incendo.cloud.parser.flag.FlagContext: Store a value associated with a value flag
AFTER_REGISTRATION - Enum constant in enum org.incendo.cloud.state.RegistrationState: Once registration has been completed.
AggregateParser<C,O> - Interface in org.incendo.cloud.parser.aggregate: An argument parser that delegates to multiple inner AggregateParser.components() and transforms the aggregate results into an output using the AggregateParser.mapper().
AggregateParser.AggregateParseException - Exception Class in org.incendo.cloud.parser.aggregate
AggregateParserBuilder<C> - Class in org.incendo.cloud.parser.aggregate
AggregateParserBuilder.MappedAggregateParserBuilder<C,O> - Class in org.incendo.cloud.parser.aggregate
AggregateParserPairBuilder<C,U,V,O> - Class in org.incendo.cloud.parser.aggregate
AggregateParserPairBuilder(TypedCommandComponent<C, U>, TypedCommandComponent<C, V>, AggregateParserPairBuilder.Mapper<C, U, V, O>, TypeToken<O>) - Constructor for class org.incendo.cloud.parser.aggregate.AggregateParserPairBuilder: Creates a new AggregateParserPairBuilder with the given components and mapper.
AggregateParserPairBuilder.Mapper<C,U,V,O> - Interface in org.incendo.cloud.parser.aggregate
AggregateParserPairBuilder.Mapper.DirectSuccessMapper<C,U,V,O> - Interface in org.incendo.cloud.parser.aggregate
AggregateParserTripletBuilder<C,U,V,Z,O> - Class in org.incendo.cloud.parser.aggregate
AggregateParserTripletBuilder(TypedCommandComponent<C, U>, TypedCommandComponent<C, V>, TypedCommandComponent<C, Z>, AggregateParserTripletBuilder.Mapper<C, U, V, Z, O>, TypeToken<O>) - Constructor for class org.incendo.cloud.parser.aggregate.AggregateParserTripletBuilder: Creates a new AggregateParserTripletBuilder with the given components and mapper.
AggregateParserTripletBuilder.Mapper<C,U,V,Z,O> - Interface in org.incendo.cloud.parser.aggregate
AggregateParserTripletBuilder.Mapper.DirectSuccessMapper<C,U,V,Z,O> - Interface in org.incendo.cloud.parser.aggregate
AggregateParsingContext<C> - Interface in org.incendo.cloud.parser.aggregate: Context that stores the individual result of invoking the child parsers of a AggregateParser.
AggregateResultMapper<C,O> - Interface in org.incendo.cloud.parser.aggregate: Mapper that maps the result of invoking the inner parsers of a AggregateParser.
AggregateResultMapper.DirectSuccessMapper<C,O> - Interface in org.incendo.cloud.parser.aggregate
aliases() - Method in interface org.incendo.cloud.bean.CommandProperties: Returns an unmodifiable view of the command aliases.
aliases() - Method in class org.incendo.cloud.component.CommandComponent: Returns the aliases, if relevant.
aliases() - Method in class org.incendo.cloud.parser.flag.CommandFlag: Returns the flag aliases, not including the CommandFlag.name().
aliases() - Method in class org.incendo.cloud.parser.standard.LiteralParser: Returns the aliases, if relevant.
all() - Method in class org.incendo.cloud.context.CommandContext
all() - Method in interface org.incendo.cloud.key.CloudKeyContainer: Returns all stored values.
all() - Method in class org.incendo.cloud.key.SimpleMutableCloudKeyContainer
all() - Method in class org.incendo.cloud.meta.SimpleCommandMeta
allOf(Collection<Permission>) - Static method in interface org.incendo.cloud.permission.Permission: Creates a new AND permission that evaluates to true if all the given permissions evaluate to true.
allOf(Permission...) - Static method in interface org.incendo.cloud.permission.Permission: Creates a new AND permission that evaluates to true if all the given permissions evaluate to true.
ALLOW_UNSAFE_REGISTRATION - Enum constant in enum org.incendo.cloud.setting.ManagerSetting: Allow registering commands even when doing so has the potential to produce inconsistent results.
allowed() - Method in interface org.incendo.cloud.permission.PermissionResult: Returns true if the command may be executed.
allowed(Permission) - Static method in interface org.incendo.cloud.permission.PermissionResult: Creates a successful result for the given permission.
alternativeAliases() - Method in class org.incendo.cloud.component.CommandComponent: Returns the aliases excluding the name, if relevant.
alternativeAliases() - Method in class org.incendo.cloud.parser.standard.LiteralParser: Returns the aliases excluding the name, if relevant.
ambiguousNode() - Method in exception class org.incendo.cloud.exception.AmbiguousNodeException: Returns the ambiguous node.
AmbiguousNodeException - Exception Class in org.incendo.cloud.exception: Exception thrown when a CommandContext is being inserted into a CommandTree and an ambiguity is detected.
AmbiguousNodeException(CommandNode<?>, CommandNode<?>, List<CommandNode<?>>) - Constructor for exception class org.incendo.cloud.exception.AmbiguousNodeException: Construct a new ambiguous node exception
and(Permission) - Method in interface org.incendo.cloud.permission.Permission: Returns a permission that matches this permission and the other permission.
and(Permission...) - Method in interface org.incendo.cloud.permission.Permission: Returns a permission that matches this permission and all of the other permissions.
and(FilteringSuggestionProcessor.Filter<C>) - Method in interface org.incendo.cloud.suggestion.FilteringSuggestionProcessor.Filter: Returns a new FilteringSuggestionProcessor.Filter which tests this filter, and if the result is non-null, then filters with and.
AndPermission - Class in org.incendo.cloud.permission: Accepts if every single permission is accepted.
annotation(Class<A>) - Method in interface org.incendo.cloud.util.annotation.AnnotationAccessor: Get an annotation instance, if it's present.
annotation(Class<A>) - Method in class org.incendo.cloud.util.annotation.AnnotationAccessor.NullAnnotationAccessor
annotationAccessor() - Method in interface org.incendo.cloud.injection.InjectionRequest: Returns an annotation accessor that can be used to access the annotations of the field that is being injected.
AnnotationAccessor - Interface in org.incendo.cloud.util.annotation: Managed access for Annotation instances
AnnotationAccessor.NullAnnotationAccessor - Class in org.incendo.cloud.util.annotation: Annotation accessor that cannot access any annotations
annotations() - Method in interface org.incendo.cloud.util.annotation.AnnotationAccessor: Get an immutable collection containing all of the annotations that are accessible using the annotation accessor
annotations() - Method in class org.incendo.cloud.util.annotation.AnnotationAccessor.NullAnnotationAccessor
anyOf(Collection<Permission>) - Static method in interface org.incendo.cloud.permission.Permission: Create a new OR permission that evaluates to true if any of the given permissions evaluates to true.
anyOf(Permission...) - Static method in interface org.incendo.cloud.permission.Permission: Create a new OR permission that evaluates to true if any of the given permissions evaluates to true.
appendAggregate(CommandComponent<?>, AggregateParser<?, ?>) - Method in class org.incendo.cloud.syntax.StandardCommandSyntaxFormatter.FormattingInstance: Append an aggregate component to the syntax string
appendBlankSpace() - Method in class org.incendo.cloud.syntax.StandardCommandSyntaxFormatter.FormattingInstance: Append a blank space
appendFlag(CommandFlagParser<?>) - Method in class org.incendo.cloud.syntax.StandardCommandSyntaxFormatter.FormattingInstance: Appends a flag argument
appendHandler(CommandExecutionHandler<C>) - Method in class org.incendo.cloud.Command.Builder: Sets a new command execution handler that invokes the given handler after the current handler.
appendLiteral(CommandComponent<?>) - Method in class org.incendo.cloud.syntax.StandardCommandSyntaxFormatter.FormattingInstance: Append a literal to the syntax string
appendName(String) - Method in class org.incendo.cloud.syntax.StandardCommandSyntaxFormatter.FormattingInstance: Append an argument name
appendOptional(CommandComponent<?>) - Method in class org.incendo.cloud.syntax.StandardCommandSyntaxFormatter.FormattingInstance: Append an optional argument
appendPipe() - Method in class org.incendo.cloud.syntax.StandardCommandSyntaxFormatter.FormattingInstance: Append the pipe (|) character
appendRequired(CommandComponent<?>) - Method in class org.incendo.cloud.syntax.StandardCommandSyntaxFormatter.FormattingInstance: Append a required argument
appendString(String) - Method in interface org.incendo.cloud.context.CommandInput: Suffixes the input with the given string and return a new command input containing the updated string.
appendSuggestionMapper(SuggestionMapper<? extends Suggestion>) - Method in class org.incendo.cloud.CommandManager: Sets the suggestion mapper for CommandManager.suggestionFactory() to the result of appending the provided mapper to the current mapper using SuggestionMapper.then(SuggestionMapper).
apply(C, List<CommandComponent<C>>, CommandNode<C>) - Method in interface org.incendo.cloud.syntax.CommandSyntaxFormatter: Format the command arguments into a syntax string
apply(C, List<CommandComponent<C>>, CommandNode<C>) - Method in class org.incendo.cloud.syntax.StandardCommandSyntaxFormatter: Format the command arguments into a syntax string
apply(Command.Builder.Applicable<C>) - Method in class org.incendo.cloud.Command.Builder: Applies the provided Command.Builder.Applicable to this Command.Builder, and returns the result.
applyToCommandBuilder(Command.Builder<C>) - Method in interface org.incendo.cloud.Command.Builder.Applicable: Accepts a Command.Builder and returns either the same or a modified Command.Builder instance.
argument(CommandComponent<? super C>) - Method in class org.incendo.cloud.Command.Builder: Adds the given argument to the command.
argument(CommandComponent.Builder<? super C, T>) - Method in class org.incendo.cloud.Command.Builder: Adds the given argument to the command.
ARGUMENT_PARSE_FAILURE_AGGREGATE_COMPONENT_FAILURE - Static variable in class org.incendo.cloud.caption.StandardCaptionKeys: Variables: <input>, <component>, <failure>
ARGUMENT_PARSE_FAILURE_AGGREGATE_COMPONENT_FAILURE - Static variable in class org.incendo.cloud.caption.StandardCaptionsProvider: Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_AGGREGATE_COMPONENT_FAILURE
ARGUMENT_PARSE_FAILURE_AGGREGATE_MISSING_INPUT - Static variable in class org.incendo.cloud.caption.StandardCaptionKeys: Variables: <input>, <component>
ARGUMENT_PARSE_FAILURE_AGGREGATE_MISSING_INPUT - Static variable in class org.incendo.cloud.caption.StandardCaptionsProvider: Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_AGGREGATE_MISSING_INPUT
ARGUMENT_PARSE_FAILURE_BOOLEAN - Static variable in class org.incendo.cloud.caption.StandardCaptionKeys: Variables: <input>
ARGUMENT_PARSE_FAILURE_BOOLEAN - Static variable in class org.incendo.cloud.caption.StandardCaptionsProvider: Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_BOOLEAN.
ARGUMENT_PARSE_FAILURE_CHAR - Static variable in class org.incendo.cloud.caption.StandardCaptionKeys: Variables: <input>
ARGUMENT_PARSE_FAILURE_CHAR - Static variable in class org.incendo.cloud.caption.StandardCaptionsProvider: Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_CHAR
ARGUMENT_PARSE_FAILURE_COLOR - Static variable in class org.incendo.cloud.caption.StandardCaptionKeys: Variables: <input>
ARGUMENT_PARSE_FAILURE_COLOR - Static variable in class org.incendo.cloud.caption.StandardCaptionsProvider: Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_COLOR
ARGUMENT_PARSE_FAILURE_DURATION - Static variable in class org.incendo.cloud.caption.StandardCaptionKeys: Variables: <input>
ARGUMENT_PARSE_FAILURE_DURATION - Static variable in class org.incendo.cloud.caption.StandardCaptionsProvider: Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_DURATION
ARGUMENT_PARSE_FAILURE_EITHER - Static variable in class org.incendo.cloud.caption.StandardCaptionKeys: Variables: <input>, <primary>, <fallback>
ARGUMENT_PARSE_FAILURE_EITHER - Static variable in class org.incendo.cloud.caption.StandardCaptionsProvider: Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_EITHER
ARGUMENT_PARSE_FAILURE_ENUM - Static variable in class org.incendo.cloud.caption.StandardCaptionKeys: Variables: <input>, <acceptableValues>
ARGUMENT_PARSE_FAILURE_ENUM - Static variable in class org.incendo.cloud.caption.StandardCaptionsProvider: Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_ENUM
ARGUMENT_PARSE_FAILURE_FLAG_DUPLICATE_FLAG - Static variable in class org.incendo.cloud.caption.StandardCaptionKeys: Variables: <flag>
ARGUMENT_PARSE_FAILURE_FLAG_DUPLICATE_FLAG - Static variable in class org.incendo.cloud.caption.StandardCaptionsProvider: Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_FLAG_DUPLICATE_FLAG
ARGUMENT_PARSE_FAILURE_FLAG_MISSING_ARGUMENT - Static variable in class org.incendo.cloud.caption.StandardCaptionKeys: Variables: <flag>
ARGUMENT_PARSE_FAILURE_FLAG_MISSING_ARGUMENT - Static variable in class org.incendo.cloud.caption.StandardCaptionsProvider: Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_FLAG_MISSING_ARGUMENT
ARGUMENT_PARSE_FAILURE_FLAG_NO_FLAG_STARTED - Static variable in class org.incendo.cloud.caption.StandardCaptionKeys: Variables: <input>
ARGUMENT_PARSE_FAILURE_FLAG_NO_FLAG_STARTED - Static variable in class org.incendo.cloud.caption.StandardCaptionsProvider: Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_FLAG_NO_FLAG_STARTED
ARGUMENT_PARSE_FAILURE_FLAG_NO_PERMISSION - Static variable in class org.incendo.cloud.caption.StandardCaptionKeys: Variables: <flag>
ARGUMENT_PARSE_FAILURE_FLAG_NO_PERMISSION - Static variable in class org.incendo.cloud.caption.StandardCaptionsProvider: Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_FLAG_NO_PERMISSION
ARGUMENT_PARSE_FAILURE_FLAG_UNKNOWN_FLAG - Static variable in class org.incendo.cloud.caption.StandardCaptionKeys: Variables: <flag>
ARGUMENT_PARSE_FAILURE_FLAG_UNKNOWN_FLAG - Static variable in class org.incendo.cloud.caption.StandardCaptionsProvider: Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_FLAG_UNKNOWN_FLAG
ARGUMENT_PARSE_FAILURE_NUMBER - Static variable in class org.incendo.cloud.caption.StandardCaptionKeys: Variables: <input>, <min>, <max>
ARGUMENT_PARSE_FAILURE_NUMBER - Static variable in class org.incendo.cloud.caption.StandardCaptionsProvider: Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_NUMBER
ARGUMENT_PARSE_FAILURE_REGEX - Static variable in class org.incendo.cloud.caption.StandardCaptionKeys: Variables: <input>, <pattern>
ARGUMENT_PARSE_FAILURE_REGEX - Static variable in class org.incendo.cloud.caption.StandardCaptionsProvider: Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_REGEX
ARGUMENT_PARSE_FAILURE_STRING - Static variable in class org.incendo.cloud.caption.StandardCaptionKeys: Variables: <input>, <stringMode>
ARGUMENT_PARSE_FAILURE_STRING - Static variable in class org.incendo.cloud.caption.StandardCaptionsProvider: Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_STRING
ARGUMENT_PARSE_FAILURE_UUID - Static variable in class org.incendo.cloud.caption.StandardCaptionKeys: Variables: <input>
ARGUMENT_PARSE_FAILURE_UUID - Static variable in class org.incendo.cloud.caption.StandardCaptionsProvider: Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_UUID
argumentContext(AggregateParser<C, ?>) - Static method in interface org.incendo.cloud.parser.aggregate.AggregateParsingContext: Returns a new argument context instance that accepts values for the inner parsers of the given parser.
ArgumentParseException - Exception Class in org.incendo.cloud.exception
ArgumentParseException(Throwable, Object, List<CommandComponent<?>>) - Constructor for exception class org.incendo.cloud.exception.ArgumentParseException: Create a new command parse exception
ArgumentParser<C,T> - Interface in org.incendo.cloud.parser: Parser that parses strings into values of a specific type
ArgumentParser.FutureArgumentParser<C,T> - Interface in org.incendo.cloud.parser: Utility interface extending ArgumentParser to make it easier to implement ArgumentParser.FutureArgumentParser.parseFuture(CommandContext, CommandInput).
argumentParserClass() - Method in exception class org.incendo.cloud.exception.parsing.ParserException: Returns the argument parser class.
ArgumentParseResult<T> - Class in org.incendo.cloud.parser: Result of the parsing done by a ArgumentParser
asFuture() - Method in class org.incendo.cloud.parser.ArgumentParseResult: Maps the result to a completable future.
asRepeatable() - Method in class org.incendo.cloud.parser.flag.CommandFlag.Builder: Marks the flag as CommandFlag.FlagMode.REPEATABLE.
asyncCoordinator() - Static method in interface org.incendo.cloud.execution.ExecutionCoordinator: Create a new execution coordinator that schedules to the common pool at every possible point in the pipeline.

B

baseParser() - Method in interface org.incendo.cloud.parser.MappedArgumentParser: Get the parser this one is derived from.
baseParser() - Method in class org.incendo.cloud.parser.MappedArgumentParserImpl
BEFORE_REGISTRATION - Enum constant in enum org.incendo.cloud.state.RegistrationState: The point when no commands have been registered yet.
blocking(BlockingSuggestionProvider<C>) - Static method in interface org.incendo.cloud.suggestion.SuggestionProvider: Utility method to simplify implementing BlockingSuggestionProvider using a lambda, for methods that accept a SuggestionProvider.
blockingStrings(BlockingSuggestionProvider.Strings<C>) - Static method in interface org.incendo.cloud.suggestion.SuggestionProvider: Utility method to simplify implementing BlockingSuggestionProvider.Strings using a lambda, for methods that accept a SuggestionProvider.
BlockingSuggestionProvider<C> - Interface in org.incendo.cloud.suggestion: Specialized variant of SuggestionProvider that does work on the calling thread.
BlockingSuggestionProvider.Strings<C> - Interface in org.incendo.cloud.suggestion: Specialized variant of BlockingSuggestionProvider that has String results instead of Suggestion results.
BOOLEAN_LIBERAL - Static variable in interface org.incendo.cloud.context.CommandInput
BOOLEAN_LIBERAL_TRUE - Static variable in interface org.incendo.cloud.context.CommandInput
BOOLEAN_STRICT - Static variable in interface org.incendo.cloud.context.CommandInput
booleanComponent() - Static method in class org.incendo.cloud.parser.standard.BooleanParser: Returns a CommandComponent.Builder using BooleanParser.booleanParser() as the parser.
BooleanParseException(String, boolean, CommandContext<?>) - Constructor for exception class org.incendo.cloud.parser.standard.BooleanParser.BooleanParseException: Construct a new boolean parse exception
booleanParser() - Static method in class org.incendo.cloud.parser.standard.BooleanParser: Creates a new boolean parser that only accepts true and false.
booleanParser(boolean) - Static method in class org.incendo.cloud.parser.standard.BooleanParser: Creates a new boolean parser.
BooleanParser<C> - Class in org.incendo.cloud.parser.standard
BooleanParser(boolean) - Constructor for class org.incendo.cloud.parser.standard.BooleanParser: Construct a new boolean parser
BooleanParser.BooleanParseException - Exception Class in org.incendo.cloud.parser.standard: Boolean parse exception
build() - Method in class org.incendo.cloud.caption.ImmutableConstantCaptionProvider.Builder: Builds a new ImmutableConstantCaptionProvider.
build() - Method in class org.incendo.cloud.Command.Builder: Builds a command using the builder instance.
build() - Method in class org.incendo.cloud.component.CommandComponent.Builder: Builds a command component using this builder.
build() - Method in class org.incendo.cloud.exception.handling.ExceptionHandlerRegistration.ExceptionControllerBuilder: Builds a registration from this builder.
build() - Method in interface org.incendo.cloud.execution.ExecutionCoordinator.Builder: Creates a new ExecutionCoordinator from the current state of this builder.
build() - Method in class org.incendo.cloud.meta.CommandMetaBuilder: Builds a new CommandMeta instance using the stored key-value pairs.
build() - Method in class org.incendo.cloud.parser.aggregate.AggregateParserBuilder.MappedAggregateParserBuilder: Builds the parser described by this builder.
build() - Method in class org.incendo.cloud.parser.aggregate.AggregateParserPairBuilder: Builds an AggregateParser from the current state of the builder.
build() - Method in class org.incendo.cloud.parser.aggregate.AggregateParserTripletBuilder: Builds an AggregateParser from the current state of the builder.
build() - Method in class org.incendo.cloud.parser.flag.CommandFlag.Builder: Build a new command flag instance
builder() - Static method in class org.incendo.cloud.caption.ImmutableConstantCaptionProvider: Creates a builder for ImmutableConstantCaptionProvider.
builder() - Static method in class org.incendo.cloud.component.CommandComponent: Creates a new mutable builder.
builder() - Static method in interface org.incendo.cloud.execution.ExecutionCoordinator: Creates a new ExecutionCoordinator.Builder.
builder() - Static method in class org.incendo.cloud.meta.CommandMeta: Create a new simple command meta-builder
builder() - Static method in interface org.incendo.cloud.parser.aggregate.AggregateParser: Returns a new aggregate command parser builder.
builder(TypeToken<T>) - Static method in class org.incendo.cloud.exception.handling.ExceptionHandlerRegistration: Returns a builder.
builder(String) - Static method in class org.incendo.cloud.parser.flag.CommandFlag: Create a new CommandFlag.Builder.
builder(String, ParserDescriptor<? super C, T>) - Static method in class org.incendo.cloud.component.CommandComponent: Creates a new mutable builder.
builder(CloudKey<T>, ParserDescriptor<? super C, T>) - Static method in class org.incendo.cloud.component.CommandComponent: Creates a new mutable builder.
Builder() - Constructor for class org.incendo.cloud.component.CommandComponent.Builder
byteComponent() - Static method in class org.incendo.cloud.parser.standard.ByteParser: Returns a CommandComponent.Builder using ByteParser.byteParser() as the parser.
ByteParseException(String, ByteParser<?>, CommandContext<?>) - Constructor for exception class org.incendo.cloud.parser.standard.ByteParser.ByteParseException: Create a new ByteParser.ByteParseException.
byteParser() - Static method in class org.incendo.cloud.parser.standard.ByteParser: Creates a new byte parser using ByteParser.DEFAULT_MINIMUM and ByteParser.DEFAULT_MAXIMUM as the limits.
byteParser(byte) - Static method in class org.incendo.cloud.parser.standard.ByteParser: Creates a new byte parser using ByteParser.DEFAULT_MAXIMUM as the maximum value.
byteParser(byte, byte) - Static method in class org.incendo.cloud.parser.standard.ByteParser: Creates a new byte parser.
ByteParser<C> - Class in org.incendo.cloud.parser.standard
ByteParser(byte, byte) - Constructor for class org.incendo.cloud.parser.standard.ByteParser: Construct a new byte parser
ByteParser.ByteParseException - Exception Class in org.incendo.cloud.parser.standard
byteRange(byte, byte) - Static method in interface org.incendo.cloud.type.range.Range: Creates a new range.
ByteRange - Interface in org.incendo.cloud.type.range

C

capabilities() - Method in class org.incendo.cloud.CommandManager: Returns an unmodifiable snapshot of the currently registered capabilities.
caption() - Method in enum org.incendo.cloud.parser.flag.CommandFlagParser.FailureReason: Returns the caption used for this failure reason.
caption(Caption, C) - Method in interface org.incendo.cloud.caption.CaptionRegistry: Returns the value of the given caption for the given sender.
caption(Caption, C) - Method in class org.incendo.cloud.caption.CaptionRegistryImpl
Caption - Interface in org.incendo.cloud.caption: This is a reference to a caption and does not contain any message itself.
captionFormatter() - Method in class org.incendo.cloud.CommandManager: Returns the string-producing caption formatter.
captionFormatter(CaptionFormatter<C, String>) - Method in class org.incendo.cloud.CommandManager: Sets the string-producing caption formatter.
CaptionFormatter<C,T> - Interface in org.incendo.cloud.caption
CaptionFormatter.PatternReplacingCaptionFormatter<C> - Class in org.incendo.cloud.caption
CaptionProvider<C> - Interface in org.incendo.cloud.caption
captionRegistry() - Static method in interface org.incendo.cloud.caption.CaptionRegistry: Creates a new caption registry with no providers registered.
captionRegistry() - Method in class org.incendo.cloud.CommandManager: Returns the caption registry.
captionRegistry(CaptionRegistry<C>) - Method in class org.incendo.cloud.CommandManager: Replaces the caption registry.
CaptionRegistry<C> - Interface in org.incendo.cloud.caption: Registry that allows for messages to be configurable per-sender.
CaptionRegistryImpl<C> - Class in org.incendo.cloud.caption
captions() - Method in class org.incendo.cloud.caption.ConstantCaptionProvider: Returns all recognized captions and their corresponding constant values.
captions() - Method in class org.incendo.cloud.caption.ImmutableConstantCaptionProvider: Returns all recognized captions and their corresponding constant values.
captions(Map<? extends Caption, ? extends String>) - Method in class org.incendo.cloud.caption.ImmutableConstantCaptionProvider.Builder: Sets or replaces all mappings from the specified map as entries for the captions map.
CaptionVariable - Interface in org.incendo.cloud.caption: Key-value pair used to replace variables in captions.
captionVariables() - Method in exception class org.incendo.cloud.exception.parsing.ParserException: Get a copy of the caption variables present in this parser exception.
characterComponent() - Static method in class org.incendo.cloud.parser.standard.CharacterParser: Returns a CommandComponent.Builder using CharacterParser.characterParser() as the parser.
characterComponent() - Static method in class org.incendo.cloud.parser.standard.StringArrayParser: Returns a CommandComponent.Builder using StringArrayParser.stringArrayParser() as the parser.
characterParser() - Static method in class org.incendo.cloud.parser.standard.CharacterParser: Creates a new character parser.
CharacterParser<C> - Class in org.incendo.cloud.parser.standard
CharacterParser() - Constructor for class org.incendo.cloud.parser.standard.CharacterParser
CharacterParser.CharParseException - Exception Class in org.incendo.cloud.parser.standard: Char parse exception
CharParseException(String, CommandContext<?>) - Constructor for exception class org.incendo.cloud.parser.standard.CharacterParser.CharParseException: Construct a new Char parse exception
children() - Method in exception class org.incendo.cloud.exception.AmbiguousNodeException: Returns all children of the parent.
children() - Method in class org.incendo.cloud.internal.CommandNode: Returns an immutable view of the node's children
childSuggestions() - Method in interface org.incendo.cloud.help.result.MultipleCommandResult: Returns syntax hints for the children.
clearHandlers() - Method in class org.incendo.cloud.exception.handling.ExceptionController: Removes all registered handlers.
CloudCapability - Interface in org.incendo.cloud: Represents a capability that a cloud implementation may have.
CloudCapability.CloudCapabilityMissingException - Exception Class in org.incendo.cloud: Exception thrown when a CloudCapability is missing, when a method that requires the presence of that capability is invoked.
CloudCapability.StandardCapabilities - Enum in org.incendo.cloud: Standard capabilities.
CloudCapabilityMissingException(CloudCapability) - Constructor for exception class org.incendo.cloud.CloudCapability.CloudCapabilityMissingException: Create a new cloud capability missing exception instance.
cloudKey(String) - Static method in class org.incendo.cloud.key.CloudKey: Creates a new type-less key.
cloudKey(String, TypeToken<T>) - Static method in class org.incendo.cloud.key.CloudKey: Creates a new key.
cloudKey(String, Class<T>) - Static method in class org.incendo.cloud.key.CloudKey: Creates a new key.
CloudKey<T> - Class in org.incendo.cloud.key: A typed, named key.
CloudKey() - Constructor for class org.incendo.cloud.key.CloudKey
CloudKeyContainer - Interface in org.incendo.cloud.key
CloudKeyHolder<T> - Interface in org.incendo.cloud.key: Represents any object that holds a CloudKey
command() - Method in class org.incendo.cloud.context.CommandContext: Returns the current Command.
command() - Method in exception class org.incendo.cloud.exception.InvalidCommandSenderException: Returns the Command which the sender is invalid for.
command() - Method in interface org.incendo.cloud.execution.postprocessor.CommandPostprocessingContext: Returns the command instance.
command() - Method in interface org.incendo.cloud.help.result.CommandEntry: Returns the command.
command() - Method in class org.incendo.cloud.internal.CommandNode: Returns the command that the CommandNode.component() belongs to, if the CommandNode.component() is executable.
command(Command<? extends C>) - Method in class org.incendo.cloud.CommandManager: Register a new command to the command manager and insert it into the underlying command tree.
command(Command<C>) - Method in class org.incendo.cloud.context.CommandContext: Sets the current Command.
command(Command<C>) - Method in class org.incendo.cloud.internal.CommandNode: Sets the executable command of this node.
command(CommandFactory<C>) - Method in class org.incendo.cloud.CommandManager: Creates a command using the given commandFactory and inserts it into the underlying command tree.
command(Command.Builder<? extends C>) - Method in class org.incendo.cloud.CommandManager: Register a new command
Command<C> - Class in org.incendo.cloud: A command is a chain of command components with an associated Command.commandExecutionHandler().
Command(List<CommandComponent<C>>, CommandExecutionHandler<C>, Type, Permission, CommandMeta, CommandDescription) - Constructor for class org.incendo.cloud.Command: Constructs a new command instance.
Command.Builder<C> - Class in org.incendo.cloud: Builder for Command instances.
Command.Builder.Applicable<C> - Interface in org.incendo.cloud: Essentially a UnaryOperator for Command.Builder, but as a separate interface to avoid conflicts.
CommandBean<C> - Class in org.incendo.cloud.bean: An alternative way of registering commands, where each command lives in a separate class.
CommandBean() - Constructor for class org.incendo.cloud.bean.CommandBean
commandBuilder(String, String...) - Method in interface org.incendo.cloud.CommandBuilderSource: Creates a new command builder using default command meta created by CommandBuilderSource.createDefaultCommandMeta(), and an empty description.
commandBuilder(String, Collection<String>, Description, CommandMeta) - Method in interface org.incendo.cloud.CommandBuilderSource: Creates a new command builder.
commandBuilder(String, Collection<String>, CommandMeta) - Method in interface org.incendo.cloud.CommandBuilderSource: Creates a new command builder with an empty description.
commandBuilder(String, Description, String...) - Method in interface org.incendo.cloud.CommandBuilderSource: Create a new command builder using default command meta created by CommandBuilderSource.createDefaultCommandMeta().
commandBuilder(String, CommandMeta, String...) - Method in interface org.incendo.cloud.CommandBuilderSource: Creates a new command builder with an empty description.
commandBuilder(String, CommandMeta, Description, String...) - Method in interface org.incendo.cloud.CommandBuilderSource: Creates a new command builder.
CommandBuilderSource<C> - Interface in org.incendo.cloud
commandComponent() - Method in exception class org.incendo.cloud.exception.NoCommandInLeafException: Returns the command component.
commandComponent() - Method in class org.incendo.cloud.parser.flag.CommandFlag: Returns the command component, if this is a value flag.
CommandComponent<C> - Class in org.incendo.cloud.component: A single literal or argument component of a command
CommandComponent.Builder<C,T> - Class in org.incendo.cloud.component
CommandComponent.ComponentType - Enum in org.incendo.cloud.component
commandContext() - Method in interface org.incendo.cloud.execution.CommandResult: Returns the command context.
commandContext() - Method in interface org.incendo.cloud.execution.postprocessor.CommandPostprocessingContext: Returns the command context.
commandContext() - Method in interface org.incendo.cloud.execution.preprocessor.CommandPreprocessingContext: Returns the command context.
commandContext() - Method in interface org.incendo.cloud.injection.InjectionRequest: Returns the context associated with the request.
commandContext() - Method in class org.incendo.cloud.internal.SuggestionContext: Returns the command context
commandContext() - Method in interface org.incendo.cloud.suggestion.Suggestions: Returns the command context.
CommandContext<C> - Class in org.incendo.cloud.context: Command context used to assist in the parsing of commands
CommandContext(boolean, C, CommandManager<C>) - Constructor for class org.incendo.cloud.context.CommandContext: Creates a new command context instance.
CommandContext(C, CommandManager<C>) - Constructor for class org.incendo.cloud.context.CommandContext: Creates a new command context instance.
CommandContextFactory<C> - Interface in org.incendo.cloud.context: Factory for CommandContext instances
commandDescription() - Method in class org.incendo.cloud.Command.Builder: Returns the current command description of this command builder.
commandDescription() - Method in class org.incendo.cloud.Command: Returns the description of the command.
commandDescription(String) - Static method in interface org.incendo.cloud.description.CommandDescription: Returns a new command description using the given description.
commandDescription(String, String) - Static method in interface org.incendo.cloud.description.CommandDescription: Returns a new command description using the given description and verboseDescription.
commandDescription(CommandDescription) - Method in class org.incendo.cloud.Command.Builder: Returns a new builder with the given commandDescription.
commandDescription(Description) - Method in class org.incendo.cloud.Command.Builder: Returns the result of invoking Command.Builder.commandDescription(CommandDescription) with the result of CommandDescription.commandDescription(Description).
commandDescription(Description) - Static method in interface org.incendo.cloud.description.CommandDescription: Returns a new command description using the given description.
commandDescription(Description, Description) - Method in class org.incendo.cloud.Command.Builder: Returns the result of invoking Command.Builder.commandDescription(CommandDescription) with the result of CommandDescription.commandDescription(Description, Description).
commandDescription(Description, Description) - Static method in interface org.incendo.cloud.description.CommandDescription: Returns a new command description using the given description and verboseDescription.
CommandDescription - Interface in org.incendo.cloud.description
CommandEntry<C> - Interface in org.incendo.cloud.help.result
CommandExecutionException - Exception Class in org.incendo.cloud.exception: Exception thrown when there is an exception during execution of a command handler
CommandExecutionException(Throwable) - Constructor for exception class org.incendo.cloud.exception.CommandExecutionException: Exception thrown when there is an exception during execution of a command handler
CommandExecutionException(Throwable, CommandContext<?>) - Constructor for exception class org.incendo.cloud.exception.CommandExecutionException: Exception thrown when there is an exception during execution of a command handler
commandExecutionHandler() - Method in class org.incendo.cloud.Command: Returns the command execution handler.
CommandExecutionHandler<C> - Interface in org.incendo.cloud.execution: Handler that is invoked whenever a Command is executed by a command sender
CommandExecutionHandler.FutureCommandExecutionHandler<C> - Interface in org.incendo.cloud.execution: Handler that is invoked whenever a Command is executed by a command sender
commandExecutor() - Method in class org.incendo.cloud.CommandManager: Returns the command executor.
CommandExecutor<C> - Interface in org.incendo.cloud.execution
CommandFactory<C> - Interface in org.incendo.cloud: Factory producing command instances
CommandFlag<T> - Class in org.incendo.cloud.parser.flag: A flag is an optional command component that may have an associated parser, and is identified by its name.
CommandFlag.Builder<C,T> - Class in org.incendo.cloud.parser.flag
CommandFlag.FlagMode - Enum in org.incendo.cloud.parser.flag
CommandFlagParser<C> - Class in org.incendo.cloud.parser.flag
CommandFlagParser(Collection<CommandFlag<?>>) - Constructor for class org.incendo.cloud.parser.flag.CommandFlagParser: Creates a new command flag parser.
CommandFlagParser.FailureReason - Enum in org.incendo.cloud.parser.flag: Reasons for which flag parsing may fail
CommandFlagParser.FlagParseException - Exception Class in org.incendo.cloud.parser.flag: Flag parse exception
commandInput() - Method in interface org.incendo.cloud.execution.preprocessor.CommandPreprocessingContext: Returns the original input.
commandInput() - Method in interface org.incendo.cloud.suggestion.Suggestions: Returns the CommandInput as seen by the last suggestion provider.
CommandInput - Interface in org.incendo.cloud.context
CommandInput.CursorOutOfBoundsException - Exception Class in org.incendo.cloud.context
CommandInputTokenizer - Class in org.incendo.cloud.internal: Tokenizer that splits command inputs into tokens.
CommandInputTokenizer(String) - Constructor for class org.incendo.cloud.internal.CommandInputTokenizer: Create a new input tokenizer
commandManager() - Method in class org.incendo.cloud.CommandTree: Returns the command manager that was used to create this command tree
commandManager(CommandManager<C>) - Method in class org.incendo.cloud.component.CommandComponent.Builder: Sets the command manager, which will be used to create a parser if none is provided.
CommandManager<C> - Class in org.incendo.cloud: The manager is responsible for command registration, parsing delegation, etc.
CommandManager(ExecutionCoordinator<C>, CommandRegistrationHandler<C>) - Constructor for class org.incendo.cloud.CommandManager: Create a new command manager instance.
commandMeta() - Method in class org.incendo.cloud.Command: Returns the meta-data associated with the command.
CommandMeta - Class in org.incendo.cloud.meta: Object that is associated with a Command.
CommandMeta() - Constructor for class org.incendo.cloud.meta.CommandMeta
CommandMetaBuilder - Class in org.incendo.cloud.meta
CommandNode<C> - Class in org.incendo.cloud.internal: Very simple tree structure
CommandNode(CommandComponent<C>) - Constructor for class org.incendo.cloud.internal.CommandNode: Creates a new command node
CommandParseException - Exception Class in org.incendo.cloud.exception: Exception thrown when parsing user input into a command
CommandParseException(Object, List<CommandComponent<?>>) - Constructor for exception class org.incendo.cloud.exception.CommandParseException: Construct a new command parse exception
commandPermission() - Method in class org.incendo.cloud.Command.Builder: Returns the required command permission for this builder.
commandPermission() - Method in class org.incendo.cloud.Command: Returns the permission required to execute the command.
CommandPostprocessingContext<C> - Interface in org.incendo.cloud.execution.postprocessor: Context for command postprocessors.
CommandPostprocessor<C> - Interface in org.incendo.cloud.execution.postprocessor: Command postprocessor that acts on commands before execution
CommandPredicate<C> - Interface in org.incendo.cloud.help
CommandPreprocessingContext<C> - Interface in org.incendo.cloud.execution.preprocessor: Context for command preprocessors.
CommandPreprocessor<C> - Interface in org.incendo.cloud.execution.preprocessor: Command preprocessor that gets to act on command input before it's sent to the command parser.
commandProperties(String, String...) - Static method in interface org.incendo.cloud.bean.CommandProperties: Construct a new instance
CommandProperties - Interface in org.incendo.cloud.bean: Defines properties used by command beans to construct commands.
commandRegistrationHandler() - Method in class org.incendo.cloud.CommandManager: Returns the command registration handler.
commandRegistrationHandler(CommandRegistrationHandler<C>) - Method in class org.incendo.cloud.CommandManager
CommandRegistrationHandler<C> - Interface in org.incendo.cloud.internal: Utility that registers commands natively for whatever platform the library is used in.
CommandRegistrationHandler.NullCommandRegistrationHandler<C> - Class in org.incendo.cloud.internal
CommandResult<C> - Interface in org.incendo.cloud.execution: The result of a command execution.
commands() - Method in class org.incendo.cloud.CommandManager: Returns an unmodifiable view of all registered commands.
commands(C) - Method in class org.incendo.cloud.help.StandardHelpHandler: Returns entries for all commands that are applicable to this handler.
commandSender() - Method in exception class org.incendo.cloud.exception.CommandParseException: Returns the command sender.
commandSyntaxFormatter() - Method in class org.incendo.cloud.CommandManager: Returns the command syntax formatter.
commandSyntaxFormatter(CommandSyntaxFormatter<C>) - Method in class org.incendo.cloud.CommandManager: Sets the command syntax formatter.
CommandSyntaxFormatter<C> - Interface in org.incendo.cloud.syntax: Utility that formats chains of command components into syntax strings
commandTree() - Method in class org.incendo.cloud.CommandManager: Returns the internal command tree.
CommandTree<C> - Class in org.incendo.cloud: Tree containing all commands and command paths.
commonPoolExecutor() - Method in interface org.incendo.cloud.execution.ExecutionCoordinator.Builder: Sets ExecutionCoordinator.Builder.executor(Executor) to the common pool.
compareTo(CommandComponent<C>) - Method in class org.incendo.cloud.component.CommandComponent
compareTo(CommandEntry<C>) - Method in interface org.incendo.cloud.help.result.CommandEntry
CompletableFutures - Class in org.incendo.cloud.util: CompletableFuture extensions.
Completions - Annotation Type in org.incendo.cloud.annotation.specifier: Command completions, separated by "," or ", "
component() - Method in class org.incendo.cloud.context.ParsingContext: Return the associated component.
component() - Method in class org.incendo.cloud.internal.CommandNode: Returns the component contained in this node.
componentBuilder(Class<T>, String) - Method in class org.incendo.cloud.CommandManager: Create a new command component builder.
ComponentPreprocessor<C> - Interface in org.incendo.cloud.component.preprocessor
components() - Method in class org.incendo.cloud.Command: Returns a copy of the list of the components that make up this command.
components() - Method in interface org.incendo.cloud.parser.aggregate.AggregateParser: Returns the inner components of the parser.
computeIfAbsent(CloudKey<T>, Function<CloudKey<T>, T>) - Method in class org.incendo.cloud.context.CommandContext: Returns the value associated with the given key if it exists, else computes and stores the value returned by the given defaultFunction and then returns it.
computeIfAbsent(CloudKey<V>, Function<CloudKey<V>, V>) - Method in interface org.incendo.cloud.key.MutableCloudKeyContainer: Returns the value associated with the given key if it exists, else computes and stores the value returned by the given defaultFunction and then returns it.
computeIfAbsent(CloudKey<V>, Function<CloudKey<V>, V>) - Method in class org.incendo.cloud.key.SimpleMutableCloudKeyContainer
computeIfAbsent(CloudKeyHolder<V>, Function<CloudKey<V>, V>) - Method in interface org.incendo.cloud.key.MutableCloudKeyContainer: Returns the value associated with the given keyHolder if it exists, else computes and stores the value returned by the given defaultFunction and then returns it.
Configurable<S> - Interface in org.incendo.cloud.setting: Something with configurable settings.
configure(Command.Builder<C>) - Method in class org.incendo.cloud.bean.CommandBean: Configures the command before it's registered to the command manager.
constant(T) - Static method in interface org.incendo.cloud.component.DefaultValue: Returns a constant default value.
ConstantCaptionProvider<C> - Class in org.incendo.cloud.caption
ConstantCaptionProvider() - Constructor for class org.incendo.cloud.caption.ConstantCaptionProvider
constantInjector(T) - Static method in interface org.incendo.cloud.injection.ParameterInjector: Returns a parameter injector that always injects value.
constantProvider() - Static method in interface org.incendo.cloud.caption.CaptionProvider: Returns a builder for a ConstantCaptionProvider.
constantProvider(Caption, String) - Static method in interface org.incendo.cloud.caption.CaptionProvider: Returns a ConstantCaptionProvider that always returns value for the given caption.
consumedFrom() - Method in class org.incendo.cloud.context.ParsingContext: Index the parser consumed from.
consumedInput() - Method in class org.incendo.cloud.context.ParsingContext: Returns the consumed input.
consumedInput(CommandInput, CommandInput) - Method in class org.incendo.cloud.context.ParsingContext: Store information about consumed input post-parsing.
consumedTo() - Method in class org.incendo.cloud.context.ParsingContext: Index the parser consumed to.
contains(boolean) - Static method in interface org.incendo.cloud.suggestion.FilteringSuggestionProcessor.Filter: Create a filter using String.contains(CharSequence) that can optionally ignore case.
contains(String) - Method in interface org.incendo.cloud.key.CloudKeyContainer: Returns whether the registry contains a value associated with the given key.
contains(String) - Method in class org.incendo.cloud.parser.flag.FlagContext: Check whether a flag is present.
contains(CloudKey<?>) - Method in class org.incendo.cloud.context.CommandContext: Returns whether the registry contains a value associated with the given key.
contains(CloudKey<?>) - Method in interface org.incendo.cloud.key.CloudKeyContainer: Returns whether the registry contains a value associated with the given key.
contains(CloudKey<?>) - Method in class org.incendo.cloud.key.SimpleMutableCloudKeyContainer
contains(CloudKey<?>) - Method in class org.incendo.cloud.meta.SimpleCommandMeta: Returns whether the registry contains a value associated with the given key.
contains(CloudKeyHolder<?>) - Method in interface org.incendo.cloud.key.CloudKeyContainer: Returns whether the registry contains a value associated with the given keyHolder.
contains(CommandFlag<?>) - Method in class org.incendo.cloud.parser.flag.FlagContext: Check whether a flag is present.
context() - Method in exception class org.incendo.cloud.exception.CommandExecutionException: Returns the command context which caused this exception.
context() - Method in interface org.incendo.cloud.exception.handling.ExceptionContext: Returns the command context.
context() - Method in class org.incendo.cloud.exception.handling.ExceptionContext.ExceptionContextImpl
context() - Method in exception class org.incendo.cloud.exception.parsing.ParserException: Returns the command context.
contextFree(BiFunction<String, String, String>) - Static method in interface org.incendo.cloud.suggestion.FilteringSuggestionProcessor.Filter: Create a new context-free FilteringSuggestionProcessor.Filter.
contextFree(BiPredicate<String, String>) - Static method in interface org.incendo.cloud.suggestion.FilteringSuggestionProcessor.Filter.Simple: Create a new context-free FilteringSuggestionProcessor.Filter.Simple.
contribute(ParserRegistry<C>) - Method in interface org.incendo.cloud.parser.ParserContributor: Contributes to the registry.
controller() - Method in interface org.incendo.cloud.exception.handling.ExceptionContext: Returns the exception controller that created this context instance.
controller() - Method in class org.incendo.cloud.exception.handling.ExceptionContext.ExceptionContextImpl
coordinateExecution(CommandTree<C>, CommandContext<C>, CommandInput) - Method in interface org.incendo.cloud.execution.ExecutionCoordinator: Coordinate the execution of a command and return the result
coordinateSuggestions(CommandTree<C>, CommandContext<C>, CommandInput, SuggestionMapper<S>) - Method in interface org.incendo.cloud.execution.ExecutionCoordinator: Coordinates the execution of a suggestions query.
coordinatorFor(Executor) - Static method in interface org.incendo.cloud.execution.ExecutionCoordinator: Create a new execution coordinator that schedules to executor at every possible point in the pipeline.
copy() - Method in interface org.incendo.cloud.context.CommandInput: Returns a copy of this instance.
copyOf(ConstantCaptionProvider<C>) - Static method in class org.incendo.cloud.caption.ImmutableConstantCaptionProvider: Creates an immutable copy of a ConstantCaptionProvider value.
correctSyntax() - Method in exception class org.incendo.cloud.exception.InvalidSyntaxException: Returns the correct syntax of the command.
count(String) - Method in class org.incendo.cloud.parser.flag.FlagContext: Returns the number of values associated with the given flag.
count(CommandFlag<T>) - Method in class org.incendo.cloud.parser.flag.FlagContext: Returns the number of values associated with the given flag.
countCharOccurrences(String, char) - Static method in class org.incendo.cloud.util.StringUtils: Count the occurrences of a character in a string
create() - Static method in class org.incendo.cloud.parser.flag.FlagContext: Create a new flag context instance
create(boolean, C) - Method in interface org.incendo.cloud.context.CommandContextFactory: Creates a new command context.
create(boolean, C) - Method in class org.incendo.cloud.context.StandardCommandContextFactory
create(Injector) - Static method in class org.incendo.cloud.injection.GuiceInjectionService: Creates a new Guice injection service that wraps the given injector
create(Function<B, M>, Function<M, B>) - Static method in interface org.incendo.cloud.SenderMapper: Creates a new sender mapper from the provided functions.
create(CommandContext<C>, List<S>, CommandInput) - Static method in interface org.incendo.cloud.suggestion.Suggestions: Create a Suggestions instance.
create(CommandContext<C>, AnnotationAccessor) - Method in class org.incendo.cloud.injection.ParameterInjector.ConstantInjector
create(CommandContext<C>, AnnotationAccessor) - Method in interface org.incendo.cloud.injection.ParameterInjector: Attempts to create a value that should then be injected into the Command annotated method.
createCommands(CommandManager<C>) - Method in class org.incendo.cloud.bean.CommandBean: Constructs a command using the given commandManager.
createCommands(CommandManager<C>) - Method in interface org.incendo.cloud.CommandFactory: Creates commands using the given commandManager.
createContext(CommandContext<C>, T) - Method in class org.incendo.cloud.exception.handling.ExceptionContextFactory: Creates a new exception context.
createDefaultCommandMeta() - Method in interface org.incendo.cloud.CommandBuilderSource: Constructs a default CommandMeta instance.
createDefaultCommandMeta() - Method in class org.incendo.cloud.CommandManager: Constructs a default CommandMeta instance.
createHelpHandler() - Method in class org.incendo.cloud.CommandManager: Creates a new command help handler instance.
createHelpHandler(CommandPredicate<C>) - Method in class org.incendo.cloud.CommandManager: Creates a new command help handler instance.
createHelpHandler(CommandPredicate<C>) - Method in interface org.incendo.cloud.help.HelpHandlerFactory: Creates a new help handler.
createInstance() - Method in class org.incendo.cloud.syntax.StandardCommandSyntaxFormatter: Create a new formatting instance
createParser(TypeToken<T>, ParserParameters) - Method in interface org.incendo.cloud.parser.ParserRegistry: Attempts to create an instance of the default ArgumentParser for the given type using an instance of ParserParameter to configure the parser settings.
createParser(TypeToken<T>, ParserParameters) - Method in class org.incendo.cloud.parser.StandardParserRegistry
createParser(String, ParserParameters) - Method in interface org.incendo.cloud.parser.ParserRegistry: Attempts to create an instance of the parser ArgumentParser with the given name using an instance of ParserParameter to configure the parser settings.
createParser(String, ParserParameters) - Method in class org.incendo.cloud.parser.StandardParserRegistry
createParsingContext(CommandComponent<C>) - Method in class org.incendo.cloud.context.CommandContext: Creates a parsing context instance for the given component.
currentChain() - Method in exception class org.incendo.cloud.exception.CommandParseException: Returns the command chain leading up to the exception.
cursor() - Method in interface org.incendo.cloud.context.CommandInput: Returns the cursor position.
cursor(int) - Method in interface org.incendo.cloud.context.CommandInput: Sets the cursor position

D

decorate(ExceptionHandlerRegistration.ExceptionControllerBuilder<C, T>) - Method in interface org.incendo.cloud.exception.handling.ExceptionHandlerRegistration.BuilderDecorator: Decorates the given builder and returns the updated builder.
decorateBuilder(Command.Builder<C>) - Method in interface org.incendo.cloud.CommandBuilderSource: Decorates the given builder and returns the result.
decorateBuilder(Command.Builder<C>) - Method in class org.incendo.cloud.CommandManager: Invokes Command.Builder.manager(CommandManager) with this instance and returns the updated builder.
DEFAULT_MAXIMUM - Static variable in class org.incendo.cloud.parser.standard.ByteParser: Constant for the default/unset maximum value.
DEFAULT_MAXIMUM - Static variable in class org.incendo.cloud.parser.standard.DoubleParser: Constant for the default/unset maximum value.
DEFAULT_MAXIMUM - Static variable in class org.incendo.cloud.parser.standard.FloatParser: Constant for the default/unset maximum value.
DEFAULT_MAXIMUM - Static variable in class org.incendo.cloud.parser.standard.IntegerParser: Constant for the default/unset maximum value.
DEFAULT_MAXIMUM - Static variable in class org.incendo.cloud.parser.standard.LongParser: Constant for the default/unset maximum value.
DEFAULT_MAXIMUM - Static variable in class org.incendo.cloud.parser.standard.ShortParser: Constant for the default/unset maximum value.
DEFAULT_MINIMUM - Static variable in class org.incendo.cloud.parser.standard.ByteParser: Constant for the default/unset minimum value.
DEFAULT_MINIMUM - Static variable in class org.incendo.cloud.parser.standard.DoubleParser: Constant for the default/unset minimum value.
DEFAULT_MINIMUM - Static variable in class org.incendo.cloud.parser.standard.FloatParser: Constant for the default/unset minimum value.
DEFAULT_MINIMUM - Static variable in class org.incendo.cloud.parser.standard.IntegerParser: Constant for the default/unset minimum value.
DEFAULT_MINIMUM - Static variable in class org.incendo.cloud.parser.standard.LongParser: Constant for the default/unset minimum value.
DEFAULT_MINIMUM - Static variable in class org.incendo.cloud.parser.standard.ShortParser: Constant for the default/unset minimum value.
defaultMapper() - Static method in class org.incendo.cloud.parser.aggregate.AggregateParserPairBuilder: Creates the default mapper that simply returns a Pair of the two input values.
defaultMapper() - Static method in class org.incendo.cloud.parser.aggregate.AggregateParserTripletBuilder: Creates the default mapper that simply returns a Triplet of the three input values.
defaultValue() - Method in class org.incendo.cloud.component.CommandComponent.Builder: Returns the current default value, if it has been set.
defaultValue() - Method in class org.incendo.cloud.component.CommandComponent: Returns the default value, if specified.
defaultValue() - Method in class org.incendo.cloud.component.TypedCommandComponent
defaultValue(DefaultValue<? super C, T>) - Method in class org.incendo.cloud.component.CommandComponent.Builder: Sets the defaultValue.
DefaultValue<C,T> - Interface in org.incendo.cloud.component: Default value used when an optional argument is omitted by the command sender.
DefaultValue.ConstantDefaultValue<C,T> - Class in org.incendo.cloud.component
DefaultValue.DefaultValueProvider<C,T> - Interface in org.incendo.cloud.component
DefaultValue.DynamicDefaultValue<C,T> - Class in org.incendo.cloud.component
DefaultValue.ParsedDefaultValue<C,T> - Class in org.incendo.cloud.component
delegate() - Method in class org.incendo.cloud.caption.DelegatingCaptionProvider: Returns the provider to delegate to.
delegate() - Method in class org.incendo.cloud.caption.StandardCaptionsProvider
DelegatingCaptionProvider<C> - Class in org.incendo.cloud.caption: Caption provider that delegates to another provider.
DelegatingCaptionProvider() - Constructor for class org.incendo.cloud.caption.DelegatingCaptionProvider
delegatingExecutionHandler(List<CommandExecutionHandler<C>>) - Static method in interface org.incendo.cloud.execution.CommandExecutionHandler: Returns a CommandExecutionHandler that delegates the given handlers in sequence.
DelegatingSuggestionFactory<C,S> - Class in org.incendo.cloud.suggestion: Command suggestion engine that delegates to a CommandTree
DelegatingSuggestionFactory(CommandManager<C>, CommandTree<C>, CommandContextFactory<C>, ExecutionCoordinator<C>, SuggestionMapper<S>) - Constructor for class org.incendo.cloud.suggestion.DelegatingSuggestionFactory: Creates a new DelegatingSuggestionFactory.
deleteRootCommand(String) - Method in class org.incendo.cloud.CommandManager: Deletes the given rootCommand.
denied() - Method in interface org.incendo.cloud.permission.PermissionResult: Returns true if the command may not be executed.
denied(Permission) - Static method in interface org.incendo.cloud.permission.PermissionResult: Creates a failed result for the given permission.
Describable - Interface in org.incendo.cloud.description: Something that has an associated Description.
description() - Method in class org.incendo.cloud.component.CommandComponent.Builder: Returns the current description.
description() - Method in class org.incendo.cloud.component.CommandComponent
description() - Method in interface org.incendo.cloud.description.CommandDescription: Returns the command description.
description() - Method in interface org.incendo.cloud.description.Describable: Returns the description that describes this object.
description() - Method in class org.incendo.cloud.parser.flag.CommandFlag: Returns the flag description.
description(String) - Static method in interface org.incendo.cloud.description.Description: Creates a command description instance.
description(Description) - Method in class org.incendo.cloud.component.CommandComponent.Builder: Sets the description.
Description - Interface in org.incendo.cloud.description: A description for a command or a command component.
difference(CommandInput) - Method in interface org.incendo.cloud.context.CommandInput: Returns the input that has been consumed by that input that has not been consumed by input.
difference(CommandInput, boolean) - Method in interface org.incendo.cloud.context.CommandInput: Returns the input that has been consumed by that input that has not been consumed by input.
directMapper(AggregateParserPairBuilder.Mapper.DirectSuccessMapper<C, U, V, O>) - Static method in class org.incendo.cloud.parser.aggregate.AggregateParserPairBuilder: Helper function to create a direct success mapper.
directMapper(AggregateParserTripletBuilder.Mapper.DirectSuccessMapper<C, U, V, Z, O>) - Static method in class org.incendo.cloud.parser.aggregate.AggregateParserTripletBuilder: Helper function to create a direct success mapper.
doubleComponent() - Static method in class org.incendo.cloud.parser.standard.DoubleParser: Returns a CommandComponent.Builder using DoubleParser.doubleParser() as the parser.
DoubleParseException(String, DoubleParser<?>, CommandContext<?>) - Constructor for exception class org.incendo.cloud.parser.standard.DoubleParser.DoubleParseException: Create a new DoubleParser.DoubleParseException.
doubleParser() - Static method in class org.incendo.cloud.parser.standard.DoubleParser: Creates a new double parser using DoubleParser.DEFAULT_MINIMUM and DoubleParser.DEFAULT_MAXIMUM as the limits.
doubleParser(double) - Static method in class org.incendo.cloud.parser.standard.DoubleParser: Creates a new double parser using DoubleParser.DEFAULT_MAXIMUM as the maximum value.
doubleParser(double, double) - Static method in class org.incendo.cloud.parser.standard.DoubleParser: Creates a new double parser.
DoubleParser<C> - Class in org.incendo.cloud.parser.standard
DoubleParser(double, double) - Constructor for class org.incendo.cloud.parser.standard.DoubleParser: Construct a new double parser
DoubleParser.DoubleParseException - Exception Class in org.incendo.cloud.parser.standard
doubleRange(double, double) - Static method in interface org.incendo.cloud.type.range.Range: Creates a new range.
DoubleRange - Interface in org.incendo.cloud.type.range
DUPLICATE_FLAG - Enum constant in enum org.incendo.cloud.parser.flag.CommandFlagParser.FailureReason
durationComponent() - Static method in class org.incendo.cloud.parser.standard.DurationParser: Returns a CommandComponent.Builder using DurationParser.durationParser() as the parser.
DurationParseException(String, CommandContext<?>) - Constructor for exception class org.incendo.cloud.parser.standard.DurationParser.DurationParseException: Construct a new DurationParser.DurationParseException.
durationParser() - Static method in class org.incendo.cloud.parser.standard.DurationParser: Creates a new duration parser.
DurationParser<C> - Class in org.incendo.cloud.parser.standard: Parser for Duration.
DurationParser() - Constructor for class org.incendo.cloud.parser.standard.DurationParser
DurationParser.DurationParseException - Exception Class in org.incendo.cloud.parser.standard: Failure exception for DurationParser.
dynamic(DefaultValue.DefaultValueProvider<C, T>) - Static method in interface org.incendo.cloud.component.DefaultValue: Returns a default value that will be evaluated when the command is evaluated.
DynamicTuple - Class in org.incendo.cloud.type.tuple: Dynamic sized tuple backed by a Object[]

E

Either<U,V> - Interface in org.incendo.cloud.type: An object that contains either a value of type Either or type Either.
eitherParser(ParserDescriptor<C, U>, ParserDescriptor<C, V>) - Static method in class org.incendo.cloud.parser.standard.EitherParser: Creates a new parser which attempts to use the primary parser and falls back on the fallback parser if that fails.
EitherParser<C,U,V> - Class in org.incendo.cloud.parser.standard: A parser which attempts to use the EitherParser.primary() parser and falls back on the EitherParser.fallback() parser if that fails.
EitherParser(ParserDescriptor<C, U>, ParserDescriptor<C, V>) - Constructor for class org.incendo.cloud.parser.standard.EitherParser: Creates a new either parser.
EitherParser.EitherParseException - Exception Class in org.incendo.cloud.parser.standard: Exception thrown when both the primary and fallback parsers fail to parse the input.
empty() - Static method in interface org.incendo.cloud.context.CommandInput: Returns a new CommandInput with an empty string as the input.
empty() - Static method in interface org.incendo.cloud.description.CommandDescription: Returns an empty command description.
empty() - Static method in interface org.incendo.cloud.description.Description: Returns an empty command description.
empty() - Static method in class org.incendo.cloud.meta.CommandMeta: Creates an empty simple command meta-instance
empty() - Static method in class org.incendo.cloud.parser.ParserParameters: Get an empty ParserParameters instance
empty() - Static method in interface org.incendo.cloud.permission.Permission: Returns an empty permission node.
empty() - Static method in interface org.incendo.cloud.util.annotation.AnnotationAccessor: Get a AnnotationAccessor that cannot access any annotations
EMPTY - Static variable in interface org.incendo.cloud.description.Description
EMPTY - Static variable in interface org.incendo.cloud.permission.Permission
entries() - Method in interface org.incendo.cloud.help.result.IndexCommandResult: Returns an unmodifiable view of the entries.
entry() - Method in interface org.incendo.cloud.help.result.VerboseCommandResult: Returns the command entry.
enumClass() - Method in class org.incendo.cloud.parser.standard.EnumParser: Returns the enum class that was used to create this parser.
enumClass() - Method in exception class org.incendo.cloud.parser.standard.EnumParser.EnumParseException: Returns the enum class that was attempted to be parsed.
enumComponent(Class<E>) - Static method in class org.incendo.cloud.parser.standard.EnumParser: Returns a CommandComponent.Builder using EnumParser.enumParser(Class) as the parser.
enumConfigurable(Class<E>) - Static method in interface org.incendo.cloud.setting.Configurable: Returns a new Configurable instance for the given enum type.
EnumParseException(String, Class<? extends Enum<?>>, CommandContext<?>) - Constructor for exception class org.incendo.cloud.parser.standard.EnumParser.EnumParseException: Construct a new enum parse exception
enumParser(Class<E>) - Static method in class org.incendo.cloud.parser.standard.EnumParser: Creates a new enum parser.
EnumParser<C,E> - Class in org.incendo.cloud.parser.standard
EnumParser(Class<E>) - Constructor for class org.incendo.cloud.parser.standard.EnumParser: Construct a new enum parser
EnumParser.EnumParseException - Exception Class in org.incendo.cloud.parser.standard
equals(Object) - Method in class org.incendo.cloud.parser.MappedArgumentParserImpl
equals(Object) - Method in class org.incendo.cloud.caption.ImmutableConstantCaptionProvider: This instance is equal to all instances of ImmutableConstantCaptionProvider that have equal attribute values.
equals(Object) - Method in class org.incendo.cloud.component.CommandComponent
equals(Object) - Method in class org.incendo.cloud.component.DefaultValue.ConstantDefaultValue
equals(Object) - Method in class org.incendo.cloud.component.DefaultValue.DynamicDefaultValue
equals(Object) - Method in class org.incendo.cloud.component.DefaultValue.ParsedDefaultValue
equals(Object) - Method in class org.incendo.cloud.exception.handling.ExceptionContext.ExceptionContextImpl
equals(Object) - Method in exception class org.incendo.cloud.exception.parsing.NumberParseException
equals(Object) - Method in class org.incendo.cloud.injection.ParameterInjector.ConstantInjector
equals(Object) - Method in class org.incendo.cloud.internal.CommandNode
equals(Object) - Method in class org.incendo.cloud.key.CloudKey
equals(Object) - Method in class org.incendo.cloud.meta.SimpleCommandMeta
equals(Object) - Method in class org.incendo.cloud.parser.flag.CommandFlag
equals(Object) - Method in class org.incendo.cloud.parser.ParserParameter
equals(Object) - Method in exception class org.incendo.cloud.parser.standard.BooleanParser.BooleanParseException
equals(Object) - Method in exception class org.incendo.cloud.parser.standard.CharacterParser.CharParseException
equals(Object) - Method in exception class org.incendo.cloud.parser.standard.EnumParser.EnumParseException
equals(Object) - Method in exception class org.incendo.cloud.parser.standard.UUIDParser.UUIDParseException
equals(Object) - Method in class org.incendo.cloud.permission.AndPermission
equals(Object) - Method in class org.incendo.cloud.permission.OrPermission
equals(Object) - Method in class org.incendo.cloud.type.tuple.Pair
equals(Object) - Method in class org.incendo.cloud.type.tuple.Quartet
equals(Object) - Method in class org.incendo.cloud.type.tuple.Quintet
equals(Object) - Method in class org.incendo.cloud.type.tuple.Sextet
equals(Object) - Method in class org.incendo.cloud.type.tuple.Triplet
errorCaption() - Method in exception class org.incendo.cloud.exception.parsing.ParserException: Get the error caption for this parser exception
evaluateDefault(CommandContext<C>) - Method in class org.incendo.cloud.component.DefaultValue.ConstantDefaultValue
evaluateDefault(CommandContext<C>) - Method in interface org.incendo.cloud.component.DefaultValue.DefaultValueProvider: Evaluates the default value for the given context.
evaluateDefault(CommandContext<C>) - Method in class org.incendo.cloud.component.DefaultValue.DynamicDefaultValue
evaluateDefault(CommandContext<C>) - Method in interface org.incendo.cloud.component.DefaultValue: Evaluates the default value for the given context.
evaluateDefault(CommandContext<C>) - Method in class org.incendo.cloud.component.DefaultValue.ParsedDefaultValue
exactAlias() - Method in class org.incendo.cloud.context.ParsingContext: Return the exact alias used, if the argument was static.
exception() - Method in interface org.incendo.cloud.exception.handling.ExceptionContext: Returns the exception.
exception() - Method in class org.incendo.cloud.exception.handling.ExceptionContext.ExceptionContextImpl
EXCEPTION_INVALID_ARGUMENT - Static variable in class org.incendo.cloud.caption.StandardCaptionKeys: Variables: <cause>
EXCEPTION_INVALID_ARGUMENT - Static variable in class org.incendo.cloud.caption.StandardCaptionsProvider: Default caption for StandardCaptionKeys.EXCEPTION_INVALID_ARGUMENT
EXCEPTION_INVALID_SENDER - Static variable in class org.incendo.cloud.caption.StandardCaptionKeys: Variables: <actual>, <expected>
EXCEPTION_INVALID_SENDER - Static variable in class org.incendo.cloud.caption.StandardCaptionsProvider: Default caption for StandardCaptionKeys.EXCEPTION_INVALID_SENDER
EXCEPTION_INVALID_SENDER_LIST - Static variable in class org.incendo.cloud.caption.StandardCaptionKeys: Variables: <actual>, <expected>
EXCEPTION_INVALID_SENDER_LIST - Static variable in class org.incendo.cloud.caption.StandardCaptionsProvider: Default caption for StandardCaptionKeys.EXCEPTION_INVALID_SENDER_LIST
EXCEPTION_INVALID_SYNTAX - Static variable in class org.incendo.cloud.caption.StandardCaptionKeys: Variables: <syntax>
EXCEPTION_INVALID_SYNTAX - Static variable in class org.incendo.cloud.caption.StandardCaptionsProvider: Default caption for StandardCaptionKeys.EXCEPTION_INVALID_SYNTAX
EXCEPTION_NO_PERMISSION - Static variable in class org.incendo.cloud.caption.StandardCaptionKeys: Variables: <permission>
EXCEPTION_NO_PERMISSION - Static variable in class org.incendo.cloud.caption.StandardCaptionsProvider: Default caption for StandardCaptionKeys.EXCEPTION_NO_PERMISSION
EXCEPTION_NO_SUCH_COMMAND - Static variable in class org.incendo.cloud.caption.StandardCaptionKeys: Variables: <command>
EXCEPTION_NO_SUCH_COMMAND - Static variable in class org.incendo.cloud.caption.StandardCaptionsProvider: Default caption for StandardCaptionKeys.EXCEPTION_NO_SUCH_COMMAND
EXCEPTION_UNEXPECTED - Static variable in class org.incendo.cloud.caption.StandardCaptionKeys
EXCEPTION_UNEXPECTED - Static variable in class org.incendo.cloud.caption.StandardCaptionsProvider: Default caption for StandardCaptionKeys.EXCEPTION_UNEXPECTED
ExceptionContext<C,T> - Interface in org.incendo.cloud.exception.handling
ExceptionContext.ExceptionContextImpl<C,T> - Class in org.incendo.cloud.exception.handling
ExceptionContextFactory<C> - Class in org.incendo.cloud.exception.handling
ExceptionContextFactory(ExceptionController<C>) - Constructor for class org.incendo.cloud.exception.handling.ExceptionContextFactory: Creates a new factory.
exceptionController() - Method in class org.incendo.cloud.CommandManager: Returns the exception controller.
ExceptionController<C> - Class in org.incendo.cloud.exception.handling: The controller handles registrations of exception handlers, as well as the routing of incoming exceptions to the handlers.
ExceptionController() - Constructor for class org.incendo.cloud.exception.handling.ExceptionController: Creates a new exception controller.
exceptionFilter() - Method in class org.incendo.cloud.exception.handling.ExceptionHandlerRegistration: Returns the exception filter.
exceptionFilter(Predicate<T>) - Method in class org.incendo.cloud.exception.handling.ExceptionHandlerRegistration.ExceptionControllerBuilder: Returns a new builder with the given exceptionFilter.
exceptionHandler() - Method in class org.incendo.cloud.exception.handling.ExceptionHandlerRegistration: Returns the exception handler.
exceptionHandler(ExceptionHandler<C, ? extends T>) - Method in class org.incendo.cloud.exception.handling.ExceptionHandlerRegistration.ExceptionControllerBuilder: Returns a new builder with the given exceptionHandler.
ExceptionHandler<C,T> - Interface in org.incendo.cloud.exception.handling: Handles an exception thrown during command parsing & execution.
ExceptionHandlerRegistration<C,T> - Class in org.incendo.cloud.exception.handling: Used to register a ExceptionHandler in the ExceptionController.
ExceptionHandlerRegistration.BuilderDecorator<C,T> - Interface in org.incendo.cloud.exception.handling
ExceptionHandlerRegistration.ExceptionControllerBuilder<C,T> - Class in org.incendo.cloud.exception.handling
exceptionType() - Method in class org.incendo.cloud.exception.handling.ExceptionHandlerRegistration: Returns the exception type handler by this handler.
execute(CommandContext<C>) - Method in class org.incendo.cloud.bean.CommandBean: Default command handler for this command bean.
execute(CommandContext<C>) - Method in interface org.incendo.cloud.execution.CommandExecutionHandler: Handle command execution
execute(CommandContext<C>) - Method in interface org.incendo.cloud.execution.CommandExecutionHandler.FutureCommandExecutionHandler
executeCommand(C, String) - Method in interface org.incendo.cloud.execution.CommandExecutor: Executes a command and get a future that completes with the result.
executeCommand(C, String, Consumer<CommandContext<C>>) - Method in interface org.incendo.cloud.execution.CommandExecutor: Executes a command and get a future that completes with the result.
executeFuture(CommandContext<C>) - Method in interface org.incendo.cloud.execution.CommandExecutionHandler: Handle command execution
executeFuture(CommandContext<C>) - Method in interface org.incendo.cloud.execution.CommandExecutionHandler.FutureCommandExecutionHandler
executionCoordinator() - Method in interface org.incendo.cloud.execution.CommandExecutor: Returns the command execution coordinator.
ExecutionCoordinator<C> - Interface in org.incendo.cloud.execution: The execution coordinator is responsible for coordinating execution of command parsing, handlers, suggestions, etc.
ExecutionCoordinator.Builder<C> - Interface in org.incendo.cloud.execution: Builder for ExecutionCoordinator.
executionSchedulingExecutor(Executor) - Method in interface org.incendo.cloud.execution.ExecutionCoordinator.Builder: Sets the executor to schedule command execution from.
executor(Executor) - Method in interface org.incendo.cloud.execution.ExecutionCoordinator.Builder: Sets all of: ExecutionCoordinator.Builder.parsingExecutor(Executor) ExecutionCoordinator.Builder.suggestionsExecutor(Executor) ExecutionCoordinator.Builder.executionSchedulingExecutor(Executor) using the provided executor.
expectedType() - Method in class org.incendo.cloud.parser.ParserParameter: Returns the type that is expected to be mapped to this parameter.

F

failableDynamic(DefaultValue<C, T>) - Static method in interface org.incendo.cloud.component.DefaultValue: Returns a default value that will be evaluated when the command is evaluated.
failedFuture(Throwable) - Static method in class org.incendo.cloud.util.CompletableFutures: Returns a failed future that has been exceptionally completed with the given throwable.
failedInput() - Method in exception class org.incendo.cloud.component.preprocessor.RegexPreprocessor.RegexValidationException: Returns the input that failed the verification.
failure() - Method in class org.incendo.cloud.parser.ArgumentParseResult: Get the failure reason, if it exists
failure(Throwable) - Static method in class org.incendo.cloud.parser.ArgumentParseResult: Indicate that the parsing failed
failureFuture(Throwable) - Static method in class org.incendo.cloud.parser.ArgumentParseResult: Create a future completed with a failed parse result.
failureReason() - Method in exception class org.incendo.cloud.parser.flag.CommandFlagParser.FlagParseException: Returns the reason why the flag parsing failed.
fallback() - Method in class org.incendo.cloud.parser.standard.EitherParser: Returns the fallback parser.
fallback() - Method in interface org.incendo.cloud.type.Either: Returns an optional containing the value of type Either, if it exists.
fallbackFailure() - Method in exception class org.incendo.cloud.parser.standard.EitherParser.EitherParseException: Returns the throwable thrown by the fallback parser.
fallbackOrMapPrimary(Function<U, V>) - Method in interface org.incendo.cloud.type.Either: Extract Either.fallback(), or if it's not present, map Either.primary() to V.
fallbackType() - Method in exception class org.incendo.cloud.parser.standard.EitherParser.EitherParseException: Returns the type produced by the fallback parser.
fifth() - Method in class org.incendo.cloud.type.tuple.Quintet: Get the fifth value
fifth() - Method in class org.incendo.cloud.type.tuple.Sextet: Get the fifth value
fillInStackTrace() - Method in exception class org.incendo.cloud.exception.NoPermissionException
fillInStackTrace() - Method in exception class org.incendo.cloud.exception.NoSuchCommandException
filter(CommandPreprocessingContext<C>, String, String) - Method in interface org.incendo.cloud.suggestion.FilteringSuggestionProcessor.Filter: Filters a potential suggestion against the input and context.
filter(CommandPreprocessingContext<C>, String, String) - Method in interface org.incendo.cloud.suggestion.FilteringSuggestionProcessor.Filter.Simple
FilteringSuggestionProcessor<C> - Class in org.incendo.cloud.suggestion: Command suggestion processor filters suggestions based on the remaining unconsumed input in the queue.
FilteringSuggestionProcessor() - Constructor for class org.incendo.cloud.suggestion.FilteringSuggestionProcessor: Create a new FilteringSuggestionProcessor filtering with FilteringSuggestionProcessor.Filter.partialTokenMatches(boolean) that ignores case.
FilteringSuggestionProcessor(FilteringSuggestionProcessor.Filter<C>) - Constructor for class org.incendo.cloud.suggestion.FilteringSuggestionProcessor: Create a new FilteringSuggestionProcessor.
FilteringSuggestionProcessor.Filter<C> - Interface in org.incendo.cloud.suggestion: Filter function that tests (and potentially changes) each suggestion against the input and context.
FilteringSuggestionProcessor.Filter.Simple<C> - Interface in org.incendo.cloud.suggestion: Simple version of FilteringSuggestionProcessor.Filter which doesn't modify suggestions.
first() - Method in class org.incendo.cloud.type.tuple.Pair: Returns the first value.
first() - Method in class org.incendo.cloud.type.tuple.Quartet: Get the first value
first() - Method in class org.incendo.cloud.type.tuple.Quintet: Get the first value
first() - Method in class org.incendo.cloud.type.tuple.Sextet: Get the first value
first() - Method in class org.incendo.cloud.type.tuple.Triplet: Get the first value
firstOf(ParserDescriptor<C, U>, ParserDescriptor<C, V>) - Static method in interface org.incendo.cloud.parser.ArgumentParser: Creates a new parser which attempts to use the primary parser and falls back on the fallback parser if that fails.
flag(CommandFlag<T>) - Method in class org.incendo.cloud.Command.Builder: Registers a new command flag.
flag(CommandFlag.Builder<C, T>) - Method in class org.incendo.cloud.Command.Builder: Registers a new command flag.
FLAG - Enum constant in enum org.incendo.cloud.component.CommandComponent.ComponentType: An optional argument that represents multiple command flags.
FLAG_CURSOR_KEY - Static variable in class org.incendo.cloud.parser.flag.CommandFlagParser: Metadata for the position of the cursor before parsing the last flag's value
FLAG_META_KEY - Static variable in class org.incendo.cloud.parser.flag.CommandFlagParser: Metadata for the last argument that was suggested
FLAG_PARSE_RESULT_OBJECT - Static variable in class org.incendo.cloud.parser.flag.CommandFlagParser: Dummy object that indicates that flags were parsed successfully
FLAG_PRESENCE_VALUE - Static variable in class org.incendo.cloud.parser.flag.FlagContext: Dummy object stored as a flag value when the flag has no associated parser
FLAG_YIELDING - Static variable in class org.incendo.cloud.parser.StandardParameters: Indicates that an argument should stop parsing when encountering a potential flag.
flagBuilder(String) - Method in class org.incendo.cloud.CommandManager: Create a new command flag builder
flagComponent() - Method in class org.incendo.cloud.Command: Returns the component that contains the flags belonging to the command.
FlagContext - Class in org.incendo.cloud.parser.flag: Flag value mappings
FlagParseException(String, CommandFlagParser.FailureReason, CommandContext<?>) - Constructor for exception class org.incendo.cloud.parser.flag.CommandFlagParser.FlagParseException: Construct a new flag parse exception
flagParser() - Method in class org.incendo.cloud.Command: Returns the flag parser for this command, of null if the command has no flags.
flags() - Method in class org.incendo.cloud.context.CommandContext: Returns the associated FlagContext instance.
flags() - Method in class org.incendo.cloud.parser.flag.CommandFlagParser: Returns the recognized flags.
FlagYielding - Annotation Type in org.incendo.cloud.annotation.specifier: Indicates that the argument should stop parsing when encountering what could potentially be a flag.
flagYieldingStringArrayParser() - Static method in class org.incendo.cloud.parser.standard.StringArrayParser: Creates a new character parser that stops parsing when it encounters a command flag.
flatMap(TypeToken<O>, MappedArgumentParser.Mapper<C, T, O>) - Method in interface org.incendo.cloud.parser.ParserDescriptor: Create a descriptor for a flatMapped parser.
flatMap(Class<O>, MappedArgumentParser.Mapper<C, T, O>) - Method in interface org.incendo.cloud.parser.ParserDescriptor: Create a descriptor for a flatMapped parser.
flatMap(MappedArgumentParser.Mapper<C, O, O1>) - Method in class org.incendo.cloud.parser.MappedArgumentParserImpl
flatMap(MappedArgumentParser.Mapper<C, T, O>) - Method in interface org.incendo.cloud.parser.ArgumentParser: Create a derived argument parser preserving all properties of this parser, but converting the output type.
flatMapSuccess(TypeToken<O>, BiFunction<CommandContext<C>, T, CompletableFuture<ArgumentParseResult<O>>>) - Method in interface org.incendo.cloud.parser.ParserDescriptor: Create a descriptor for a flatMapped parser.
flatMapSuccess(Class<O>, BiFunction<CommandContext<C>, T, CompletableFuture<ArgumentParseResult<O>>>) - Method in interface org.incendo.cloud.parser.ParserDescriptor: Create a descriptor for a flatMapped parser.
flatMapSuccess(BiFunction<CommandContext<C>, T, CompletableFuture<ArgumentParseResult<O>>>) - Method in interface org.incendo.cloud.parser.ArgumentParser: Create a parser that passes through failures and flat maps successfully parsed values with mapper.
flatMapSuccess(Function<T, ArgumentParseResult<O>>) - Method in class org.incendo.cloud.parser.ArgumentParseResult: Returns the result from applying mapper to the parsed value, or the same failure as this result.
flatMapSuccessFuture(Function<T, CompletableFuture<ArgumentParseResult<O>>>) - Method in class org.incendo.cloud.parser.ArgumentParseResult: Returns a future resulting from applying mapper to the parsed value, or a completed future with the same failure as this result.
floatComponent() - Static method in class org.incendo.cloud.parser.standard.FloatParser: Returns a CommandComponent.Builder using FloatParser.floatParser() as the parser.
FloatParseException(String, FloatParser<?>, CommandContext<?>) - Constructor for exception class org.incendo.cloud.parser.standard.FloatParser.FloatParseException: Create a new FloatParser.FloatParseException.
floatParser() - Static method in class org.incendo.cloud.parser.standard.FloatParser: Creates a new float parser using FloatParser.DEFAULT_MINIMUM and FloatParser.DEFAULT_MAXIMUM as the limits.
floatParser(float) - Static method in class org.incendo.cloud.parser.standard.FloatParser: Creates a new float parser using FloatParser.DEFAULT_MAXIMUM as the maximum value.
floatParser(float, float) - Static method in class org.incendo.cloud.parser.standard.FloatParser: Creates a new float parser.
FloatParser<C> - Class in org.incendo.cloud.parser.standard
FloatParser(float, float) - Constructor for class org.incendo.cloud.parser.standard.FloatParser: Construct a new float parser
FloatParser.FloatParseException - Exception Class in org.incendo.cloud.parser.standard
floatRange(float, float) - Static method in interface org.incendo.cloud.type.range.Range: Creates a new range.
FloatRange - Interface in org.incendo.cloud.type.range
forCaption(Caption, Function<C, String>) - Static method in interface org.incendo.cloud.caption.CaptionProvider: Returns a CaptionProvider that only returns values for the given caption, and returns null for all other captions.
FORCE_SUGGESTION - Enum constant in enum org.incendo.cloud.setting.ManagerSetting: Force sending of an empty suggestion (i.e.
formatCaption(CaptionFormatter<?, T>) - Method in exception class org.incendo.cloud.exception.parsing.ParserException: Formats the error caption using the given formatter.
formatCaption(CaptionFormatter<C, T>, Caption, List<CaptionVariable>) - Method in class org.incendo.cloud.context.CommandContext: Formats a caption using the given formatter.
formatCaption(CaptionFormatter<C, T>, Caption, CaptionVariable...) - Method in class org.incendo.cloud.context.CommandContext: Formats a caption using the given formatter.
formatCaption(Caption, C, String, List<CaptionVariable>) - Method in interface org.incendo.cloud.caption.CaptionFormatter: Formats the caption.
formatCaption(Caption, C, String, List<CaptionVariable>) - Method in class org.incendo.cloud.caption.CaptionFormatter.PatternReplacingCaptionFormatter
formatCaption(Caption, C, String, CaptionVariable...) - Method in interface org.incendo.cloud.caption.CaptionFormatter: Formats the caption.
formatCaption(Caption, List<CaptionVariable>) - Method in class org.incendo.cloud.context.CommandContext: Formats a caption using the CommandManager.captionFormatter().
formatCaption(Caption, CaptionVariable...) - Method in class org.incendo.cloud.context.CommandContext: Formats a caption using the CommandManager.captionFormatter().
FormattingInstance() - Constructor for class org.incendo.cloud.syntax.StandardCommandSyntaxFormatter.FormattingInstance: Create a new formatting instance
fourth() - Method in class org.incendo.cloud.type.tuple.Quartet: Get the fourth value
fourth() - Method in class org.incendo.cloud.type.tuple.Quintet: Get the fourth value
fourth() - Method in class org.incendo.cloud.type.tuple.Sextet: Get the fourth value
from(ConstantCaptionProvider<C>) - Method in class org.incendo.cloud.caption.ImmutableConstantCaptionProvider.Builder: Fill a builder with attribute values from the provided ConstantCaptionProvider instance.
futureHandler(CommandExecutionHandler.FutureCommandExecutionHandler<C>) - Method in class org.incendo.cloud.Command.Builder: Specifies the command execution handler.

G

get(S) - Method in interface org.incendo.cloud.setting.Configurable: Returns the value of the given setting
get(String) - Method in interface org.incendo.cloud.key.CloudKeyContainer: Returns the value associated with the given key or fails exceptionally if it's missing.
get(String) - Method in class org.incendo.cloud.parser.flag.FlagContext: Returns a flag value.
get(CloudKey<V>) - Method in interface org.incendo.cloud.key.CloudKeyContainer: Returns the value associated with the given key or fails exceptionally if it's missing.
get(CloudKeyHolder<V>) - Method in interface org.incendo.cloud.key.CloudKeyContainer: Returns the value associated with the given keyHolder or fails exceptionally if it's missing.
get(ParserParameter<T>, T) - Method in class org.incendo.cloud.parser.ParserParameters: Get a value from the parameter map, if it is stored, else return a default value
get(CommandFlag<T>) - Method in class org.incendo.cloud.parser.flag.FlagContext: Returns a flag value.
getAll(String) - Method in class org.incendo.cloud.parser.flag.FlagContext: Returns all supplied flag values for the given flag.
getAll(CommandFlag<T>) - Method in class org.incendo.cloud.parser.flag.FlagContext: Returns all supplied flag values for the given flag.
getCause() - Method in exception class org.incendo.cloud.exception.ArgumentParseException: Get the cause of the exception
getChild(CommandComponent<C>) - Method in class org.incendo.cloud.internal.CommandNode: Returns the node containing the given component
getInjectable(TypeToken<T>, CommandContext<C>, AnnotationAccessor) - Method in class org.incendo.cloud.injection.ParameterInjectorRegistry: Attempts to get an injectable value for the given context.
getInjectable(Class<T>, CommandContext<C>, AnnotationAccessor) - Method in class org.incendo.cloud.injection.ParameterInjectorRegistry: Attempts to get an injectable value for the given context.
getLeaves(CommandNode<C>) - Method in class org.incendo.cloud.CommandTree: Returns all leaf nodes attached to the given node or its children.
getLeavesRaw(CommandNode<C>) - Method in class org.incendo.cloud.CommandTree: Returns all leaf nodes attached to the given node or its children.
getMessage() - Method in exception class org.incendo.cloud.component.preprocessor.RegexPreprocessor.RegexValidationException
getMessage() - Method in exception class org.incendo.cloud.exception.AmbiguousNodeException
getMessage() - Method in exception class org.incendo.cloud.exception.InvalidCommandSenderException
getMessage() - Method in exception class org.incendo.cloud.exception.InvalidSyntaxException
getMessage() - Method in exception class org.incendo.cloud.exception.NoPermissionException
getMessage() - Method in exception class org.incendo.cloud.exception.NoSuchCommandException
getMessage() - Method in exception class org.incendo.cloud.exception.parsing.ParserException
getNamedNode(String) - Method in class org.incendo.cloud.CommandTree: Returns a named root node, if it exists
getOrDefault(String, V) - Method in interface org.incendo.cloud.key.CloudKeyContainer: Returns the value associated with the given key if it exists, or else the defaultValue.
getOrDefault(CloudKey<V>, V) - Method in interface org.incendo.cloud.key.CloudKeyContainer: Returns the value associated with the given key if it exists, or else the defaultValue.
getOrDefault(CloudKeyHolder<V>, V) - Method in interface org.incendo.cloud.key.CloudKeyContainer: Returns the value associated with the given keyHolder if it exists, or else the defaultValue.
getOrNull(CloudKey<V>) - Method in class org.incendo.cloud.key.SimpleMutableCloudKeyContainer: Get the value, or null if not present, without boxing in an optional.
getOrSupplyDefault(String, Supplier<V>) - Method in interface org.incendo.cloud.key.CloudKeyContainer: Returns the value associated with the given key if it exists, or else the value supplied by the given supplier
getOrSupplyDefault(CloudKey<V>, Supplier<V>) - Method in interface org.incendo.cloud.key.CloudKeyContainer: Returns the value associated with the given key if it exists, or else the value supplied by the given supplier
getOrSupplyDefault(CloudKeyHolder<V>, Supplier<V>) - Method in interface org.incendo.cloud.key.CloudKeyContainer: Returns the value associated with the given keyHolder if it exists, or else the value supplied by the given supplier
getSuggestionProvider(String) - Method in interface org.incendo.cloud.parser.ParserRegistry: Returns a named suggestion provider, if it exists.
getSuggestionProvider(String) - Method in class org.incendo.cloud.parser.StandardParserRegistry
getSuggestions(CommandContext<C>, CommandInput, SuggestionMapper<S>, Executor) - Method in class org.incendo.cloud.CommandTree: Returns suggestions from the input queue
getSuggestions(Range<? extends Number>, CommandInput) - Static method in class org.incendo.cloud.parser.standard.IntegerParser: Returns integer suggestions.
getValue(String) - Method in class org.incendo.cloud.parser.flag.FlagContext: Returns a flag value.
getValue(String, T) - Method in class org.incendo.cloud.parser.flag.FlagContext: Returns a flag value.
getValue(CommandFlag<T>) - Method in class org.incendo.cloud.parser.flag.FlagContext: Returns a flag value.
getValue(CommandFlag<T>, T) - Method in class org.incendo.cloud.parser.flag.FlagContext: Returns a flag value.
Greedy - Annotation Type in org.incendo.cloud.annotation.specifier: Annotation used to make string parsers greedy
GREEDY - Enum constant in enum org.incendo.cloud.parser.standard.StringParser.StringMode
GREEDY - Static variable in class org.incendo.cloud.parser.StandardParameters: Indicates that a string argument should be greedy
GREEDY_FLAG_YIELDING - Enum constant in enum org.incendo.cloud.parser.standard.StringParser.StringMode: Greedy string that will consume the input until a flag is present.
greedyFlagYieldingStringParser() - Static method in class org.incendo.cloud.parser.standard.StringParser: Creates a new string parser that parses all the remaining input until it encounters a command flag.
greedyStringParser() - Static method in class org.incendo.cloud.parser.standard.StringParser: Creates a new string parser that parses all the remaining input.
GuiceInjectionService<C> - Class in org.incendo.cloud.injection: Injection service that injects using a Guice Injector

H

handle(ExceptionContext<C, T>) - Method in interface org.incendo.cloud.exception.handling.ExceptionHandler: Handles the exception in the given context.
handle(InjectionRequest<C>) - Method in class org.incendo.cloud.injection.GuiceInjectionService
handle(InjectionRequest<C>) - Method in class org.incendo.cloud.injection.ParameterInjectorRegistry
handleException(CommandContext<C>, T) - Method in class org.incendo.cloud.exception.handling.ExceptionController: Attempts to handle the given exception gracefully.
handler() - Method in class org.incendo.cloud.Command.Builder: Returns the current command execution handler.
handler(CommandExecutionHandler<C>) - Method in class org.incendo.cloud.Command.Builder: Specifies the command execution handler.
has(ParserParameter<T>) - Method in class org.incendo.cloud.parser.ParserParameters: Check if this instance contains a parameter-object pair for a given parameter
hasCapability(CloudCapability) - Method in class org.incendo.cloud.CommandManager: Checks whether the cloud implementation has the given capability.
hasDefaultValue() - Method in class org.incendo.cloud.component.CommandComponent: Returns whether this component has a default value.
hasFlag(String) - Method in class org.incendo.cloud.parser.flag.FlagContext: Check whether a flag is present.
hasFlag(CommandFlag<?>) - Method in class org.incendo.cloud.parser.flag.FlagContext: Check whether a flag is present.
hashCode() - Method in class org.incendo.cloud.caption.ImmutableConstantCaptionProvider: Computes a hash code from attributes: captions.
hashCode() - Method in class org.incendo.cloud.component.CommandComponent
hashCode() - Method in class org.incendo.cloud.component.DefaultValue.ConstantDefaultValue
hashCode() - Method in class org.incendo.cloud.component.DefaultValue.DynamicDefaultValue
hashCode() - Method in class org.incendo.cloud.component.DefaultValue.ParsedDefaultValue
hashCode() - Method in class org.incendo.cloud.exception.handling.ExceptionContext.ExceptionContextImpl
hashCode() - Method in exception class org.incendo.cloud.exception.parsing.NumberParseException
hashCode() - Method in class org.incendo.cloud.injection.ParameterInjector.ConstantInjector
hashCode() - Method in class org.incendo.cloud.internal.CommandNode
hashCode() - Method in class org.incendo.cloud.key.CloudKey
hashCode() - Method in class org.incendo.cloud.meta.SimpleCommandMeta
hashCode() - Method in class org.incendo.cloud.parser.flag.CommandFlag
hashCode() - Method in class org.incendo.cloud.parser.MappedArgumentParserImpl
hashCode() - Method in class org.incendo.cloud.parser.ParserParameter
hashCode() - Method in exception class org.incendo.cloud.parser.standard.BooleanParser.BooleanParseException
hashCode() - Method in exception class org.incendo.cloud.parser.standard.CharacterParser.CharParseException
hashCode() - Method in exception class org.incendo.cloud.parser.standard.EnumParser.EnumParseException
hashCode() - Method in exception class org.incendo.cloud.parser.standard.UUIDParser.UUIDParseException
hashCode() - Method in class org.incendo.cloud.permission.AndPermission
hashCode() - Method in class org.incendo.cloud.permission.OrPermission
hashCode() - Method in class org.incendo.cloud.type.tuple.Pair
hashCode() - Method in class org.incendo.cloud.type.tuple.Quartet
hashCode() - Method in class org.incendo.cloud.type.tuple.Quintet
hashCode() - Method in class org.incendo.cloud.type.tuple.Sextet
hashCode() - Method in class org.incendo.cloud.type.tuple.Triplet
hasMax() - Method in exception class org.incendo.cloud.exception.parsing.NumberParseException: Returns whether the parser has a maximum value.
hasMax() - Method in class org.incendo.cloud.parser.standard.ByteParser
hasMax() - Method in class org.incendo.cloud.parser.standard.DoubleParser
hasMax() - Method in class org.incendo.cloud.parser.standard.FloatParser
hasMax() - Method in class org.incendo.cloud.parser.standard.IntegerParser
hasMax() - Method in class org.incendo.cloud.parser.standard.LongParser
hasMax() - Method in class org.incendo.cloud.parser.standard.NumberParser: Returns whether this parser has a maximum value set.
hasMax() - Method in class org.incendo.cloud.parser.standard.ShortParser
hasMin() - Method in exception class org.incendo.cloud.exception.parsing.NumberParseException: Returns whether the parser has a minimum value.
hasMin() - Method in class org.incendo.cloud.parser.standard.ByteParser
hasMin() - Method in class org.incendo.cloud.parser.standard.DoubleParser
hasMin() - Method in class org.incendo.cloud.parser.standard.FloatParser
hasMin() - Method in class org.incendo.cloud.parser.standard.IntegerParser
hasMin() - Method in class org.incendo.cloud.parser.standard.LongParser
hasMin() - Method in class org.incendo.cloud.parser.standard.NumberParser: Returns whether this parser has a minimum value set.
hasMin() - Method in class org.incendo.cloud.parser.standard.ShortParser
hasNonWhitespace() - Method in interface org.incendo.cloud.context.CommandInput: Returns whether the remaining input contains any non-whitespace characters.
hasPermission(C, String) - Method in class org.incendo.cloud.CommandManager: Check if the command sender has the required permission.
hasPermission(String) - Method in class org.incendo.cloud.context.CommandContext: Checks whether the sender that executed the command has a permission.
hasPermission(Permission) - Method in class org.incendo.cloud.context.CommandContext: Checks whether the sender that executed the command has a permission.
hasRemainingInput() - Method in interface org.incendo.cloud.context.CommandInput: Returns whether there is any remaining input left to read.
hasRemainingInput(boolean) - Method in interface org.incendo.cloud.context.CommandInput: Returns whether there is anything left to read.
HelpHandler<C> - Interface in org.incendo.cloud.help
helpHandlerFactory() - Method in class org.incendo.cloud.CommandManager: Returns the help handler factory.
helpHandlerFactory(HelpHandlerFactory<C>) - Method in class org.incendo.cloud.CommandManager: Sets the new help handler factory.
HelpHandlerFactory<C> - Interface in org.incendo.cloud.help
HelpQuery<C> - Interface in org.incendo.cloud.help
HelpQueryResult<C> - Interface in org.incendo.cloud.help.result: The result of a help query.
HelpRenderer<C> - Interface in org.incendo.cloud.help

I

identity() - Static method in interface org.incendo.cloud.SenderMapper: Returns the identity mapper, a mapper that does not transform the sender.
identity() - Static method in interface org.incendo.cloud.suggestion.SuggestionMapper: Returns a suggestion mapper that maps from Suggestion to Suggestion.
ImmutableBuilder - Annotation Type in org.incendo.cloud.internal: Annotation that generates immutables classes with builders.
ImmutableConstantCaptionProvider<C> - Class in org.incendo.cloud.caption: Immutable implementation of ConstantCaptionProvider.
ImmutableConstantCaptionProvider.Builder<C> - Class in org.incendo.cloud.caption: Builds instances of type ImmutableConstantCaptionProvider.
ImmutableImpl - Annotation Type in org.incendo.cloud.internal: Annotation that generates immutable classes suffixed with "Impl".
IndexCommandResult<C> - Interface in org.incendo.cloud.help.result: A list of commands.
initCause(Throwable) - Method in exception class org.incendo.cloud.exception.NoPermissionException
initCause(Throwable) - Method in exception class org.incendo.cloud.exception.NoSuchCommandException
inject(TypeToken<T>) - Method in class org.incendo.cloud.context.CommandContext: Attempts to retrieve a value that has been registered to the associated command manager's ParameterInjectorRegistry.
inject(Class<T>) - Method in class org.incendo.cloud.context.CommandContext: Attempts to retrieve a value that has been registered to the associated command manager's ParameterInjectorRegistry.
injectedClass() - Method in interface org.incendo.cloud.injection.InjectionRequest: Returns the type that is being injected.
injectedType() - Method in interface org.incendo.cloud.injection.InjectionRequest: Returns the type that is being injected.
InjectionException - Exception Class in org.incendo.cloud.exception: Exception thrown when an InjectionService fails exceptionally.
InjectionException(String, Throwable) - Constructor for exception class org.incendo.cloud.exception.InjectionException: Creates a new injection exception.
InjectionRequest<C> - Interface in org.incendo.cloud.injection
InjectionService<C> - Interface in org.incendo.cloud.injection: Service that can be registered to the ParameterInjectorRegistry in order to provide custom injection support.
input() - Method in interface org.incendo.cloud.context.CommandInput: Returns the complete input string.
input() - Method in exception class org.incendo.cloud.exception.parsing.NumberParseException: Returns the input that failed to parse.
input() - Method in exception class org.incendo.cloud.parser.flag.CommandFlagParser.FlagParseException: Returns the supplied input.
input() - Method in exception class org.incendo.cloud.parser.standard.BooleanParser.BooleanParseException: Returns the supplied input.
input() - Method in exception class org.incendo.cloud.parser.standard.CharacterParser.CharParseException: Returns the supplied input.
input() - Method in exception class org.incendo.cloud.parser.standard.DurationParser.DurationParseException: Returns the supplied input string.
input() - Method in exception class org.incendo.cloud.parser.standard.EnumParser.EnumParseException: Returns the input provided by the sender.
input() - Method in exception class org.incendo.cloud.parser.standard.StringParser.StringParseException: Returns the input provided by the sender.
input() - Method in exception class org.incendo.cloud.parser.standard.UUIDParser.UUIDParseException: Returns the supplied input.
insertAlias(String) - Method in class org.incendo.cloud.parser.standard.LiteralParser: Insert a new alias
insertCommand(Command<C>) - Method in class org.incendo.cloud.CommandTree: Inserts a new command into the command tree and then verifies the integrity of the tree
integerComponent() - Static method in class org.incendo.cloud.parser.standard.IntegerParser: Returns a CommandComponent.Builder using IntegerParser.integerParser() as the parser.
IntegerParseException(String, IntegerParser<?>, CommandContext<?>) - Constructor for exception class org.incendo.cloud.parser.standard.IntegerParser.IntegerParseException: Create a new IntegerParser.IntegerParseException.
integerParser() - Static method in class org.incendo.cloud.parser.standard.IntegerParser: Creates a new integer parser using IntegerParser.DEFAULT_MINIMUM and IntegerParser.DEFAULT_MAXIMUM as the limits.
integerParser(int) - Static method in class org.incendo.cloud.parser.standard.IntegerParser: Creates a new integer parser using IntegerParser.DEFAULT_MAXIMUM as the maximum value.
integerParser(int, int) - Static method in class org.incendo.cloud.parser.standard.IntegerParser: Creates a new integer parser.
IntegerParser<C> - Class in org.incendo.cloud.parser.standard
IntegerParser(int, int) - Constructor for class org.incendo.cloud.parser.standard.IntegerParser: Construct a new integer parser
IntegerParser.IntegerParseException - Exception Class in org.incendo.cloud.parser.standard
intRange(int, int) - Static method in interface org.incendo.cloud.type.range.Range: Creates a new range.
IntRange - Interface in org.incendo.cloud.type.range
InvalidCommandSenderException - Exception Class in org.incendo.cloud.exception: Exception thrown when an invalid command sender tries to execute a command
InvalidCommandSenderException(Object, Type, List<CommandComponent<?>>, Command<?>) - Constructor for exception class org.incendo.cloud.exception.InvalidCommandSenderException: Construct a new command parse exception
InvalidCommandSenderException(Object, Set<Type>, List<CommandComponent<?>>, Command<?>) - Constructor for exception class org.incendo.cloud.exception.InvalidCommandSenderException: Construct a new command parse exception
InvalidSyntaxException - Exception Class in org.incendo.cloud.exception: Exception sent when a command sender inputs invalid command syntax
InvalidSyntaxException(String, Object, List<CommandComponent<?>>) - Constructor for exception class org.incendo.cloud.exception.InvalidSyntaxException: Create a new invalid syntax exception instance
isCommandRegistrationAllowed() - Method in class org.incendo.cloud.CommandManager: Check if command registration is allowed.
isEmpty() - Method in interface org.incendo.cloud.context.CommandInput: Returns whether there is nothing left to read.
isEmpty() - Method in interface org.incendo.cloud.description.CommandDescription: Returns whether the description is empty.
isEmpty() - Method in interface org.incendo.cloud.description.Description: Returns whether this description contains contents.
isEmpty() - Method in interface org.incendo.cloud.help.result.IndexCommandResult: Returns whether the result is empty.
isEmpty() - Method in class org.incendo.cloud.permission.AndPermission
isEmpty() - Method in class org.incendo.cloud.permission.OrPermission
isEmpty() - Method in interface org.incendo.cloud.permission.Permission: Returns true if a check for this permission should and will always return true.
isEmpty() - Method in interface org.incendo.cloud.permission.PredicatePermission
isEmpty(boolean) - Method in interface org.incendo.cloud.context.CommandInput: Returns whether there is nothing left to read.
isLeaf() - Method in class org.incendo.cloud.internal.CommandNode: Returns whether the node is a leaf node
isNodeVisible(CommandNode<C>) - Method in class org.incendo.cloud.help.StandardHelpHandler: Checks using the predicate whether a command node or one of its children is visible
isPresent(String) - Method in class org.incendo.cloud.parser.flag.FlagContext: Check whether a presence flag is present.
isPresent(CommandFlag<Void>) - Method in class org.incendo.cloud.parser.flag.FlagContext: Check whether a presence flag is present.
isSuggestions() - Method in class org.incendo.cloud.context.CommandContext: Checks if this context was created for tab completion purposes.
isValidBoolean(boolean) - Method in interface org.incendo.cloud.context.CommandInput: Returns whether CommandInput.peekString() contain a valid Boolean within the given range.
isValidByte(byte, byte) - Method in interface org.incendo.cloud.context.CommandInput: Returns whether CommandInput.peekString() contain a valid Byte within the given range.
isValidByte(ByteRange) - Method in interface org.incendo.cloud.context.CommandInput: Returns whether CommandInput.peekString() contain a valid Byte within the given range.
isValidDouble(double, double) - Method in interface org.incendo.cloud.context.CommandInput: Returns whether CommandInput.peekString() contain a valid Double within the given range.
isValidDouble(DoubleRange) - Method in interface org.incendo.cloud.context.CommandInput: Returns whether CommandInput.peekString() contain a valid Double within the given range.
isValidFloat(float, float) - Method in interface org.incendo.cloud.context.CommandInput: Returns whether CommandInput.peekString() contain a valid Float within the given range.
isValidFloat(FloatRange) - Method in interface org.incendo.cloud.context.CommandInput: Returns whether CommandInput.peekString() contain a valid Float within the given range.
isValidInteger(int, int) - Method in interface org.incendo.cloud.context.CommandInput: Returns whether CommandInput.peekString() contain a valid Integer within the given range.
isValidInteger(IntRange) - Method in interface org.incendo.cloud.context.CommandInput: Returns whether CommandInput.peekString() contain a valid Integer within the given range.
isValidLong(long, long) - Method in interface org.incendo.cloud.context.CommandInput: Returns whether CommandInput.peekString() contain a valid Long within the given range.
isValidLong(LongRange) - Method in interface org.incendo.cloud.context.CommandInput: Returns whether CommandInput.peekString() contain a valid Long within the given range.
isValidShort(short, short) - Method in interface org.incendo.cloud.context.CommandInput: Returns whether CommandInput.peekString() contain a valid Short within the given range.
isValidShort(ShortRange) - Method in interface org.incendo.cloud.context.CommandInput: Returns whether CommandInput.peekString() contain a valid Short within the given range.
iterator() - Method in interface org.incendo.cloud.help.result.IndexCommandResult: Returns an iterator that iterates over the IndexCommandResult.entries().

K

key() - Method in interface org.incendo.cloud.caption.Caption: Returns the caption key.
key() - Method in interface org.incendo.cloud.caption.CaptionVariable: Returns the variable key.
key() - Method in class org.incendo.cloud.component.TypedCommandComponent
key() - Method in interface org.incendo.cloud.key.CloudKeyHolder: Returns the key that identifies this object.
key() - Method in class org.incendo.cloud.parser.ParserParameter: Returns the key that identifies the parameter.
key() - Method in interface org.incendo.cloud.permission.PredicatePermission
key(CloudKey<T>) - Method in class org.incendo.cloud.component.CommandComponent.Builder: Sets the CommandComponent.Builder.name(String) and the value type to the values contained in the given cloudKey.

L

lastRemainingCharacter() - Method in interface org.incendo.cloud.context.CommandInput: Returns the last remaining character.
lastRemainingToken() - Method in interface org.incendo.cloud.context.CommandInput: Returns the last remaining token.
length() - Method in interface org.incendo.cloud.context.CommandInput: Returns the length of the input string.
liberal() - Method in exception class org.incendo.cloud.parser.standard.BooleanParser.BooleanParseException: Returns whether the parser is liberal.
Liberal - Annotation Type in org.incendo.cloud.annotation.specifier: Annotation used to set the parsing mode of a boolean parser to liberal.
LIBERAL - Static variable in class org.incendo.cloud.parser.StandardParameters: Indicates that a boolean argument should be liberal.
LIBERAL_FLAG_PARSING - Enum constant in enum org.incendo.cloud.setting.ManagerSetting: Allows parsing flags at any position after the last literal by appending flag argument nodes between each command node.
list() - Method in interface org.incendo.cloud.suggestion.Suggestions: Returns the list of suggestions.
literal(String, String...) - Method in class org.incendo.cloud.Command.Builder: Inserts a required literal into the command chain.
literal(String, String...) - Static method in class org.incendo.cloud.parser.standard.LiteralParser: Creates a new literal parser that accepts the given name and aliases.
literal(String, Description, String...) - Method in class org.incendo.cloud.Command.Builder: Inserts a required literal into the command chain.
LITERAL - Enum constant in enum org.incendo.cloud.component.CommandComponent.ComponentType: A literal component that can be parsed by its name, or any of its aliases.
LiteralParser<C> - Class in org.incendo.cloud.parser.standard
lockRegistration() - Method in class org.incendo.cloud.CommandManager: Transition the command manager from either RegistrationState.BEFORE_REGISTRATION or RegistrationState.REGISTERING to RegistrationState.AFTER_REGISTRATION.
longComponent() - Static method in class org.incendo.cloud.parser.standard.LongParser: Returns a CommandComponent.Builder using LongParser.longParser() as the parser.
longestPath() - Method in interface org.incendo.cloud.help.result.MultipleCommandResult: Returns the longest path shared between the children.
LongParseException(String, LongParser<?>, CommandContext<?>) - Constructor for exception class org.incendo.cloud.parser.standard.LongParser.LongParseException: Create a new LongParser.LongParseException.
longParser() - Static method in class org.incendo.cloud.parser.standard.LongParser: Creates a new long parser using LongParser.DEFAULT_MINIMUM and LongParser.DEFAULT_MAXIMUM as the limits.
longParser(long) - Static method in class org.incendo.cloud.parser.standard.LongParser: Creates a new long parser using LongParser.DEFAULT_MAXIMUM as the maximum value.
longParser(long, long) - Static method in class org.incendo.cloud.parser.standard.LongParser: Creates a new long parser.
LongParser<C> - Class in org.incendo.cloud.parser.standard
LongParser(long, long) - Constructor for class org.incendo.cloud.parser.standard.LongParser: Construct a new long parser
LongParser.LongParseException - Exception Class in org.incendo.cloud.parser.standard
longRange(long, long) - Static method in interface org.incendo.cloud.type.range.Range: Creates a new range.
LongRange - Interface in org.incendo.cloud.type.range

M

makeSuggestions() - Method in class org.incendo.cloud.internal.SuggestionContext: Create Suggestions from the current context.
manager(CommandManager<C>) - Method in class org.incendo.cloud.Command.Builder: Supplies a command manager instance to the builder.
ManagerSetting - Enum in org.incendo.cloud.setting: Configurable command related settings
map(B) - Method in interface org.incendo.cloud.SenderMapper: Maps a command sender to another type.
map(CommandContext<C>, U, V) - Method in interface org.incendo.cloud.parser.aggregate.AggregateParserPairBuilder.Mapper.DirectSuccessMapper
map(CommandContext<C>, U, V) - Method in interface org.incendo.cloud.parser.aggregate.AggregateParserPairBuilder.Mapper: Maps the results of the child parsers to the output type.
map(CommandContext<C>, U, V, Z) - Method in interface org.incendo.cloud.parser.aggregate.AggregateParserTripletBuilder.Mapper.DirectSuccessMapper
map(CommandContext<C>, U, V, Z) - Method in interface org.incendo.cloud.parser.aggregate.AggregateParserTripletBuilder.Mapper: Maps the results of the child parsers to the output type.
map(CommandContext<C>, ArgumentParseResult<I>) - Method in interface org.incendo.cloud.parser.MappedArgumentParser.Mapper: Maps the input to a future that completes with the output.
map(CommandContext<C>, AggregateParsingContext<C>) - Method in interface org.incendo.cloud.parser.aggregate.AggregateResultMapper.DirectSuccessMapper
map(CommandContext<C>, AggregateParsingContext<C>) - Method in interface org.incendo.cloud.parser.aggregate.AggregateResultMapper: Maps the given context into the output of type AggregateResultMapper.
map(Suggestion) - Method in interface org.incendo.cloud.suggestion.SuggestionMapper: Maps the suggestion to the responding suggestion of type SuggestionMapper.
mapAnnotation(A, TypeToken<?>) - Method in interface org.incendo.cloud.parser.ParserRegistry.AnnotationMapper: Returns the parser parameters that correspond to the given annotation.
mapEither(Function<U, R>, Function<V, R>) - Method in interface org.incendo.cloud.type.Either: Extract Either.primary() or Either.fallback(), in that order, applying the appropriate function to map the result to R.
mapped(SuggestionMapper<S2>) - Method in class org.incendo.cloud.suggestion.DelegatingSuggestionFactory
mapped(SuggestionMapper<S2>) - Method in interface org.incendo.cloud.suggestion.SuggestionFactory: Returns a new suggestion factory that maps the results of this factory to the type SuggestionFactory using the given mapper.
MappedArgumentParser<C,I,O> - Interface in org.incendo.cloud.parser: An argument parser which wraps another argument parser, converting the output type.
MappedArgumentParser.Mapper<C,I,O> - Interface in org.incendo.cloud.parser
MappedArgumentParserImpl<C,I,O> - Class in org.incendo.cloud.parser
mapper() - Method in interface org.incendo.cloud.parser.aggregate.AggregateParser: Returns the result mapper.
mapSuccess(TypeToken<O>, BiFunction<CommandContext<C>, T, CompletableFuture<O>>) - Method in interface org.incendo.cloud.parser.ParserDescriptor: Create a descriptor for a mapped parser.
mapSuccess(Class<O>, BiFunction<CommandContext<C>, T, CompletableFuture<O>>) - Method in interface org.incendo.cloud.parser.ParserDescriptor: Create a descriptor for a mapped parser.
mapSuccess(BiFunction<CommandContext<C>, T, CompletableFuture<O>>) - Method in interface org.incendo.cloud.parser.ArgumentParser: Create a parser that passes through failures and maps successfully parsed values with mapper.
mapSuccess(Function<T, O>) - Method in class org.incendo.cloud.parser.ArgumentParseResult: Returns the result from applying mapper to the parsed value and wrapping in ArgumentParseResult.success(Object), or the same failure as this result.
mapSuccess(CommandContext<C>, U, V) - Method in interface org.incendo.cloud.parser.aggregate.AggregateParserPairBuilder.Mapper.DirectSuccessMapper: Maps the results of the child parsers to the output type.
mapSuccess(CommandContext<C>, U, V, Z) - Method in interface org.incendo.cloud.parser.aggregate.AggregateParserTripletBuilder.Mapper.DirectSuccessMapper: Maps the results of the child parsers to the output type.
mapSuccess(CommandContext<C>, AggregateParsingContext<C>) - Method in interface org.incendo.cloud.parser.aggregate.AggregateResultMapper.DirectSuccessMapper: Maps the given context into the output of type AggregateResultMapper.DirectSuccessMapper.
mapSuccessFuture(Function<T, CompletableFuture<O>>) - Method in class org.incendo.cloud.parser.ArgumentParseResult: Returns a success future resulting from applying mapper to the parsed value and wrapping in ArgumentParseResult.success(Object), or a completed future with the same failure as this result.
markEnd() - Method in class org.incendo.cloud.context.ParsingContext: Set the end time.
markStart() - Method in class org.incendo.cloud.context.ParsingContext: Set the start time.
max() - Element in annotation type org.incendo.cloud.annotation.specifier.Range: Maximum value accepted by the parser
max() - Method in interface org.incendo.cloud.type.range.ByteRange
max() - Method in interface org.incendo.cloud.type.range.DoubleRange
max() - Method in interface org.incendo.cloud.type.range.FloatRange
max() - Method in interface org.incendo.cloud.type.range.IntRange
max() - Method in interface org.incendo.cloud.type.range.LongRange
max() - Method in interface org.incendo.cloud.type.range.Range: Returns the maximum value (inclusive).
max() - Method in interface org.incendo.cloud.type.range.ShortRange
maxByte() - Method in interface org.incendo.cloud.type.range.ByteRange: Returns the maximum value (inclusive).
maxDouble() - Method in interface org.incendo.cloud.type.range.DoubleRange: Returns the maximum value (inclusive).
maxFloat() - Method in interface org.incendo.cloud.type.range.FloatRange: Returns the maximum value (inclusive).
maxInt() - Method in interface org.incendo.cloud.type.range.IntRange: Returns the maximum value (inclusive).
maxLong() - Method in interface org.incendo.cloud.type.range.LongRange: Returns the maximum value (inclusive).
maxShort() - Method in interface org.incendo.cloud.type.range.ShortRange: Returns the maximum value (inclusive).
merge(ParserParameters) - Method in class org.incendo.cloud.parser.ParserParameters: Attempt to merge two ParserParameters instances.
meta() - Method in class org.incendo.cloud.bean.CommandBean: Returns the command meta for the constructed command.
meta() - Method in class org.incendo.cloud.Command.Builder: Returns the current command meta value.
meta(CloudKey<V>, V) - Method in class org.incendo.cloud.Command.Builder: Adds command meta to the internal command meta-map.
META_KEY_ACCESS - Static variable in class org.incendo.cloud.internal.CommandNode
META_KEY_SENDER_TYPES - Static variable in class org.incendo.cloud.internal.CommandNode
min() - Element in annotation type org.incendo.cloud.annotation.specifier.Range: Minimum value accepted by the parser
min() - Method in interface org.incendo.cloud.type.range.ByteRange
min() - Method in interface org.incendo.cloud.type.range.DoubleRange
min() - Method in interface org.incendo.cloud.type.range.FloatRange
min() - Method in interface org.incendo.cloud.type.range.IntRange
min() - Method in interface org.incendo.cloud.type.range.LongRange
min() - Method in interface org.incendo.cloud.type.range.Range: Returns the minimum value (inclusive).
min() - Method in interface org.incendo.cloud.type.range.ShortRange
minByte() - Method in interface org.incendo.cloud.type.range.ByteRange: Returns the minimum value (inclusive).
minDouble() - Method in interface org.incendo.cloud.type.range.DoubleRange: Returns the minimum value (inclusive).
minFloat() - Method in interface org.incendo.cloud.type.range.FloatRange: Returns the minimum value (inclusive).
minInt() - Method in interface org.incendo.cloud.type.range.IntRange: Returns the minimum value (inclusive).
minLong() - Method in interface org.incendo.cloud.type.range.LongRange: Returns the minimum value (inclusive).
minShort() - Method in interface org.incendo.cloud.type.range.ShortRange: Returns the minimum value (inclusive).
MISSING_ARGUMENT - Enum constant in enum org.incendo.cloud.parser.flag.CommandFlagParser.FailureReason
missingPermission() - Method in exception class org.incendo.cloud.exception.NoPermissionException: Returns the missing Permission
mode() - Method in class org.incendo.cloud.parser.flag.CommandFlag: Returns the mode of this flag.
moveCursor(int) - Method in interface org.incendo.cloud.context.CommandInput: Moves the cursor chars positions.
MultipleCommandResult<C> - Interface in org.incendo.cloud.help.result: A list of commands.
MutableCloudKeyContainer - Interface in org.incendo.cloud.key

N

name() - Method in interface org.incendo.cloud.bean.CommandProperties: Returns the command name.
name() - Method in class org.incendo.cloud.component.CommandComponent.Builder: Returns the current name, if it has been set.
name() - Method in class org.incendo.cloud.component.CommandComponent: Returns the name of the component.
name() - Method in class org.incendo.cloud.key.CloudKey: Returns the name of the key.
name() - Method in class org.incendo.cloud.parser.flag.CommandFlag: Returns the name of the flag.
name(String) - Method in class org.incendo.cloud.component.CommandComponent.Builder: Sets the name of the component.
newBuilder(String, CommandMeta, String...) - Static method in class org.incendo.cloud.Command: Creates a new command builder.
newBuilder(String, CommandMeta, Description, String...) - Static method in class org.incendo.cloud.Command: Creates a new command builder.
newTree(CommandManager<C>) - Static method in class org.incendo.cloud.CommandTree: Creates a new command tree instance
NO_FLAG_STARTED - Enum constant in enum org.incendo.cloud.parser.flag.CommandFlagParser.FailureReason
NO_PERMISSION - Enum constant in enum org.incendo.cloud.parser.flag.CommandFlagParser.FailureReason
NoCommandInLeafException - Exception Class in org.incendo.cloud.exception: Thrown when a CommandComponent that is registered as a leaf node, does not contain an owning Command
NoCommandInLeafException(CommandComponent<?>) - Constructor for exception class org.incendo.cloud.exception.NoCommandInLeafException: Create a new no command in leaf exception instance
nodeMeta() - Method in class org.incendo.cloud.internal.CommandNode: Returns the node meta instance
nonFlagArguments() - Method in class org.incendo.cloud.Command: Returns a mutable copy of the command components, ignoring flag arguments.
nonSchedulingExecutor() - Static method in interface org.incendo.cloud.execution.ExecutionCoordinator: Returns the non-scheduling executor.
noOpCommandExecutionHandler() - Static method in interface org.incendo.cloud.execution.CommandExecutionHandler: Returns a CommandExecutionHandler that does nothing (no-op).
noopHandler() - Static method in interface org.incendo.cloud.exception.handling.ExceptionHandler: Returns an exception handler that does nothing.
NoPermissionException - Exception Class in org.incendo.cloud.exception: Exception thrown when a command sender misses a permission required to execute a Command
NoPermissionException(PermissionResult, Object, List<CommandComponent<?>>) - Constructor for exception class org.incendo.cloud.exception.NoPermissionException: Constructs a new no permission exception,
NoSuchCommandException - Exception Class in org.incendo.cloud.exception: Exception thrown when a command sender tries to execute a command that doesn't exist
NoSuchCommandException(Object, List<CommandComponent<?>>, String) - Constructor for exception class org.incendo.cloud.exception.NoSuchCommandException: Construct a no such command exception
noSuggestions() - Static method in interface org.incendo.cloud.suggestion.SuggestionProvider: Get a suggestion provider that provides no suggestions.
NullAnnotationAccessor() - Constructor for class org.incendo.cloud.util.annotation.AnnotationAccessor.NullAnnotationAccessor
nullCommandRegistrationHandler() - Static method in interface org.incendo.cloud.internal.CommandRegistrationHandler: Create a new CommandRegistrationHandler that does nothing
NumberParseException - Exception Class in org.incendo.cloud.exception.parsing
NumberParseException(String, NumberParser<?, ?, ?>, CommandContext<?>) - Constructor for exception class org.incendo.cloud.exception.parsing.NumberParseException: Constructs a new number parse exception.
NumberParser<C,N,R> - Class in org.incendo.cloud.parser.standard
NumberParser(R) - Constructor for class org.incendo.cloud.parser.standard.NumberParser
numberType() - Method in exception class org.incendo.cloud.exception.parsing.NumberParseException: Returns the number type.
numberType() - Method in exception class org.incendo.cloud.parser.standard.ByteParser.ByteParseException
numberType() - Method in exception class org.incendo.cloud.parser.standard.DoubleParser.DoubleParseException
numberType() - Method in exception class org.incendo.cloud.parser.standard.FloatParser.FloatParseException
numberType() - Method in exception class org.incendo.cloud.parser.standard.IntegerParser.IntegerParseException
numberType() - Method in exception class org.incendo.cloud.parser.standard.LongParser.LongParseException
numberType() - Method in exception class org.incendo.cloud.parser.standard.ShortParser.ShortParseException

O

of(boolean, Permission) - Static method in interface org.incendo.cloud.permission.PermissionResult: Creates a result that wraps the given boolean result.
of(C, String) - Static method in interface org.incendo.cloud.help.HelpQuery: Creates a new help query.
of(U, V, W) - Static method in class org.incendo.cloud.type.tuple.Triplet: Create a new 3-tuple
of(U, V, W, X) - Static method in class org.incendo.cloud.type.tuple.Quartet: Create a new 4-tuple
of(U, V, W, X, Y) - Static method in class org.incendo.cloud.type.tuple.Quintet: Create a new 5-tuple
of(U, V, W, X, Y, Z) - Static method in class org.incendo.cloud.type.tuple.Sextet: Create a new 6-tuple
of(TypeToken<T>, ExceptionHandler<C, ? extends T>) - Static method in class org.incendo.cloud.exception.handling.ExceptionHandlerRegistration: Returns a new registration.
of(Iterable<String>) - Static method in interface org.incendo.cloud.context.CommandInput: Returns a new CommandInput instance from the given input.
of(Object...) - Static method in class org.incendo.cloud.type.tuple.DynamicTuple: Create a new dynamic tuple, containing the given elements
of(String) - Static method in interface org.incendo.cloud.caption.Caption: Creates a new caption with a given key
of(String) - Static method in class org.incendo.cloud.component.preprocessor.RegexPreprocessor: Create a new preprocessor using StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_REGEX as the failure caption
of(String) - Static method in interface org.incendo.cloud.context.CommandInput: Returns a new CommandInput instance from the given input.
of(String) - Static method in interface org.incendo.cloud.description.Description: Creates a command description instance.
of(String) - Static method in class org.incendo.cloud.key.CloudKey: Creates a new type-less key.
of(String) - Static method in interface org.incendo.cloud.permission.Permission: Returns a simple permission that is represented by the given permission string.
of(String, TypeToken<T>) - Static method in class org.incendo.cloud.key.CloudKey: Creates a new key.
of(String, Class<T>) - Static method in class org.incendo.cloud.key.CloudKey: Creates a new key.
of(String, String) - Static method in interface org.incendo.cloud.caption.CaptionVariable: Creates a new caption variable instance.
of(String, String...) - Static method in interface org.incendo.cloud.bean.CommandProperties: Construct a new instance
of(String, Caption) - Static method in class org.incendo.cloud.component.preprocessor.RegexPreprocessor: Create a new preprocessor
of(AnnotatedElement) - Static method in interface org.incendo.cloud.util.annotation.AnnotationAccessor: Get a AnnotationAccessor instance for a AnnotatedElement, such as a Class or a Method.
of(Predicate<C>) - Static method in interface org.incendo.cloud.permission.PredicatePermission: Creates a new predicate permission
of(Map<? extends Caption, ? extends String>) - Static method in class org.incendo.cloud.caption.ImmutableConstantCaptionProvider: Construct a new immutable ConstantCaptionProvider instance.
of(Command<C>, String) - Static method in interface org.incendo.cloud.help.result.CommandEntry: Creates a new command entry.
of(CommandContext<C>) - Static method in interface org.incendo.cloud.execution.CommandResult: Creates a CommandResult using the given context.
of(CommandContext<C>, TypeToken<?>) - Static method in interface org.incendo.cloud.injection.InjectionRequest: Creates a new injection request.
of(CommandContext<C>, TypeToken<?>, AnnotationAccessor) - Static method in interface org.incendo.cloud.injection.InjectionRequest: Creates a new injection request.
of(CommandContext<C>, Command<C>) - Static method in interface org.incendo.cloud.execution.postprocessor.CommandPostprocessingContext: Returns a new postprocessing context.
of(CommandContext<C>, CommandInput) - Static method in interface org.incendo.cloud.execution.preprocessor.CommandPreprocessingContext: Returns a new preprocessing context.
of(HelpQuery<C>, String, List<String>) - Static method in interface org.incendo.cloud.help.result.MultipleCommandResult: Creates a new result.
of(HelpQuery<C>, List<CommandEntry<C>>) - Static method in interface org.incendo.cloud.help.result.IndexCommandResult: Creates a new result.
of(HelpQuery<C>, CommandEntry<C>) - Static method in interface org.incendo.cloud.help.result.VerboseCommandResult: Creates a new result.
of(CloudKey<Void>, Predicate<C>) - Static method in interface org.incendo.cloud.permission.PredicatePermission: Creates a new predicate permission
of(ArgumentParser<C, T>, TypeToken<T>) - Static method in interface org.incendo.cloud.parser.ParserDescriptor: Creates a new parser descriptor.
of(ArgumentParser<C, T>, Class<T>) - Static method in interface org.incendo.cloud.parser.ParserDescriptor: Creates a new parser descriptor.
of(AnnotationAccessor...) - Static method in interface org.incendo.cloud.util.annotation.AnnotationAccessor: Get a AnnotationAccessor instance that delegates to multiple AnnotatedElement instances.
of(U, V) - Static method in class org.incendo.cloud.type.tuple.Pair: Create a new 2-tuple
ofFallback(V) - Static method in interface org.incendo.cloud.type.Either: Creates an instance with a value of the fallback type Either.
ofPrimary(U) - Static method in interface org.incendo.cloud.type.Either: Creates an instance with a value of the primary type Either.
ofType(Class<T>, String) - Static method in class org.incendo.cloud.component.CommandComponent: Creates a new mutable builder.
optional() - Method in class org.incendo.cloud.component.CommandComponent.Builder: Sets required to false.
optional() - Method in enum org.incendo.cloud.component.CommandComponent.ComponentType: Returns whether the component is optional
optional() - Method in class org.incendo.cloud.component.CommandComponent: Returns whether the argument is optional.
optional(String) - Method in class org.incendo.cloud.context.CommandContext: Returns the value associated with the given key.
optional(String) - Method in interface org.incendo.cloud.key.CloudKeyContainer: Returns the value associated with the given key.
optional(String) - Method in class org.incendo.cloud.key.SimpleMutableCloudKeyContainer
optional(String) - Method in class org.incendo.cloud.meta.SimpleCommandMeta: Returns the value associated with the given key.
optional(String, CommandComponent.Builder<? super C, T>) - Method in class org.incendo.cloud.Command.Builder: Marks the builder as optional and adds it to the command.
optional(String, ParserDescriptor<? super C, T>) - Method in class org.incendo.cloud.Command.Builder: Adds the given optional argument to the command.
optional(String, ParserDescriptor<? super C, T>, DefaultValue<? super C, T>) - Method in class org.incendo.cloud.Command.Builder: Adds the given optional argument to the command.
optional(String, ParserDescriptor<? super C, T>, DefaultValue<? super C, T>, Description) - Method in class org.incendo.cloud.Command.Builder: Adds the given optional argument to the command.
optional(String, ParserDescriptor<? super C, T>, DefaultValue<? super C, T>, Description, SuggestionProvider<? super C>) - Method in class org.incendo.cloud.Command.Builder: Adds the given optional argument to the command.
optional(String, ParserDescriptor<? super C, T>, DefaultValue<? super C, T>, SuggestionProvider<? super C>) - Method in class org.incendo.cloud.Command.Builder: Adds the given optional argument to the command.
optional(String, ParserDescriptor<? super C, T>, Description) - Method in class org.incendo.cloud.Command.Builder: Adds the given optional argument to the command.
optional(String, ParserDescriptor<? super C, T>, Description, SuggestionProvider<? super C>) - Method in class org.incendo.cloud.Command.Builder: Adds the given optional argument to the command.
optional(String, ParserDescriptor<? super C, T>, SuggestionProvider<? super C>) - Method in class org.incendo.cloud.Command.Builder: Adds the given optional argument to the command.
optional(DefaultValue<? super C, T>) - Method in class org.incendo.cloud.component.CommandComponent.Builder: Sets required to true and updates the defaultValue.
optional(CommandComponent.Builder<? super C, T>) - Method in class org.incendo.cloud.Command.Builder: Marks the builder as optional and adds it to the command.
optional(CloudKey<T>) - Method in class org.incendo.cloud.context.CommandContext: Returns the value associated with the given key.
optional(CloudKey<T>, ParserDescriptor<? super C, T>) - Method in class org.incendo.cloud.Command.Builder: Adds the given optional argument to the command.
optional(CloudKey<T>, ParserDescriptor<? super C, T>, DefaultValue<? super C, T>) - Method in class org.incendo.cloud.Command.Builder: Adds the given optional argument to the command.
optional(CloudKey<T>, ParserDescriptor<? super C, T>, DefaultValue<? super C, T>, Description) - Method in class org.incendo.cloud.Command.Builder: Adds the given optional argument to the command.
optional(CloudKey<T>, ParserDescriptor<? super C, T>, DefaultValue<? super C, T>, Description, SuggestionProvider<? super C>) - Method in class org.incendo.cloud.Command.Builder: Adds the given optional argument to the command.
optional(CloudKey<T>, ParserDescriptor<? super C, T>, DefaultValue<? super C, T>, SuggestionProvider<? super C>) - Method in class org.incendo.cloud.Command.Builder: Adds the given optional argument to the command.
optional(CloudKey<T>, ParserDescriptor<? super C, T>, Description) - Method in class org.incendo.cloud.Command.Builder: Adds the given optional argument to the command.
optional(CloudKey<T>, ParserDescriptor<? super C, T>, Description, SuggestionProvider<? super C>) - Method in class org.incendo.cloud.Command.Builder: Adds the given optional argument to the command.
optional(CloudKey<T>, ParserDescriptor<? super C, T>, SuggestionProvider<? super C>) - Method in class org.incendo.cloud.Command.Builder: Adds the given optional argument to the command.
optional(CloudKey<V>) - Method in interface org.incendo.cloud.key.CloudKeyContainer: Returns the value associated with the given key.
optional(CloudKey<V>) - Method in class org.incendo.cloud.key.SimpleMutableCloudKeyContainer
optional(CloudKey<V>) - Method in class org.incendo.cloud.meta.SimpleCommandMeta
optional(CloudKeyHolder<V>) - Method in interface org.incendo.cloud.key.CloudKeyContainer: Returns the value associated with the given keyHolder.
OPTIONAL_VARIABLE - Enum constant in enum org.incendo.cloud.component.CommandComponent.ComponentType: An optional variable that is parsed into an object if present.
optionalArgumentPair(String, TypeToken<O>, String, ParserDescriptor<C, U>, String, ParserDescriptor<C, V>, AggregateParserPairBuilder.Mapper<C, U, V, O>, Description) - Method in class org.incendo.cloud.Command.Builder: Creates a new argument pair that maps to a custom type.
optionalArgumentPair(String, String, ParserDescriptor<C, U>, String, ParserDescriptor<C, V>, Description) - Method in class org.incendo.cloud.Command.Builder: Creates a new argument pair that maps to Pair.
optionalArgumentPair(CloudKey<O>, TypeToken<O>, String, ParserDescriptor<C, U>, String, ParserDescriptor<C, V>, AggregateParserPairBuilder.Mapper<C, U, V, O>, Description) - Method in class org.incendo.cloud.Command.Builder: Creates a new argument pair that maps to a custom type.
optionalArgumentPair(CloudKey<Pair<U, V>>, String, ParserDescriptor<C, U>, String, ParserDescriptor<C, V>, Description) - Method in class org.incendo.cloud.Command.Builder: Creates a new argument pair that maps to Pair.
optionalArgumentTriplet(String, TypeToken<O>, String, ParserDescriptor<C, U>, String, ParserDescriptor<C, V>, String, ParserDescriptor<C, W>, AggregateParserTripletBuilder.Mapper<C, U, V, W, O>, Description) - Method in class org.incendo.cloud.Command.Builder: Creates a new argument triplet that maps to a custom type.
optionalArgumentTriplet(String, String, ParserDescriptor<C, U>, String, ParserDescriptor<C, V>, String, ParserDescriptor<C, W>, Description) - Method in class org.incendo.cloud.Command.Builder: Create a new argument pair that maps to Triplet
optionalArgumentTriplet(CloudKey<O>, TypeToken<O>, String, ParserDescriptor<C, U>, String, ParserDescriptor<C, V>, String, ParserDescriptor<C, W>, AggregateParserTripletBuilder.Mapper<C, U, V, W, O>, Description) - Method in class org.incendo.cloud.Command.Builder: Creates a new argument triplet that maps to a custom type.
optionalArgumentTriplet(CloudKey<Triplet<U, V, W>>, String, ParserDescriptor<C, U>, String, ParserDescriptor<C, V>, String, ParserDescriptor<C, W>, Description) - Method in class org.incendo.cloud.Command.Builder: Create a new argument pair that maps to Triplet
optionalPrefix() - Method in class org.incendo.cloud.syntax.StandardCommandSyntaxFormatter.FormattingInstance: Get the optional argument prefix
optionalSuffix() - Method in class org.incendo.cloud.syntax.StandardCommandSyntaxFormatter.FormattingInstance: Get the optional argument suffix
or(Permission) - Method in interface org.incendo.cloud.permission.Permission: Returns a permission that matches either this permission or the other permission.
or(Permission...) - Method in interface org.incendo.cloud.permission.Permission: Returns a permission that matches either this permission or any of the other permissions.
org.incendo.cloud - package org.incendo.cloud: cloud API main package
org.incendo.cloud.annotation.specifier - package org.incendo.cloud.annotation.specifier: Standard annotations used to specify options when creating commands or using parsers.
org.incendo.cloud.bean - package org.incendo.cloud.bean: Contains CommandBean and related types.
org.incendo.cloud.caption - package org.incendo.cloud.caption: Classes allowing for the configuration of messages.
org.incendo.cloud.component - package org.incendo.cloud.component: Command arguments that are used to build command parsing chains
org.incendo.cloud.component.preprocessor - package org.incendo.cloud.component.preprocessor: Pre-made argument preprocessors
org.incendo.cloud.context - package org.incendo.cloud.context: Command context stores values for a command sender before and during command execution and parsing
org.incendo.cloud.description - package org.incendo.cloud.description: Descriptions of different command components.
org.incendo.cloud.exception - package org.incendo.cloud.exception: cloud related exceptions
org.incendo.cloud.exception.handling - package org.incendo.cloud.exception.handling: Cloud's exception handling system.
org.incendo.cloud.exception.parsing - package org.incendo.cloud.exception.parsing: Parsing related exceptions
org.incendo.cloud.execution - package org.incendo.cloud.execution: Classes related to command execution and execution coordination
org.incendo.cloud.execution.postprocessor - package org.incendo.cloud.execution.postprocessor: Command postprocessing system
org.incendo.cloud.execution.preprocessor - package org.incendo.cloud.execution.preprocessor: Command preprocessing system
org.incendo.cloud.help - package org.incendo.cloud.help: Utilities for querying commands.
org.incendo.cloud.help.result - package org.incendo.cloud.help.result: Results of help queries.
org.incendo.cloud.injection - package org.incendo.cloud.injection: Classes related to parameter injection
org.incendo.cloud.internal - package org.incendo.cloud.internal: Classes that should be used internally in command managers
org.incendo.cloud.key - package org.incendo.cloud.key: Type-safe named keys.
org.incendo.cloud.meta - package org.incendo.cloud.meta: Command meta are classes associated with commands that store arbitrary data
org.incendo.cloud.parser - package org.incendo.cloud.parser: Parser classes used to parse command components.
org.incendo.cloud.parser.aggregate - package org.incendo.cloud.parser.aggregate: Aggregate parsers are parses that delegate to multiple inner parsers.
org.incendo.cloud.parser.flag - package org.incendo.cloud.parser.flag: Cloud flag system.
org.incendo.cloud.parser.standard - package org.incendo.cloud.parser.standard: Standard command argument types
org.incendo.cloud.permission - package org.incendo.cloud.permission: Command permissions
org.incendo.cloud.setting - package org.incendo.cloud.setting: Utilities for settings.
org.incendo.cloud.state - package org.incendo.cloud.state: Utilities for creating a state machine and enforcing safe state transitions.
org.incendo.cloud.suggestion - package org.incendo.cloud.suggestion: Command arguments that are used to build command parsing chains
org.incendo.cloud.syntax - package org.incendo.cloud.syntax: Utilities for syntax formatting.
org.incendo.cloud.type - package org.incendo.cloud.type: Types used throughout Cloud.
org.incendo.cloud.type.range - package org.incendo.cloud.type.range: Number range data types.
org.incendo.cloud.type.tuple - package org.incendo.cloud.type.tuple: Generic immutable n-tuples with non-null values for 1 < n ≥ 6
org.incendo.cloud.util - package org.incendo.cloud.util: Utility classes.
org.incendo.cloud.util.annotation - package org.incendo.cloud.util.annotation: Utilities for working with annotations.
OrPermission - Class in org.incendo.cloud.permission: Accepts as long as at least one of the permissions is accepted
OVERRIDE_EXISTING_COMMANDS - Enum constant in enum org.incendo.cloud.setting.ManagerSetting: Enables overriding of existing commands on supported platforms.

P

Pair<U,V> - Class in org.incendo.cloud.type.tuple: Immutable generic 2-tuple
Pair(U, V) - Constructor for class org.incendo.cloud.type.tuple.Pair
pairBuilder(String, ParserDescriptor<C, U>, String, ParserDescriptor<C, V>) - Static method in interface org.incendo.cloud.parser.aggregate.AggregateParser: Returns a new aggregate pair command parser builder.
ParameterInjector<C,T> - Interface in org.incendo.cloud.injection: Injector that injects parameters into Command annotated methods
ParameterInjector.ConstantInjector<C,T> - Class in org.incendo.cloud.injection
parameterInjectorRegistry() - Method in class org.incendo.cloud.CommandManager: Get the parameter injector registry instance
ParameterInjectorRegistry<C> - Class in org.incendo.cloud.injection: Registry containing mappings between Class Predicates and injectors.
ParameterInjectorRegistry() - Constructor for class org.incendo.cloud.injection.ParameterInjectorRegistry: Creates a new parameter injector registry
parameters() - Method in class org.incendo.cloud.parser.ParserParameters: Returns an immutable view of the internal map.
parent() - Method in class org.incendo.cloud.internal.CommandNode: Returns the parent node
parent(CommandNode<C>) - Method in class org.incendo.cloud.internal.CommandNode: Updates the parent node
parentNode() - Method in exception class org.incendo.cloud.exception.AmbiguousNodeException: Returns the parent node.
parse(CommandContext<C>, CommandInput) - Method in interface org.incendo.cloud.parser.ArgumentParser.FutureArgumentParser
parse(CommandContext<C>, CommandInput) - Method in interface org.incendo.cloud.parser.ArgumentParser: Attempts to parse the input into an object of type ArgumentParser.
parse(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.standard.StringArrayParser
parse(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.standard.BooleanParser
parse(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.standard.ByteParser
parse(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.standard.CharacterParser
parse(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.standard.DoubleParser
parse(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.standard.DurationParser
parse(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.standard.EnumParser
parse(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.standard.FloatParser
parse(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.standard.IntegerParser
parse(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.standard.LiteralParser
parse(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.standard.LongParser
parse(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.standard.ShortParser
parse(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.standard.StringParser
parse(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.standard.UUIDParser
parse(CommandContext<C>, CommandInput, Executor) - Method in class org.incendo.cloud.CommandTree: Attempts to parse a command from the provided input.
parseAnnotations(TypeToken<?>, Collection<? extends Annotation>) - Method in interface org.incendo.cloud.parser.ParserRegistry: Parses the given annotations into ParserParameters.
parseAnnotations(TypeToken<?>, Collection<? extends Annotation>) - Method in class org.incendo.cloud.parser.StandardParserRegistry
parseCurrentFlag(CommandContext<C>, CommandInput, Executor) - Method in class org.incendo.cloud.parser.flag.CommandFlagParser: Parses command input to figure out what flag is currently being typed at the end of the input queue.
parsed(String) - Static method in interface org.incendo.cloud.component.DefaultValue: Returns a default value that will be parsed together with the command.
PARSED_FLAGS - Static variable in class org.incendo.cloud.parser.flag.CommandFlagParser: Metadata for the set of parsed flags, used to detect duplicates.
parseDuration() - Method in class org.incendo.cloud.context.ParsingContext: Return the duration taken to parse the component.
parsedValue() - Method in class org.incendo.cloud.parser.ArgumentParseResult: Get the parsed value, if it exists
parseFuture(CommandContext<C>, CommandInput) - Method in interface org.incendo.cloud.parser.aggregate.AggregateParser
parseFuture(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.flag.CommandFlagParser
parseFuture(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.MappedArgumentParserImpl
parseFuture(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.standard.EitherParser
parseFuture(CommandContext<C>, CommandInput) - Method in interface org.incendo.cloud.parser.ArgumentParser.FutureArgumentParser
parseFuture(CommandContext<C>, CommandInput) - Method in interface org.incendo.cloud.parser.ArgumentParser: Returns a future that completes with the result of parsing the given commandInput.
parser() - Method in class org.incendo.cloud.component.CommandComponent.Builder: Returns the current parser, if it has been set.
parser() - Method in class org.incendo.cloud.component.CommandComponent: Returns the parser.
parser() - Method in class org.incendo.cloud.component.TypedCommandComponent
parser() - Method in exception class org.incendo.cloud.exception.parsing.NumberParseException: Returns the parser.
parser() - Method in interface org.incendo.cloud.parser.aggregate.AggregateParser
parser() - Method in interface org.incendo.cloud.parser.ParserDescriptor: Returns the parser.
parser(ArgumentParser<? super C, T>) - Method in class org.incendo.cloud.component.CommandComponent.Builder: Sets the parser.
parser(ParserDescriptor<? super C, T>) - Method in class org.incendo.cloud.component.CommandComponent.Builder: Sets the parser and valueType.
ParserContributor - Interface in org.incendo.cloud.parser: Contributes to the ParserRegistry.
parserDescriptor(ArgumentParser<C, T>, TypeToken<T>) - Static method in interface org.incendo.cloud.parser.ParserDescriptor: Creates a new parser descriptor.
parserDescriptor(ArgumentParser<C, T>, Class<T>) - Static method in interface org.incendo.cloud.parser.ParserDescriptor: Creates a new parser descriptor.
ParserDescriptor<C,T> - Interface in org.incendo.cloud.parser
ParserException - Exception Class in org.incendo.cloud.exception.parsing
ParserException(Class<?>, CommandContext<?>, Caption, CaptionVariable...) - Constructor for exception class org.incendo.cloud.exception.parsing.ParserException
ParserException(Throwable, Class<?>, CommandContext<?>, Caption, CaptionVariable...) - Constructor for exception class org.incendo.cloud.exception.parsing.ParserException
ParserParameter<T> - Class in org.incendo.cloud.parser: Parser parameter used when retrieving parsers from the ParserRegistry
ParserParameter(String, TypeToken<T>) - Constructor for class org.incendo.cloud.parser.ParserParameter: Create a new parser parameter
ParserParameters - Class in org.incendo.cloud.parser: Collection of parameter-object pairs
ParserParameters() - Constructor for class org.incendo.cloud.parser.ParserParameters
parserRegistry() - Method in class org.incendo.cloud.CommandManager: Returns the parser registry instance.
ParserRegistry<C> - Interface in org.incendo.cloud.parser: Registry that allows parsers to be referenced by the type of the values they produce, or by their names.
ParserRegistry.AnnotationMapper<A> - Interface in org.incendo.cloud.parser
parsingContext(int) - Method in class org.incendo.cloud.context.CommandContext: Returns the context for the component at the given position.
parsingContext(String) - Method in class org.incendo.cloud.context.CommandContext: Returns the context for the component with the given name.
parsingContext(CommandComponent<C>) - Method in class org.incendo.cloud.context.CommandContext: Returns the context for the given component.
ParsingContext<C> - Class in org.incendo.cloud.context
ParsingContext(CommandComponent<C>) - Constructor for class org.incendo.cloud.context.ParsingContext: Construct an ParsingContext object with the given argument.
parsingContexts() - Method in class org.incendo.cloud.context.CommandContext: Returns an unmodifiable view of the stored parsing contexts.
parsingExecutor(Executor) - Method in interface org.incendo.cloud.execution.ExecutionCoordinator.Builder: Sets the executor to run parsing logic on.
partialTokenMatches(boolean) - Static method in interface org.incendo.cloud.suggestion.FilteringSuggestionProcessor.Filter: Filter that requires every token of input to be a partial or full match for a single corresponding token in the suggestion.
passThrough() - Static method in interface org.incendo.cloud.suggestion.SuggestionProcessor: Creates a SuggestionProcessor that simply returns the input suggestions.
passThroughHandler() - Static method in interface org.incendo.cloud.exception.handling.ExceptionHandler: Returns an exception handler that re-throws the ExceptionContext.exception().
passThroughHandler(Consumer<ExceptionContext<C, T>>) - Static method in interface org.incendo.cloud.exception.handling.ExceptionHandler: Returns an exception handler that re-throws the ExceptionContext.exception() after invoking the given consumer.
pattern() - Method in exception class org.incendo.cloud.component.preprocessor.RegexPreprocessor.RegexValidationException: Returns the pattern that caused the string to fail.
patternReplacing(Pattern) - Static method in interface org.incendo.cloud.caption.CaptionFormatter: Returns a caption formatter that replaces the results from the given pattern with the values from the caption variables.
peek() - Method in interface org.incendo.cloud.context.CommandInput: Reads the character at the cursor without moving the cursor.
peekString() - Method in interface org.incendo.cloud.context.CommandInput: Peeks until the next whitespace is encountered, skipping leading whitespace.
peekString(int) - Method in interface org.incendo.cloud.context.CommandInput: Reads chars characters of the remaining input without moving the cursor.
permission() - Method in class org.incendo.cloud.parser.flag.CommandFlag: Returns the permission required to use this flag, if it exists.
permission() - Method in interface org.incendo.cloud.permission.PermissionResult: Returns the permission that this result came from.
permission(String) - Method in class org.incendo.cloud.Command.Builder: Specifies a command permission.
permission(String) - Static method in interface org.incendo.cloud.permission.Permission: Returns a simple permission that is represented by the given permission string.
permission(Permission) - Method in class org.incendo.cloud.Command.Builder: Specifies a command permission.
permission(PredicatePermission<C>) - Method in class org.incendo.cloud.Command.Builder: Specifies a command permission.
Permission - Interface in org.incendo.cloud.permission: A command permission representation.
permissionResult() - Method in exception class org.incendo.cloud.exception.NoPermissionException: Returns the falsy PermissionResult that caused this exception.
PermissionResult - Interface in org.incendo.cloud.permission: The cached result of a permission check, representing whether a command may be executed.
permissions() - Method in class org.incendo.cloud.permission.AndPermission
permissions() - Method in class org.incendo.cloud.permission.OrPermission
permissions() - Method in interface org.incendo.cloud.permission.Permission: Returns the inner permission nodes of this node.
permissionString() - Method in class org.incendo.cloud.permission.AndPermission
permissionString() - Method in class org.incendo.cloud.permission.OrPermission
permissionString() - Method in interface org.incendo.cloud.permission.Permission: Returns the string representation of the permission.
permissionString() - Method in interface org.incendo.cloud.permission.PredicatePermission
placeholderPattern() - Static method in interface org.incendo.cloud.caption.CaptionFormatter: Returns the pattern for CaptionFormatter.placeholderReplacing().
placeholderReplacing() - Static method in interface org.incendo.cloud.caption.CaptionFormatter: Returns a caption formatter that replaces placeholders in the form of <placeholder> with the caption variables.
postprocessContext(CommandContext<C>, Command<C>) - Method in class org.incendo.cloud.CommandManager: Postprocess a command context instance
PredicatePermission<C> - Interface in org.incendo.cloud.permission: A functional Permission implementation
prependHandler(CommandExecutionHandler<C>) - Method in class org.incendo.cloud.Command.Builder: Sets a new command execution handler that invokes the given handler before the current handler.
preprocess(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.component.CommandComponent: Preprocess command input.
preprocess(CommandContext<C>, CommandInput) - Method in interface org.incendo.cloud.component.preprocessor.ComponentPreprocessor: Pre-processes the associated component.
preprocess(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.component.preprocessor.RegexPreprocessor
preprocessContext(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.CommandManager: Preprocess a command context instance
preprocessor(ComponentPreprocessor<? super C>) - Method in class org.incendo.cloud.component.CommandComponent.Builder: Adds the preprocessor.
PreprocessorHolder<C> - Interface in org.incendo.cloud.component.preprocessor
preprocessors() - Method in class org.incendo.cloud.component.CommandComponent
preprocessors() - Method in interface org.incendo.cloud.component.preprocessor.PreprocessorHolder: Returns an unmodifiable collection of preprocessors.
preprocessors(Collection<ComponentPreprocessor<C>>) - Method in class org.incendo.cloud.component.CommandComponent.Builder: Adds the preprocessors.
primary() - Method in class org.incendo.cloud.parser.standard.EitherParser: Returns the primary parser.
primary() - Method in interface org.incendo.cloud.type.Either: Returns an optional containing the value of type Either, if it exists.
primaryFailure() - Method in exception class org.incendo.cloud.parser.standard.EitherParser.EitherParseException: Returns the throwable thrown by the primary parser.
primaryOrMapFallback(Function<V, U>) - Method in interface org.incendo.cloud.type.Either: Extract Either.primary(), or if it's not present, map Either.fallback() to U.
primaryType() - Method in exception class org.incendo.cloud.parser.standard.EitherParser.EitherParseException: Returns the type produced by the primary parser.
process(CommandPreprocessingContext<C>, Stream<Suggestion>) - Method in class org.incendo.cloud.suggestion.FilteringSuggestionProcessor
process(CommandPreprocessingContext<C>, Stream<Suggestion>) - Method in interface org.incendo.cloud.suggestion.SuggestionProcessor: Adds operations to the suggestions stream and returns the result.
PROCESSED_INDICATOR_KEY - Static variable in class org.incendo.cloud.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 org.incendo.cloud.execution.preprocessor.AcceptingCommandPreprocessor: Key used to access the context meta that indicates that the context has been fully processed
properties() - Method in class org.incendo.cloud.bean.CommandBean: Returns the properties of the command.
provide(Caption, C) - Method in interface org.incendo.cloud.caption.CaptionProvider: Returns the value of the given caption for the given recipient, if it recognized by this provider.
provide(Caption, C) - Method in class org.incendo.cloud.caption.ConstantCaptionProvider
provide(Caption, C) - Method in class org.incendo.cloud.caption.DelegatingCaptionProvider
proxies(Command<N>) - Method in class org.incendo.cloud.Command.Builder: Makes the current command be a proxy of the supplied command.
putAllCaptions(Map<? extends Caption, ? extends String>) - Method in class org.incendo.cloud.caption.ImmutableConstantCaptionProvider.Builder: Put all mappings from the specified map as entries to captions map.
putCaption(Map.Entry<? extends Caption, ? extends String>) - Method in class org.incendo.cloud.caption.ImmutableConstantCaptionProvider.Builder: Put one entry to the captions map.
putCaption(Caption, String) - Method in class org.incendo.cloud.caption.ImmutableConstantCaptionProvider.Builder: Put one entry to the captions map.

Q

Quartet<U,V,W,X> - Class in org.incendo.cloud.type.tuple: Immutable generic 5-tuple
Quartet(U, V, W, X) - Constructor for class org.incendo.cloud.type.tuple.Quartet
query() - Method in interface org.incendo.cloud.help.HelpQuery: Returns the query string.
query() - Method in interface org.incendo.cloud.help.result.HelpQueryResult: Returns the query.
query() - Method in interface org.incendo.cloud.help.result.IndexCommandResult: Returns the query.
query() - Method in interface org.incendo.cloud.help.result.MultipleCommandResult: Returns the query.
query() - Method in interface org.incendo.cloud.help.result.VerboseCommandResult: Returns the query.
query(HelpQuery<C>) - Method in interface org.incendo.cloud.help.HelpHandler: Handles the given query and returns the result.
query(HelpQuery<C>) - Method in class org.incendo.cloud.help.StandardHelpHandler: Handles the given query and returns the result.
queryRootIndex(C) - Method in interface org.incendo.cloud.help.HelpHandler: Queries for the root result.
Quintet<U,V,W,X,Y> - Class in org.incendo.cloud.type.tuple: Immutable generic 5-tuple
Quintet(U, V, W, X, Y) - Constructor for class org.incendo.cloud.type.tuple.Quintet
Quoted - Annotation Type in org.incendo.cloud.annotation.specifier: Annotation used to set the parsing mode of a string parser to quoted.
QUOTED - Enum constant in enum org.incendo.cloud.parser.standard.StringParser.StringMode
QUOTED - Static variable in class org.incendo.cloud.parser.StandardParameters: Indicates that a string argument should be quoted.
quotedStringParser() - Static method in class org.incendo.cloud.parser.standard.StringParser: Creates a new string parser that parses a string surrounded by either single or double quotes, or a single string if no quotes are found.

R

range() - Method in exception class org.incendo.cloud.exception.parsing.NumberParseException: Returns the range of acceptable input.
range() - Method in class org.incendo.cloud.parser.standard.NumberParser: Returns the range of acceptable values.
Range<N> - Interface in org.incendo.cloud.type.range: An inclusive range of numbers.
Range - Annotation Type in org.incendo.cloud.annotation.specifier: Used to specify min and max values of numerical parsers
RANGE_MAX - Static variable in class org.incendo.cloud.parser.StandardParameters: Maximum value accepted by a numerical parser
RANGE_MIN - Static variable in class org.incendo.cloud.parser.StandardParameters: Minimum value accepted by a numerical parser
rawInput() - Method in class org.incendo.cloud.context.CommandContext: Returns a copy of the raw input.
read() - Method in interface org.incendo.cloud.context.CommandInput: Reads the character at the cursor and move the cursor one character.
read(int) - Method in interface org.incendo.cloud.context.CommandInput: Reads chars characters of the remaining input and move the cursor chars characters.
readBoolean() - Method in interface org.incendo.cloud.context.CommandInput: Reads the string until the next whitespace and parses in into a Boolean.
readByte() - Method in interface org.incendo.cloud.context.CommandInput: Reads the string until the next whitespace and parses in into a Byte.
readDouble() - Method in interface org.incendo.cloud.context.CommandInput: Reads the string until the next whitespace and parses in into a Double.
readFloat() - Method in interface org.incendo.cloud.context.CommandInput: Reads the string until the next whitespace and parses in into a Float.
readInput() - Method in interface org.incendo.cloud.context.CommandInput: Returns the read input.
readInteger() - Method in interface org.incendo.cloud.context.CommandInput: Reads the string until the next whitespace and parses in into a Integer.
readInteger(int) - Method in interface org.incendo.cloud.context.CommandInput: Reads the string until the next whitespace and parses in into a Integer.
readLong() - Method in interface org.incendo.cloud.context.CommandInput: Reads the string until the next whitespace and parses in into a Long.
readShort() - Method in interface org.incendo.cloud.context.CommandInput: Reads the string until the next whitespace and parses in into a Short.
readString() - Method in interface org.incendo.cloud.context.CommandInput: Skips initial whitespace and reads until the next whitespace is encountered.
readStringSkipWhitespace() - Method in interface org.incendo.cloud.context.CommandInput: Reads until the next whitespace is encountered.
readStringSkipWhitespace(boolean) - Method in interface org.incendo.cloud.context.CommandInput: Reads until the next whitespace is encountered.
readUntil(char) - Method in interface org.incendo.cloud.context.CommandInput: Reads until the separator, and then preserves it.
readUntilAndSkip(char) - Method in interface org.incendo.cloud.context.CommandInput: Reads until the separator, and then skips the separator.
RegexPreprocessor<C> - Class in org.incendo.cloud.component.preprocessor: Command preprocessor that filters based on regular expressions
RegexPreprocessor.RegexValidationException - Exception Class in org.incendo.cloud.component.preprocessor: Exception thrown when input fails regex matching in RegexPreprocessor
register(TypeToken<T>, ExceptionHandlerRegistration.BuilderDecorator<C, T>) - Method in class org.incendo.cloud.exception.handling.ExceptionController: Decorates a registration builder and registers the result.
register(Class<T>, ExceptionHandlerRegistration.BuilderDecorator<C, T>) - Method in class org.incendo.cloud.exception.handling.ExceptionController: Decorates a registration builder and registers the result.
register(ExceptionHandlerRegistration<C, ? extends T>) - Method in class org.incendo.cloud.exception.handling.ExceptionController: Registers the given registration.
registerAnnotationMapper(Class<A>, ParserRegistry.AnnotationMapper<A>) - Method in interface org.incendo.cloud.parser.ParserRegistry: Registers a mapper that maps annotation instances to a map of parameter-object pairs.
registerAnnotationMapper(Class<A>, ParserRegistry.AnnotationMapper<A>) - Method in class org.incendo.cloud.parser.StandardParserRegistry
registerCapability(CloudCapability) - Method in class org.incendo.cloud.CommandManager: Registers the given capability.
registerCommand(Command<C>) - Method in class org.incendo.cloud.internal.CommandRegistrationHandler.NullCommandRegistrationHandler
registerCommand(Command<C>) - Method in interface org.incendo.cloud.internal.CommandRegistrationHandler: Attempt to register the command
registerCommandPostProcessor(CommandPostprocessor<C>) - Method in class org.incendo.cloud.CommandManager: Register a new command postprocessor.
registerCommandPreProcessor(CommandPreprocessor<C>) - Method in class org.incendo.cloud.CommandManager: Register a new command preprocessor.
registerDefaultExceptionHandlers(Consumer<Triplet<CommandContext<C>, Caption, List<CaptionVariable>>>, Consumer<Pair<String, Throwable>>) - Method in class org.incendo.cloud.CommandManager: Registers the default exception handlers.
registerHandler(TypeToken<T>, ExceptionHandler<C, ? extends T>) - Method in class org.incendo.cloud.exception.handling.ExceptionController: Registers the given exceptionHandler.
registerHandler(Class<T>, ExceptionHandler<C, ? extends T>) - Method in class org.incendo.cloud.exception.handling.ExceptionController: Registers the given exceptionHandler.
REGISTERING - Enum constant in enum org.incendo.cloud.state.RegistrationState: When at least one command has been registered, and more commands have been registered.
registerInjectionService(InjectionService<C>) - Method in class org.incendo.cloud.injection.ParameterInjectorRegistry: Registers an injection service that will be able to provide injections using ParameterInjectorRegistry.getInjectable(Class, CommandContext, AnnotationAccessor).
registerInjector(TypeToken<T>, ParameterInjector<C, T>) - Method in class org.incendo.cloud.injection.ParameterInjectorRegistry: Registers an injector for a particular type or any of it's assignable supertypes.
registerInjector(Class<T>, ParameterInjector<C, T>) - Method in class org.incendo.cloud.injection.ParameterInjectorRegistry: Registers an injector for a particular type or any of it's assignable supertypes.
registerInjector(Predicate<TypeToken<?>>, ParameterInjector<C, T>) - Method in class org.incendo.cloud.injection.ParameterInjectorRegistry: Registers an injector for a particular type predicate.
registerNamedParser(String, ParserDescriptor<C, ?>) - Method in interface org.incendo.cloud.parser.ParserRegistry: Registers a named parser supplier.
registerNamedParserSupplier(String, Function<ParserParameters, ArgumentParser<C, ?>>) - Method in interface org.incendo.cloud.parser.ParserRegistry: Registers a named parser supplier.
registerNamedParserSupplier(String, Function<ParserParameters, ArgumentParser<C, ?>>) - Method in class org.incendo.cloud.parser.StandardParserRegistry
registerParser(ParserDescriptor<C, T>) - Method in interface org.incendo.cloud.parser.ParserRegistry: Registers the parser described by the given descriptor.
registerParserSupplier(TypeToken<T>, Function<ParserParameters, ArgumentParser<C, ?>>) - Method in interface org.incendo.cloud.parser.ParserRegistry: Registers the given supplier as the default parser supplier for the given type.
registerParserSupplier(TypeToken<T>, Function<ParserParameters, ArgumentParser<C, ?>>) - Method in class org.incendo.cloud.parser.StandardParserRegistry
registerProvider(CaptionProvider<C>) - Method in interface org.incendo.cloud.caption.CaptionRegistry: Registers the given provider.
registerProvider(CaptionProvider<C>) - Method in class org.incendo.cloud.caption.CaptionRegistryImpl
registerSuggestionProvider(String, SuggestionProvider<C>) - Method in interface org.incendo.cloud.parser.ParserRegistry: Registers a new named suggestion providers.
registerSuggestionProvider(String, SuggestionProvider<C>) - Method in class org.incendo.cloud.parser.StandardParserRegistry
RegistrationState - Enum in org.incendo.cloud.state: The point in the registration lifecycle for this commands manager
remainingInput() - Method in interface org.incendo.cloud.context.CommandInput: Returns the remaining input.
remainingLength() - Method in interface org.incendo.cloud.context.CommandInput: Returns the length of the remaining input.
remainingTokens() - Method in interface org.incendo.cloud.context.CommandInput: Returns the number of remaining tokens.
remove(String) - Method in interface org.incendo.cloud.key.MutableCloudKeyContainer: Removes value associated with the given key.
remove(CloudKey<?>) - Method in class org.incendo.cloud.context.CommandContext: Removes value associated with the given key.
remove(CloudKey<?>) - Method in interface org.incendo.cloud.key.MutableCloudKeyContainer: Removes value associated with the given key.
remove(CloudKey<?>) - Method in class org.incendo.cloud.key.SimpleMutableCloudKeyContainer
remove(CloudKeyHolder<?>) - Method in interface org.incendo.cloud.key.MutableCloudKeyContainer: Removes value associated with the given keyHolder.
removeChild(CommandNode<C>) - Method in class org.incendo.cloud.internal.CommandNode: Removes the given child as a child from this node
render(HelpRenderer<C>) - Method in interface org.incendo.cloud.help.result.HelpQueryResult: Renders the result using the given renderer.
render(HelpQueryResult<C>) - Method in interface org.incendo.cloud.help.HelpRenderer: Renders the result to the sender that created the query.
REPEATABLE - Enum constant in enum org.incendo.cloud.parser.flag.CommandFlag.FlagMode: Multiple values can be provided for the flag, and should be extracted using FlagContext.getAll(CommandFlag).
replaceAll(String, Pattern, Function<MatchResult, String>) - Static method in class org.incendo.cloud.util.StringUtils: Replace all matches in a string.
required() - Method in class org.incendo.cloud.component.CommandComponent.Builder: Sets required to true.
required() - Method in enum org.incendo.cloud.component.CommandComponent.ComponentType: Returns whether the component is required
required() - Method in class org.incendo.cloud.component.CommandComponent: Returns whether the argument is required.
required(boolean) - Method in class org.incendo.cloud.component.CommandComponent.Builder: Sets whether the component is required.
required(String, CommandComponent.Builder<? super C, T>) - Method in class org.incendo.cloud.Command.Builder: Marks the builder as required and adds it to the command.
required(String, ParserDescriptor<? super C, T>) - Method in class org.incendo.cloud.Command.Builder: Adds the given required argument to the command.
required(String, ParserDescriptor<? super C, T>, Description) - Method in class org.incendo.cloud.Command.Builder: Adds the given required argument to the command.
required(String, ParserDescriptor<? super C, T>, Description, SuggestionProvider<? super C>) - Method in class org.incendo.cloud.Command.Builder: Adds the given required argument to the command.
required(String, ParserDescriptor<? super C, T>, SuggestionProvider<? super C>) - Method in class org.incendo.cloud.Command.Builder: Adds the given required argument to the command.
required(CommandComponent.Builder<? super C, T>) - Method in class org.incendo.cloud.Command.Builder: Marks the builder as required and adds it to the command.
required(CloudKey<T>, ParserDescriptor<? super C, T>) - Method in class org.incendo.cloud.Command.Builder: Adds the given required argument to the command.
required(CloudKey<T>, ParserDescriptor<? super C, T>, Description) - Method in class org.incendo.cloud.Command.Builder: Adds the given required argument to the command.
required(CloudKey<T>, ParserDescriptor<? super C, T>, Description, SuggestionProvider<? super C>) - Method in class org.incendo.cloud.Command.Builder: Adds the given required argument to the command.
required(CloudKey<T>, ParserDescriptor<? super C, T>, SuggestionProvider<? super C>) - Method in class org.incendo.cloud.Command.Builder: Adds the given required argument to the command.
REQUIRED_VARIABLE - Enum constant in enum org.incendo.cloud.component.CommandComponent.ComponentType: A required variable argument that is parsed into an object.
requiredArgumentPair(String, TypeToken<O>, String, ParserDescriptor<C, U>, String, ParserDescriptor<C, V>, AggregateParserPairBuilder.Mapper<C, U, V, O>, Description) - Method in class org.incendo.cloud.Command.Builder: Creates a new argument pair that maps to a custom type.
requiredArgumentPair(String, String, ParserDescriptor<C, U>, String, ParserDescriptor<C, V>, Description) - Method in class org.incendo.cloud.Command.Builder: Creates a new argument pair that maps to Pair.
requiredArgumentPair(CloudKey<O>, TypeToken<O>, String, ParserDescriptor<C, U>, String, ParserDescriptor<C, V>, AggregateParserPairBuilder.Mapper<C, U, V, O>, Description) - Method in class org.incendo.cloud.Command.Builder: Creates a new argument pair that maps to a custom type.
requiredArgumentPair(CloudKey<Pair<U, V>>, String, ParserDescriptor<C, U>, String, ParserDescriptor<C, V>, Description) - Method in class org.incendo.cloud.Command.Builder: Creates a new argument pair that maps to Pair.
requiredArgumentTriplet(String, TypeToken<O>, String, ParserDescriptor<C, U>, String, ParserDescriptor<C, V>, String, ParserDescriptor<C, W>, AggregateParserTripletBuilder.Mapper<C, U, V, W, O>, Description) - Method in class org.incendo.cloud.Command.Builder: Creates a new argument triplet that maps to a custom type.
requiredArgumentTriplet(String, String, ParserDescriptor<C, U>, String, ParserDescriptor<C, V>, String, ParserDescriptor<C, W>, Description) - Method in class org.incendo.cloud.Command.Builder: Create a new argument pair that maps to Triplet
requiredArgumentTriplet(CloudKey<O>, TypeToken<O>, String, ParserDescriptor<C, U>, String, ParserDescriptor<C, V>, String, ParserDescriptor<C, W>, AggregateParserTripletBuilder.Mapper<C, U, V, W, O>, Description) - Method in class org.incendo.cloud.Command.Builder: Creates a new argument triplet that maps to a custom type.
requiredArgumentTriplet(CloudKey<Triplet<U, V, W>>, String, ParserDescriptor<C, U>, String, ParserDescriptor<C, V>, String, ParserDescriptor<C, W>, Description) - Method in class org.incendo.cloud.Command.Builder: Create a new argument pair that maps to Triplet
requiredPrefix() - Method in class org.incendo.cloud.syntax.StandardCommandSyntaxFormatter.FormattingInstance: Get the required argument prefix
requiredSenderTypes() - Method in exception class org.incendo.cloud.exception.InvalidCommandSenderException: Returns the required sender types, a sender must satisfy one.
requiredSuffix() - Method in class org.incendo.cloud.syntax.StandardCommandSyntaxFormatter.FormattingInstance: Get the required argument suffix
requireState(S) - Method in interface org.incendo.cloud.state.Stateful: Requires that the current Stateful.state() is equal to the expected state, and fails exceptionally if the states are different.
reverse(M) - Method in interface org.incendo.cloud.SenderMapper: Reverses a mapped command sender to it's base type.
ROOT_COMMAND_DELETION - Enum constant in enum org.incendo.cloud.CloudCapability.StandardCapabilities: The capability to delete root commands using CommandManager.deleteRootCommand(String).
rootCommands() - Method in class org.incendo.cloud.CommandManager: Returns all root command names.
rootComponent() - Method in class org.incendo.cloud.Command: Returns the first command component.
rootNode() - Method in class org.incendo.cloud.CommandTree: Returns the node that all CommandTree.rootNodes() share as a parent.
rootNodes() - Method in class org.incendo.cloud.CommandTree: Returns an immutable view containing of the root nodes of the command tree

S

scheduleOn(Executor, Supplier<CompletableFuture<T>>) - Static method in class org.incendo.cloud.util.CompletableFutures: Creates a future that schedules a future on the provided executor.
second() - Method in class org.incendo.cloud.type.tuple.Pair: Returns the second value.
second() - Method in class org.incendo.cloud.type.tuple.Quartet: Get the second value
second() - Method in class org.incendo.cloud.type.tuple.Quintet: Get the second value
second() - Method in class org.incendo.cloud.type.tuple.Sextet: Get the second value
second() - Method in class org.incendo.cloud.type.tuple.Triplet: Get the second value
sender() - Method in class org.incendo.cloud.context.CommandContext: Returns the sender that executed the command.
sender() - Method in interface org.incendo.cloud.help.HelpQuery: Returns the command sender.
senderMapper() - Method in interface org.incendo.cloud.SenderMapperHolder: Returns the mapper between the base command sender type B and the mapped command sender type M.
SenderMapper<B,M> - Interface in org.incendo.cloud: Mapper than can transform command senders from a base type to another type and back.
SenderMapperHolder<B,M> - Interface in org.incendo.cloud: A holder of a SenderMapper.
senderType() - Method in class org.incendo.cloud.Command.Builder: Returns the required sender type for this builder.
senderType() - Method in class org.incendo.cloud.Command: Returns the specific command sender type for the command if one has been defined.
senderType(TypeToken<? extends N>) - Method in class org.incendo.cloud.Command.Builder: Specifies a required sender type.
senderType(Class<? extends N>) - Method in class org.incendo.cloud.Command.Builder: Specifies a required sender type.
set(S, boolean) - Method in interface org.incendo.cloud.setting.Configurable: Updates the value of the given setting.
set(String, V) - Method in interface org.incendo.cloud.key.MutableCloudKeyContainer: Sets the value associated with the given key.
set(CloudKey<V>, V) - Method in interface org.incendo.cloud.key.MutableCloudKeyContainer: Sets the value associated with the given key.
set(CloudKeyHolder<V>, V) - Method in interface org.incendo.cloud.key.MutableCloudKeyContainer: Sets the value associated with the given keyHolder.
Setting - Interface in org.incendo.cloud.setting: Something that represents a setting that can be configured.
settings() - Method in class org.incendo.cloud.CommandManager: Returns a Configurable instance that can be used to modify the settings for this command manager instance.
Sextet<U,V,W,X,Y,Z> - Class in org.incendo.cloud.type.tuple: Immutable generic 6-tuple
Sextet(U, V, W, X, Y, Z) - Constructor for class org.incendo.cloud.type.tuple.Sextet
shortComponent() - Static method in class org.incendo.cloud.parser.standard.ShortParser: Returns a CommandComponent.Builder using ShortParser.shortParser() as the parser.
ShortParseException(String, ShortParser<?>, CommandContext<?>) - Constructor for exception class org.incendo.cloud.parser.standard.ShortParser.ShortParseException: Create a new ShortParser.ShortParseException.
shortParser() - Static method in class org.incendo.cloud.parser.standard.ShortParser: Creates a new short parser using ShortParser.DEFAULT_MINIMUM and ShortParser.DEFAULT_MAXIMUM as the limits.
shortParser(short) - Static method in class org.incendo.cloud.parser.standard.ShortParser: Creates a new short parser using ShortParser.DEFAULT_MAXIMUM as the maximum value.
shortParser(short, short) - Static method in class org.incendo.cloud.parser.standard.ShortParser: Creates a new short parser.
ShortParser<C> - Class in org.incendo.cloud.parser.standard
ShortParser(short, short) - Constructor for class org.incendo.cloud.parser.standard.ShortParser: Construct a new short parser
ShortParser.ShortParseException - Exception Class in org.incendo.cloud.parser.standard
shortRange(short, short) - Static method in interface org.incendo.cloud.type.range.Range: Creates a new range.
ShortRange - Interface in org.incendo.cloud.type.range
simple(FilteringSuggestionProcessor.Filter.Simple<C>) - Static method in interface org.incendo.cloud.suggestion.FilteringSuggestionProcessor.Filter: Create a new FilteringSuggestionProcessor.Filter.Simple.
SimpleCommandMeta - Class in org.incendo.cloud.meta: A simple immutable string-string map containing command meta
SimpleCommandMeta(Map<CloudKey<?>, Object>) - Constructor for class org.incendo.cloud.meta.SimpleCommandMeta
simpleCoordinator() - Static method in interface org.incendo.cloud.execution.ExecutionCoordinator: Create a new execution coordinator that does not make any attempt to schedule tasks to a particular executor.
SimpleMutableCloudKeyContainer - Class in org.incendo.cloud.key
SimpleMutableCloudKeyContainer(Map<CloudKey<?>, Object>) - Constructor for class org.incendo.cloud.key.SimpleMutableCloudKeyContainer: Creates a new SimpleMutableCloudKeyContainer.
simpleName(Type) - Static method in class org.incendo.cloud.util.TypeUtils: Get the simple name for a possibly generic type.
single(ParserParameter<T>, T) - Static method in class org.incendo.cloud.parser.ParserParameters: Create a ParserParameters instance containing a single key-value par
SINGLE - Enum constant in enum org.incendo.cloud.parser.flag.CommandFlag.FlagMode: Only a single value can be provided for the flag, and should be extracted using FlagContext.get(CommandFlag).
SINGLE - Enum constant in enum org.incendo.cloud.parser.standard.StringParser.StringMode
sixth() - Method in class org.incendo.cloud.type.tuple.Sextet: Get the sixth value
size() - Method in class org.incendo.cloud.type.tuple.DynamicTuple
size() - Method in class org.incendo.cloud.type.tuple.Pair
size() - Method in class org.incendo.cloud.type.tuple.Quartet
size() - Method in class org.incendo.cloud.type.tuple.Quintet
size() - Method in class org.incendo.cloud.type.tuple.Sextet
size() - Method in class org.incendo.cloud.type.tuple.Triplet
size() - Method in interface org.incendo.cloud.type.tuple.Tuple: Returns the tuple size.
skipWhitespace() - Method in interface org.incendo.cloud.context.CommandInput: Skips any whitespace characters at the head of the input.
skipWhitespace(boolean) - Method in interface org.incendo.cloud.context.CommandInput: Skips any whitespace characters at the head of the input.
skipWhitespace(int) - Method in interface org.incendo.cloud.context.CommandInput: Skips maxSpaces of whitespace characters at the head of the input.
skipWhitespace(int, boolean) - Method in interface org.incendo.cloud.context.CommandInput: Skips maxSpaces of whitespace characters at the head of the input.
sortChildren() - Method in class org.incendo.cloud.internal.CommandNode: Sorts the child nodes using their components.
StagedImmutableBuilder - Annotation Type in org.incendo.cloud.internal: Annotation that generates immutables classes with staged builders.
standard(CommandManager<C>) - Static method in interface org.incendo.cloud.help.HelpHandlerFactory: Returns a factory that produces instances of StandardHelpHandler.
standardCaptionKeys() - Static method in class org.incendo.cloud.caption.StandardCaptionKeys: Get an immutable collection containing all standard caption keys
StandardCaptionKeys - Class in org.incendo.cloud.caption: Caption instances for messages in cloud-core
StandardCaptionsProvider<C> - Class in org.incendo.cloud.caption: Provides default captions for all StandardCaptionKeys.
StandardCaptionsProvider() - Constructor for class org.incendo.cloud.caption.StandardCaptionsProvider
StandardCommandContextFactory<C> - Class in org.incendo.cloud.context
StandardCommandContextFactory(CommandManager<C>) - Constructor for class org.incendo.cloud.context.StandardCommandContextFactory: Creates a new context factory.
StandardCommandSyntaxFormatter<C> - Class in org.incendo.cloud.syntax: 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 does not render arguments the sender does not have access to (either due to permission or sender type requirements)
StandardCommandSyntaxFormatter(CommandManager<C>) - Constructor for class org.incendo.cloud.syntax.StandardCommandSyntaxFormatter: Creates a new StandardCommandSyntaxFormatter.
StandardCommandSyntaxFormatter.FormattingInstance - Class in org.incendo.cloud.syntax: Instance that is used when building command syntax
StandardHelpHandler<C> - Class in org.incendo.cloud.help
StandardHelpHandler(CommandManager<C>, CommandPredicate<C>) - Constructor for class org.incendo.cloud.help.StandardHelpHandler: Creates a new help handler.
StandardParameters - Class in org.incendo.cloud.parser: Common parser parameters used when resolving types in the ParserRegistry
StandardParserRegistry<C> - Class in org.incendo.cloud.parser: Standard implementation of ParserRegistry
StandardParserRegistry() - Constructor for class org.incendo.cloud.parser.StandardParserRegistry: Construct a new StandardParserRegistry instance.
startsWith(boolean) - Static method in interface org.incendo.cloud.suggestion.FilteringSuggestionProcessor.Filter: Create a filter using String.startsWith(String) that can optionally ignore case.
state() - Method in class org.incendo.cloud.CommandManager
state() - Method in interface org.incendo.cloud.state.Stateful: Returns the current state.
State - Interface in org.incendo.cloud.state: Something that represents a state in a state machine.
Stateful<S> - Interface in org.incendo.cloud.state: A simple state machine.
store(String, V) - Method in class org.incendo.cloud.key.SimpleMutableCloudKeyContainer
store(String, T) - Method in class org.incendo.cloud.context.CommandContext: Stores the key-value pair.
store(String, V) - Method in interface org.incendo.cloud.key.MutableCloudKeyContainer: Stores the key-value pair.
store(CloudKey<T>, T) - Method in class org.incendo.cloud.context.CommandContext: Stores the key-value pair.
store(CloudKey<V>, V) - Method in class org.incendo.cloud.key.SimpleMutableCloudKeyContainer
store(CloudKey<V>, V) - Method in interface org.incendo.cloud.key.MutableCloudKeyContainer: Stores the key-value pair.
store(CloudKeyHolder<V>, V) - Method in interface org.incendo.cloud.key.MutableCloudKeyContainer: Stores the key-value pair for the key held by the keyHolder.
store(ParserParameter<T>, T) - Method in class org.incendo.cloud.parser.ParserParameters: Store a parameter-object pair
stringArrayParser() - Static method in class org.incendo.cloud.parser.standard.StringArrayParser: Creates a new character parser.
StringArrayParser<C> - Class in org.incendo.cloud.parser.standard: Parser that parses input into a string array
StringArrayParser() - Constructor for class org.incendo.cloud.parser.standard.StringArrayParser: Construct a new string array parser.
StringArrayParser(boolean) - Constructor for class org.incendo.cloud.parser.standard.StringArrayParser: Construct a new string array parser.
stringComponent() - Static method in class org.incendo.cloud.parser.standard.StringParser: Returns a CommandComponent.Builder using StringParser.stringComponent(StringMode) with StringParser.StringMode.SINGLE as the parser.
stringComponent(StringParser.StringMode) - Static method in class org.incendo.cloud.parser.standard.StringParser: Returns a CommandComponent.Builder using StringParser.stringComponent(StringMode) as the parser.
stringMode() - Method in class org.incendo.cloud.parser.standard.StringParser: Returns the string mode of the parser.
stringMode() - Method in exception class org.incendo.cloud.parser.standard.StringParser.StringParseException: Returns the string mode.
StringParseException(String, StringParser.StringMode, CommandContext<?>) - Constructor for exception class org.incendo.cloud.parser.standard.StringParser.StringParseException: Construct a new string parse exception
stringParser() - Static method in class org.incendo.cloud.parser.standard.StringParser: Creates a new string parser that parses a single string.
stringParser(StringParser.StringMode) - Static method in class org.incendo.cloud.parser.standard.StringParser: Creates a new string parser using the given mode.
StringParser<C> - Class in org.incendo.cloud.parser.standard
StringParser(StringParser.StringMode) - Constructor for class org.incendo.cloud.parser.standard.StringParser: Construct a new string parser
StringParser.StringMode - Enum in org.incendo.cloud.parser.standard
StringParser.StringParseException - Exception Class in org.incendo.cloud.parser.standard
stringSuggestions(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.standard.BooleanParser
stringSuggestions(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.standard.ByteParser
stringSuggestions(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.standard.DurationParser
stringSuggestions(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.standard.EnumParser
stringSuggestions(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.standard.IntegerParser
stringSuggestions(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.standard.LiteralParser
stringSuggestions(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.standard.LongParser
stringSuggestions(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.standard.ShortParser
stringSuggestions(CommandContext<C>, CommandInput) - Method in interface org.incendo.cloud.suggestion.BlockingSuggestionProvider.Strings: Returns the suggestions for the given input.
StringUtils - Class in org.incendo.cloud.util: String utilities
success() - Method in class org.incendo.cloud.context.ParsingContext: Return whether the argument was parsed successfully.
success(boolean) - Method in class org.incendo.cloud.context.ParsingContext: Set whether the argument was parsed successfully.
success(T) - Static method in class org.incendo.cloud.parser.ArgumentParseResult: Indicate that the parsing succeeded
successFuture(T) - Static method in class org.incendo.cloud.parser.ArgumentParseResult: Create a future completed with a successful parse result.
suggest(C, String) - Method in class org.incendo.cloud.suggestion.DelegatingSuggestionFactory
suggest(C, String) - Method in interface org.incendo.cloud.suggestion.SuggestionFactory: Returns command suggestions for the "next" argument that would yield a correctly parsing command input
suggest(CommandContext<C>, String) - Method in class org.incendo.cloud.suggestion.DelegatingSuggestionFactory
suggest(CommandContext<C>, String) - Method in interface org.incendo.cloud.suggestion.SuggestionFactory: Returns command suggestions for the "next" argument that would yield a correctly parsing command input
suggestImmediately(C, String) - Method in interface org.incendo.cloud.suggestion.SuggestionFactory: Returns command suggestions for the "next" argument that would yield a correctly parsing command input
suggesting(Iterable<? extends Suggestion>) - Static method in interface org.incendo.cloud.suggestion.SuggestionProvider: Create a SuggestionProvider that provides constant suggestions.
suggesting(Suggestion...) - Static method in interface org.incendo.cloud.suggestion.SuggestionProvider: Create a SuggestionProvider that provides constant suggestions.
suggestingStrings(Iterable<String>) - Static method in interface org.incendo.cloud.suggestion.SuggestionProvider: Create a SuggestionProvider that provides constant string suggestions.
suggestingStrings(String...) - Static method in interface org.incendo.cloud.suggestion.SuggestionProvider: Create a SuggestionProvider that provides constant string suggestions.
suggestion() - Method in interface org.incendo.cloud.suggestion.Suggestion: Returns a string representation of this suggestion, which can be parsed by the parser that suggested it
suggestion(String) - Static method in interface org.incendo.cloud.suggestion.Suggestion: Returns a simple suggestion that returns the given suggestion
Suggestion - Interface in org.incendo.cloud.suggestion
SuggestionContext<C,S> - Class in org.incendo.cloud.internal
SuggestionContext(SuggestionProcessor<C>, CommandContext<C>, CommandInput, SuggestionMapper<S>) - Constructor for class org.incendo.cloud.internal.SuggestionContext: Creates a new suggestion context
suggestionFactory() - Method in class org.incendo.cloud.CommandManager: Returns the suggestion factory.
SuggestionFactory<C,S> - Interface in org.incendo.cloud.suggestion: Factory that produces command suggestions from user input.
suggestionMapper() - Method in class org.incendo.cloud.CommandManager: Returns the suggestion mapper for CommandManager.suggestionFactory().
suggestionMapper(SuggestionMapper<? extends Suggestion>) - Method in class org.incendo.cloud.CommandManager: Sets the suggestion mapper for CommandManager.suggestionFactory().
SuggestionMapper<S> - Interface in org.incendo.cloud.suggestion: Maps from Suggestion to SuggestionMapper.
suggestionProcessor() - Method in class org.incendo.cloud.CommandManager: Returns the command suggestion processor used in this command manager.
suggestionProcessor(SuggestionProcessor<C>) - Method in class org.incendo.cloud.CommandManager: Sets the command suggestion processor.
SuggestionProcessor<C> - Interface in org.incendo.cloud.suggestion: Processor that operates on the stream of suggestions before it is collected for the suggestion result passed to platform implementations or other callers.
suggestionProvider() - Method in class org.incendo.cloud.component.CommandComponent.Builder: Returns the current suggestion provider, if it has been set.
suggestionProvider() - Method in class org.incendo.cloud.component.CommandComponent: Returns the suggestion provider for this argument.
suggestionProvider() - Method in interface org.incendo.cloud.parser.aggregate.AggregateParser
suggestionProvider() - Method in interface org.incendo.cloud.parser.ArgumentParser: Returns the suggestion provider.
suggestionProvider() - Method in class org.incendo.cloud.parser.MappedArgumentParserImpl
suggestionProvider() - Method in interface org.incendo.cloud.suggestion.SuggestionProviderHolder: Returns the suggestion provider.
suggestionProvider(SuggestionProvider<? super C>) - Method in class org.incendo.cloud.component.CommandComponent.Builder: Sets the suggestionProvider.
SuggestionProvider<C> - Interface in org.incendo.cloud.suggestion: Provider of suggestions
SuggestionProviderHolder<C> - Interface in org.incendo.cloud.suggestion
suggestions(CommandContext<C>, CommandInput) - Method in interface org.incendo.cloud.suggestion.BlockingSuggestionProvider.Strings
suggestions(CommandContext<C>, CommandInput) - Method in interface org.incendo.cloud.suggestion.BlockingSuggestionProvider: Returns the suggestions for the given input.
Suggestions<C,S> - Interface in org.incendo.cloud.suggestion
suggestionsExecutor(Executor) - Method in interface org.incendo.cloud.execution.ExecutionCoordinator.Builder: Sets the executor to run suggestions logic on.
suggestionsFuture(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.flag.CommandFlagParser
suggestionsFuture(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.parser.standard.EitherParser
suggestionsFuture(CommandContext<C>, CommandInput) - Method in interface org.incendo.cloud.suggestion.BlockingSuggestionProvider
suggestionsFuture(CommandContext<C>, CommandInput) - Method in interface org.incendo.cloud.suggestion.SuggestionProvider: Returns a future that completes with the suggestions for the given input.
suppliedCommand() - Method in exception class org.incendo.cloud.exception.NoSuchCommandException: Returns the supplied command.
synchronizeExecution() - Method in interface org.incendo.cloud.execution.ExecutionCoordinator.Builder: Sets the execution coordinator to disallow concurrent command handler execution.
synchronizeExecution(boolean) - Method in interface org.incendo.cloud.execution.ExecutionCoordinator.Builder: Sets whether the execution coordinator should allow concurrent command handler execution.
syntax() - Method in interface org.incendo.cloud.help.result.CommandEntry: Returns the command syntax.

T

test(Command<C>) - Method in interface org.incendo.cloud.help.CommandPredicate: Returns true if the command should be kept and false if the command should be filtered out.
test(CommandPreprocessingContext<C>, String, String) - Method in interface org.incendo.cloud.suggestion.FilteringSuggestionProcessor.Filter.Simple: Tests a suggestion against the context and input.
testPermission(C) - Method in interface org.incendo.cloud.permission.PredicatePermission: Checks whether the given sender has this permission
testPermission(C, Permission) - Method in class org.incendo.cloud.CommandManager: Checks if the command sender has the required permission and returns the result.
textDescription() - Method in interface org.incendo.cloud.description.Description: Returns the plain-text version of this description.
then(SuggestionMapper<S1>) - Method in interface org.incendo.cloud.suggestion.SuggestionMapper: Returns a suggestion mapper that invokes this mapper first and then the provided one.
then(SuggestionProcessor<C>) - Method in interface org.incendo.cloud.suggestion.SuggestionProcessor: Create a chained processor that invokes this processor and then the nextProcessor with the result.
third() - Method in class org.incendo.cloud.type.tuple.Quartet: Get the third value
third() - Method in class org.incendo.cloud.type.tuple.Quintet: Get the third value
third() - Method in class org.incendo.cloud.type.tuple.Sextet: Get the third value
third() - Method in class org.incendo.cloud.type.tuple.Triplet: Get the third value
toArray() - Method in class org.incendo.cloud.type.tuple.DynamicTuple
toArray() - Method in class org.incendo.cloud.type.tuple.Pair
toArray() - Method in class org.incendo.cloud.type.tuple.Quartet
toArray() - Method in class org.incendo.cloud.type.tuple.Quintet
toArray() - Method in class org.incendo.cloud.type.tuple.Sextet
toArray() - Method in class org.incendo.cloud.type.tuple.Triplet
toArray() - Method in interface org.incendo.cloud.type.tuple.Tuple: Turns the tuple into a type erased array.
tokenize() - Method in class org.incendo.cloud.internal.CommandInputTokenizer: Turn the input into tokens
toString() - Method in class org.incendo.cloud.caption.ImmutableConstantCaptionProvider: Prints the immutable value ConstantCaptionProvider with attribute values.
toString() - Method in enum org.incendo.cloud.CloudCapability.StandardCapabilities
toString() - Method in interface org.incendo.cloud.CloudCapability: Returns the friendly name of this capability.
toString() - Method in class org.incendo.cloud.Command
toString() - Method in class org.incendo.cloud.component.CommandComponent
toString() - Method in class org.incendo.cloud.injection.ParameterInjector.ConstantInjector
toString() - Method in class org.incendo.cloud.internal.CommandNode
toString() - Method in class org.incendo.cloud.meta.CommandMeta
toString() - Method in class org.incendo.cloud.parser.flag.CommandFlag
toString() - Method in class org.incendo.cloud.parser.MappedArgumentParserImpl
toString() - Method in class org.incendo.cloud.permission.AndPermission
toString() - Method in class org.incendo.cloud.permission.OrPermission
toString() - Method in class org.incendo.cloud.syntax.StandardCommandSyntaxFormatter.FormattingInstance
toString() - Method in class org.incendo.cloud.type.tuple.Pair
toString() - Method in class org.incendo.cloud.type.tuple.Quartet
toString() - Method in class org.incendo.cloud.type.tuple.Quintet
toString() - Method in class org.incendo.cloud.type.tuple.Sextet
toString() - Method in class org.incendo.cloud.type.tuple.Triplet
transitionIfPossible(S, S) - Method in interface org.incendo.cloud.state.Stateful: Transitions from the in state to the out state, unless the current Stateful.state() is identical to the out state.
transitionIfPossible(RegistrationState, RegistrationState) - Method in class org.incendo.cloud.CommandManager
transitionOrThrow(S, S) - Method in interface org.incendo.cloud.state.Stateful: Transitions from the in state to the out state, unless the current Stateful.state() is identical to the out state.
trimBeforeLastSpace(String, String) - Static method in class org.incendo.cloud.util.StringUtils: Trims before the last space from suggestion, if it matches input tokens.
trimBeforeLastSpace(String, CommandInput) - Static method in class org.incendo.cloud.util.StringUtils: Trims before the last space from suggestion, if it matches input tokens.
Triplet<U,V,W> - Class in org.incendo.cloud.type.tuple: Immutable generic 3-tuple
Triplet(U, V, W) - Constructor for class org.incendo.cloud.type.tuple.Triplet
tripletBuilder(String, ParserDescriptor<C, U>, String, ParserDescriptor<C, V>, String, ParserDescriptor<C, Z>) - Static method in interface org.incendo.cloud.parser.aggregate.AggregateParser: Returns a new aggregate triplet command parser builder.
Tuple - Interface in org.incendo.cloud.type.tuple: Tuple type
type() - Method in class org.incendo.cloud.component.CommandComponent: Returns the type of the component.
type() - Method in class org.incendo.cloud.key.CloudKey: Returns the type of the value that this key holds.
TypedCommandComponent<C,T> - Class in org.incendo.cloud.component
TypeUtils - Class in org.incendo.cloud.util

U

UNKNOWN_FLAG - Enum constant in enum org.incendo.cloud.parser.flag.CommandFlagParser.FailureReason
unregisterRootCommand(CommandComponent<C>) - Method in class org.incendo.cloud.internal.CommandRegistrationHandler.NullCommandRegistrationHandler
unregisterRootCommand(CommandComponent<C>) - Method in interface org.incendo.cloud.internal.CommandRegistrationHandler: Requests that the given rootCommand should be unregistered.
unwrapCompletionException(Throwable) - Static method in class org.incendo.cloud.exception.handling.ExceptionController: Unwraps a CompletionException recursively until a cause is encountered that is not a completion exception.
unwrappingHandler() - Static method in interface org.incendo.cloud.exception.handling.ExceptionHandler: Returns an exception handler that throws the cause of the ExceptionContext.exception() if it's not null.
unwrappingHandler(Class<? extends Throwable>) - Static method in interface org.incendo.cloud.exception.handling.ExceptionHandler: Returns an exception handler that throws the cause of the ExceptionContext.exception() if it's and instance of causeClass.
unwrappingHandler(Predicate<Throwable>) - Static method in interface org.incendo.cloud.exception.handling.ExceptionHandler: Returns an exception handler that throws the cause of the ExceptionContext.exception() if it's not null and the predicate evaluates to true.
uuidComponent() - Static method in class org.incendo.cloud.parser.standard.UUIDParser: Returns a CommandComponent.Builder using UUIDParser.uuidParser() as the parser.
UUIDParseException(String, CommandContext<?>) - Constructor for exception class org.incendo.cloud.parser.standard.UUIDParser.UUIDParseException: Construct a new UUID parse exception
uuidParser() - Static method in class org.incendo.cloud.parser.standard.UUIDParser: Creates a new UUID parser.
UUIDParser<C> - Class in org.incendo.cloud.parser.standard
UUIDParser() - Constructor for class org.incendo.cloud.parser.standard.UUIDParser
UUIDParser.UUIDParseException - Exception Class in org.incendo.cloud.parser.standard

V

value() - Element in annotation type org.incendo.cloud.annotation.specifier.Completions: Command completions
value() - Method in interface org.incendo.cloud.caption.CaptionVariable: Returns the variable value
value() - Method in class org.incendo.cloud.component.DefaultValue.ParsedDefaultValue: Returns the string that should be parsed.
valueOf(String) - Static method in enum org.incendo.cloud.CloudCapability.StandardCapabilities: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.incendo.cloud.component.CommandComponent.ComponentType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.incendo.cloud.parser.flag.CommandFlag.FlagMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.incendo.cloud.parser.flag.CommandFlagParser.FailureReason: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.incendo.cloud.parser.standard.StringParser.StringMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.incendo.cloud.setting.ManagerSetting: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.incendo.cloud.state.RegistrationState: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.incendo.cloud.CloudCapability.StandardCapabilities: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.incendo.cloud.component.CommandComponent.ComponentType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.incendo.cloud.parser.flag.CommandFlag.FlagMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.incendo.cloud.parser.flag.CommandFlagParser.FailureReason: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.incendo.cloud.parser.standard.StringParser.StringMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.incendo.cloud.setting.ManagerSetting: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.incendo.cloud.state.RegistrationState: Returns an array containing the constants of this enum type, in the order they are declared.
valueType() - Method in class org.incendo.cloud.component.CommandComponent: Returns the type of the values produced by the CommandComponent.parser().
valueType() - Method in class org.incendo.cloud.component.TypedCommandComponent
valueType() - Method in interface org.incendo.cloud.parser.ParserDescriptor: Returns the type of values produced by the parser.
valueType(TypeToken<T>) - Method in class org.incendo.cloud.component.CommandComponent.Builder: Sets the valueType.
valueType(Class<T>) - Method in class org.incendo.cloud.component.CommandComponent.Builder: Sets the valueType.
VerboseCommandResult<C> - Interface in org.incendo.cloud.help.result: Verbose information about a single command.
verboseDescription() - Method in interface org.incendo.cloud.description.CommandDescription: Returns the verbose version of the command description.

W

with(CloudKey<V>, V) - Method in class org.incendo.cloud.meta.CommandMetaBuilder: Stores the given key-value pair.
with(CommandMeta) - Method in class org.incendo.cloud.meta.CommandMetaBuilder: Copies all values from another CommandMeta instance
withAliases(String...) - Method in class org.incendo.cloud.parser.flag.CommandFlag.Builder: Create a new builder instance using the given flag aliases.
withAliases(Collection<String>) - Method in class org.incendo.cloud.parser.flag.CommandFlag.Builder: Create a new builder instance using the given flag aliases.
withCaptions(Map<? extends Caption, ? extends String>) - Method in class org.incendo.cloud.caption.ImmutableConstantCaptionProvider: Copy the current immutable object by replacing the captions map with the specified map.
withComponent(String, ParserDescriptor<C, T>) - Method in class org.incendo.cloud.parser.aggregate.AggregateParserBuilder.MappedAggregateParserBuilder
withComponent(String, ParserDescriptor<C, T>) - Method in class org.incendo.cloud.parser.aggregate.AggregateParserBuilder: Returns a new builder with a new component using the given parserDescriptor into the component list.
withComponent(String, ParserDescriptor<C, T>, SuggestionProvider<C>) - Method in class org.incendo.cloud.parser.aggregate.AggregateParserBuilder.MappedAggregateParserBuilder
withComponent(String, ParserDescriptor<C, T>, SuggestionProvider<C>) - Method in class org.incendo.cloud.parser.aggregate.AggregateParserBuilder: Returns a new builder with a new component using the given parserDescriptor into the component list.
withComponent(CommandComponent<C>) - Method in class org.incendo.cloud.parser.aggregate.AggregateParserBuilder.MappedAggregateParserBuilder
withComponent(CommandComponent<C>) - Method in class org.incendo.cloud.parser.aggregate.AggregateParserBuilder: Returns a new builder with the given component inserted into the component list.
withComponent(TypedCommandComponent<C, N>) - Method in class org.incendo.cloud.parser.flag.CommandFlag.Builder: Create a new builder instance using the given command component
withComponent(CommandComponent.Builder<C, N>) - Method in class org.incendo.cloud.parser.flag.CommandFlag.Builder: Create a new builder instance using the given command component
withComponent(CloudKey<T>, ParserDescriptor<C, T>) - Method in class org.incendo.cloud.parser.aggregate.AggregateParserBuilder.MappedAggregateParserBuilder
withComponent(CloudKey<T>, ParserDescriptor<C, T>) - Method in class org.incendo.cloud.parser.aggregate.AggregateParserBuilder: Returns a new builder with a new component using the given parserDescriptor into the component list.
withComponent(CloudKey<T>, ParserDescriptor<C, T>, SuggestionProvider<C>) - Method in class org.incendo.cloud.parser.aggregate.AggregateParserBuilder.MappedAggregateParserBuilder
withComponent(CloudKey<T>, ParserDescriptor<C, T>, SuggestionProvider<C>) - Method in class org.incendo.cloud.parser.aggregate.AggregateParserBuilder: Returns a new builder with a new component using the given parserDescriptor into the component list.
withComponent(ParserDescriptor<? super C, N>) - Method in class org.incendo.cloud.parser.flag.CommandFlag.Builder: Create a new builder instance using the given command component
withDescription(Description) - Method in class org.incendo.cloud.parser.flag.CommandFlag.Builder: Create a new builder instance using the given flag description
withDirectMapper(TypeToken<O>, AggregateResultMapper.DirectSuccessMapper<C, O>) - Method in class org.incendo.cloud.parser.aggregate.AggregateParserBuilder: Returns a new builder with the given mapper.
withDirectMapper(TypeToken<O1>, AggregateParserPairBuilder.Mapper.DirectSuccessMapper<C, U, V, O1>) - Method in class org.incendo.cloud.parser.aggregate.AggregateParserPairBuilder: Creates a new AggregateParserPairBuilder with the given mapper.
withDirectMapper(TypeToken<O1>, AggregateParserTripletBuilder.Mapper.DirectSuccessMapper<C, U, V, Z, O1>) - Method in class org.incendo.cloud.parser.aggregate.AggregateParserTripletBuilder: Creates a new AggregateParserTripletBuilder with the given mapper.
withDirectMapper(Class<O>, AggregateResultMapper.DirectSuccessMapper<C, O>) - Method in class org.incendo.cloud.parser.aggregate.AggregateParserBuilder: Returns a new builder with the given mapper.
withMapper(TypeToken<O>, AggregateResultMapper<C, O>) - Method in class org.incendo.cloud.parser.aggregate.AggregateParserBuilder: Returns a new builder with the given mapper.
withMapper(TypeToken<O1>, AggregateParserPairBuilder.Mapper<C, U, V, O1>) - Method in class org.incendo.cloud.parser.aggregate.AggregateParserPairBuilder: Creates a new AggregateParserPairBuilder with the given mapper.
withMapper(TypeToken<O1>, AggregateParserTripletBuilder.Mapper<C, U, V, Z, O1>) - Method in class org.incendo.cloud.parser.aggregate.AggregateParserTripletBuilder: Creates a new AggregateParserTripletBuilder with the given mapper.
withMapper(Class<O>, AggregateResultMapper<C, O>) - Method in class org.incendo.cloud.parser.aggregate.AggregateParserBuilder: Returns a new builder with the given mapper.
withPermission(String) - Method in class org.incendo.cloud.parser.flag.CommandFlag.Builder: Create a new builder instance using the given flag permission
withPermission(Permission) - Method in class org.incendo.cloud.parser.flag.CommandFlag.Builder: Create a new builder instance using the given flag permission
withSuggestion(String) - Method in interface org.incendo.cloud.suggestion.Suggestion: Returns a copy of this suggestion instance using the given suggestion
wrap(BiFunction<CommandContext<C>, CommandInput, ArgumentParseResult<Boolean>>) - Static method in interface org.incendo.cloud.component.preprocessor.ComponentPreprocessor: Wraps the given function in a preprocessor.

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