Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- add(Requirement) - Method in class net.apartium.cocoabeans.commands.requirements.RequirementSet
- addAll(Collection<? extends Requirement>) - Method in class net.apartium.cocoabeans.commands.requirements.RequirementSet
- addCommand(CommandNode) - Method in class net.apartium.cocoabeans.commands.CommandManager
- addCommand(CommandNode, Command) - Method in class net.apartium.cocoabeans.commands.CommandManager
- addMetadataHandler(Function<Map<String, Object>, Set<Requirement>>) - Method in class net.apartium.cocoabeans.commands.CommandManager
- addMetadataMapper(BiConsumer<AnnotatedElement, Map<String, Object>>) - Method in class net.apartium.cocoabeans.commands.virtual.VirtualCommandFactory
-
Enrich all virtual commands created through this factory with metadata by adding it in the mapper parameter
Example of usage: - addVirtualCommand(VirtualCommandDefinition, Function<CommandContext, Boolean>) - Method in class net.apartium.cocoabeans.commands.CommandManager
-
Add Virtual command with consumer that get called every time someone is running that command
- aliases() - Element in annotation interface net.apartium.cocoabeans.commands.Command
-
Aliases for the command
- aliases() - Method in record class net.apartium.cocoabeans.commands.virtual.VirtualCommandDefinition
-
Returns the value of the
aliasesrecord component. - ALL - Enum constant in enum class net.apartium.cocoabeans.commands.parsers.Scope
-
Scoped to either scopes
- AmbiguousMappedKeyResponse - Class in net.apartium.cocoabeans.commands.parsers.exception
-
Represents a response that is reported via a parser when a mapped key is ambiguous
- AmbiguousMappedKeyResponse(CommandProcessingContext, ArgumentParser<?>, String, List<String>) - Constructor for class net.apartium.cocoabeans.commands.parsers.exception.AmbiguousMappedKeyResponse
-
Construct a new instance of ambiguous mapped key response
- AmbiguousMappedKeyResponse.AmbiguousMappedKeyException - Exception Class in net.apartium.cocoabeans.commands.parsers.exception
- apply(int, int, String) - Method in interface net.apartium.cocoabeans.commands.lexer.CommandTokenSupplier
-
Create a new command token
- args - Variable in class net.apartium.cocoabeans.commands.exception.BadCommandResponse
- args() - Method in record class net.apartium.cocoabeans.commands.ArgumentContext
-
Returns the value of the
argsrecord component. - args() - Method in record class net.apartium.cocoabeans.commands.CommandContext
-
Returns the value of the
argsrecord component. - args() - Method in interface net.apartium.cocoabeans.commands.CommandProcessingContext
-
Returns an unmodifiable list representing all the args left to process
- args() - Method in record class net.apartium.cocoabeans.commands.requirements.RequirementEvaluationContext
-
Returns the value of the
argsrecord component. - args() - Method in class net.apartium.cocoabeans.commands.SimpleCommandProcessingContext
-
Returns the arguments
- ARGUMENT_PARSER - Enum constant in enum class net.apartium.cocoabeans.commands.lexer.CommandTokenType
- ArgumentContext - Record Class in net.apartium.cocoabeans.commands
-
Argument context is general context for all arguments Used for all commands and other system like Flag system and compound parser
- ArgumentContext(String, String[], Sender, Map<Class<?>, List<Object>>) - Constructor for record class net.apartium.cocoabeans.commands.ArgumentContext
-
Creates an instance of a
ArgumentContextrecord class. - ArgumentIndex<T> - Interface in net.apartium.cocoabeans.commands
-
Retrieves the argument from the context
- argumentIndexList() - Method in record class net.apartium.cocoabeans.commands.exception.HandleExceptionVariant
-
Returns the value of the
argumentIndexListrecord component. - argumentIndexList() - Method in record class net.apartium.cocoabeans.commands.RegisteredVariant
-
Returns the value of the
argumentIndexListrecord component. - ArgumentMapper - Interface in net.apartium.cocoabeans.commands
-
Maps the command arguments into the parameters required by the sub command
- ArgumentParser<T> - Class in net.apartium.cocoabeans.commands.parsers
-
Base class for all parsers
- ArgumentParser(String, Class<T>, int) - Constructor for class net.apartium.cocoabeans.commands.parsers.ArgumentParser
-
Constructs a new parser
- ArgumentParser.ParseResult<T> - Record Class in net.apartium.cocoabeans.commands.parsers
-
Parse Result is the content of the parsing
- ArgumentParser.TabCompletionResult - Record Class in net.apartium.cocoabeans.commands.parsers
-
Tsb completion result is the content of the tab completion
- ArgumentParserToken - Class in net.apartium.cocoabeans.commands.lexer
-
A token that represents an argument parser.
- ArgumentParserToken(int, int, String) - Constructor for class net.apartium.cocoabeans.commands.lexer.ArgumentParserToken
-
Create a new argument parser token
- ArgumentRequirement - Interface in net.apartium.cocoabeans.commands.requirements
- ArgumentRequirementFactory - Interface in net.apartium.cocoabeans.commands.requirements
- argumentRequirements() - Method in record class net.apartium.cocoabeans.commands.RegisteredVariant.Parameter
-
Returns the value of the
argumentRequirementsrecord component. - ArgumentRequirementType - Annotation Interface in net.apartium.cocoabeans.commands.requirements
B
- BadCommandResponse - Class in net.apartium.cocoabeans.commands.exception
- BadCommandResponse() - Constructor for class net.apartium.cocoabeans.commands.exception.BadCommandResponse
- BadCommandResponse(String, String[], int) - Constructor for class net.apartium.cocoabeans.commands.exception.BadCommandResponse
- BadCommandResponse(String, String[], int, String) - Constructor for class net.apartium.cocoabeans.commands.exception.BadCommandResponse
- BooleanParser - Class in net.apartium.cocoabeans.commands.parsers
- BooleanParser(int) - Constructor for class net.apartium.cocoabeans.commands.parsers.BooleanParser
-
Creates a new boolean parser
- BooleanParser(int, String) - Constructor for class net.apartium.cocoabeans.commands.parsers.BooleanParser
-
Creates a new boolean parser
- BooleanParser(int, String, Set<String>, Set<String>) - Constructor for class net.apartium.cocoabeans.commands.parsers.BooleanParser
C
- CLASS - Enum constant in enum class net.apartium.cocoabeans.commands.parsers.Scope
-
Scoped to an entire command class
- clazz() - Element in annotation interface net.apartium.cocoabeans.commands.parsers.SourceParser
-
The return type of the parser
- clazz() - Method in record class net.apartium.cocoabeans.commands.requirements.RequirementResult.Value
-
Returns the value of the
clazzrecord component. - clear() - Method in class net.apartium.cocoabeans.commands.requirements.RequirementSet
- clearReports() - Method in class net.apartium.cocoabeans.commands.SimpleCommandProcessingContext
-
Clear the current report
- Command - Annotation Interface in net.apartium.cocoabeans.commands
-
Represents a root command
- CommandContext - Record Class in net.apartium.cocoabeans.commands
-
Represents the context of a command after it has been processed
- CommandContext(Sender, CommandInfo, CommandOption, BadCommandResponse, String[], String, Map<Class<?>, List<Object>>) - Constructor for record class net.apartium.cocoabeans.commands.CommandContext
-
Creates an instance of a
CommandContextrecord class. - CommandException - Exception Class in net.apartium.cocoabeans.commands.exception
- CommandException(BadCommandResponse) - Constructor for exception class net.apartium.cocoabeans.commands.exception.CommandException
- commandInfo() - Method in record class net.apartium.cocoabeans.commands.CommandContext
-
Returns the value of the
commandInforecord component. - CommandInfo - Class in net.apartium.cocoabeans.commands
- CommandInfo() - Constructor for class net.apartium.cocoabeans.commands.CommandInfo
- CommandLexer - Interface in net.apartium.cocoabeans.commands.lexer
-
The Command lexer tokenize commands, and then we could use it to parse the command
- CommandManager - Class in net.apartium.cocoabeans.commands
- CommandManager(ArgumentMapper) - Constructor for class net.apartium.cocoabeans.commands.CommandManager
- CommandManager(ArgumentMapper, CommandLexer) - Constructor for class net.apartium.cocoabeans.commands.CommandManager
- commandMap - Variable in class net.apartium.cocoabeans.commands.CommandManager
- commandName - Variable in class net.apartium.cocoabeans.commands.exception.BadCommandResponse
- commandName() - Method in record class net.apartium.cocoabeans.commands.ArgumentContext
-
Returns the value of the
commandNamerecord component. - commandName() - Method in record class net.apartium.cocoabeans.commands.CommandContext
-
Returns the value of the
commandNamerecord component. - commandName() - Method in record class net.apartium.cocoabeans.commands.requirements.RequirementEvaluationContext
-
Returns the value of the
commandNamerecord component. - CommandNode - Interface in net.apartium.cocoabeans.commands
-
To be implemented by command classes to provide general functionality
- CommandParserFactory - Annotation Interface in net.apartium.cocoabeans.commands.parsers
-
Annotations should be annotated with this annotation to specify their underlying factory impl
- CommandProcessingContext - Interface in net.apartium.cocoabeans.commands
-
Represents the context of processing the command's arguments
- CommandRequirementType - Annotation Interface in net.apartium.cocoabeans.commands.requirements
-
Annotations should be annotated with this annotation to specify their underlying factory impl
- CommandToken - Class in net.apartium.cocoabeans.commands.lexer
-
Command token for parsing commands
- CommandToken(int, int, String) - Constructor for class net.apartium.cocoabeans.commands.lexer.CommandToken
-
Create a new command token
- CommandTokenSupplier<T> - Interface in net.apartium.cocoabeans.commands.lexer
-
Command token supplier
- CommandTokenType - Enum Class in net.apartium.cocoabeans.commands.lexer
-
CommandTokenType represents the type of command token
- COMMON_PARSERS - Static variable in class net.apartium.cocoabeans.commands.CommandManager
- compareTo(ArgumentParser<?>) - Method in class net.apartium.cocoabeans.commands.parsers.ArgumentParser
- CompoundParser<T> - Class in net.apartium.cocoabeans.commands.parsers
- CompoundParser(String, Class<T>, int, ArgumentMapper, CommandLexer) - Constructor for class net.apartium.cocoabeans.commands.parsers.CompoundParser
-
Deprecated, for removal: This API element is subject to removal in a future version.
- CompoundParser(String, Class<T>, int, EvaluationContext) - Constructor for class net.apartium.cocoabeans.commands.parsers.CompoundParser
-
Constructs a new parser
- contains(Object) - Method in class net.apartium.cocoabeans.commands.requirements.RequirementSet
- containsAll(Collection<?>) - Method in class net.apartium.cocoabeans.commands.requirements.RequirementSet
- ContextualMapBasedParser<T> - Class in net.apartium.cocoabeans.commands.parsers
-
Contextual Map-based parser that map of keyword to value When Map entry not found report
NoSuchElementInMapResponse - ContextualMapBasedParser(String, Class<T>, int) - Constructor for class net.apartium.cocoabeans.commands.parsers.ContextualMapBasedParser
-
Constructor
- ContextualMapBasedParser(String, Class<T>, int, boolean) - Constructor for class net.apartium.cocoabeans.commands.parsers.ContextualMapBasedParser
-
Constructor with an ignoreCase
- ContextualMapBasedParser(String, Class<T>, int, boolean, boolean) - Constructor for class net.apartium.cocoabeans.commands.parsers.ContextualMapBasedParser
-
Constructor with an ignoreCase and lax
- create(CommandNode...) - Method in class net.apartium.cocoabeans.commands.virtual.VirtualCommandFactory
-
Map a command node into a virtual command
- createArgumentRequirements(GenericNode, Annotation[], Map<Class<? extends ArgumentRequirementFactory>, ArgumentRequirementFactory>) - Static method in interface net.apartium.cocoabeans.commands.requirements.ArgumentRequirementFactory
-
Create an argument requirement from the given annotations
- createFromAnnotation(Annotation) - Static method in interface net.apartium.cocoabeans.commands.requirements.ArgumentRequirementFactory
-
Create an argument requirement factory
- createFromAnnotation(Annotation) - Static method in interface net.apartium.cocoabeans.commands.requirements.RequirementFactory
-
Create a requirement factory from an annotation
- createFromAnnotation(Annotation, boolean) - Static method in interface net.apartium.cocoabeans.commands.parsers.ParserFactory
-
Create a parser factory from an annotation
- createFromAnnotations(Collection<Annotation[]>) - Static method in class net.apartium.cocoabeans.commands.CommandInfo
- createRequirementSet(GenericNode, Annotation[], Map<Class<? extends RequirementFactory>, RequirementFactory>, Map<Class<? extends Annotation>, RequirementFactory>) - Static method in interface net.apartium.cocoabeans.commands.requirements.RequirementFactory
-
Create a requirement set from the given annotations
D
- DEFAULT_KEYWORD - Static variable in class net.apartium.cocoabeans.commands.parsers.BooleanParser
- DEFAULT_KEYWORD - Static variable in class net.apartium.cocoabeans.commands.parsers.DoubleParser
- DEFAULT_KEYWORD - Static variable in class net.apartium.cocoabeans.commands.parsers.DummyParser
- DEFAULT_KEYWORD - Static variable in class net.apartium.cocoabeans.commands.parsers.FloatParser
- DEFAULT_KEYWORD - Static variable in class net.apartium.cocoabeans.commands.parsers.IntParser
- DEFAULT_KEYWORD - Static variable in class net.apartium.cocoabeans.commands.parsers.LongParser
- DEFAULT_KEYWORD - Static variable in class net.apartium.cocoabeans.commands.parsers.ParagraphParser
- DEFAULT_KEYWORD - Static variable in class net.apartium.cocoabeans.commands.parsers.QuotedStringParser
- DEFAULT_KEYWORD - Static variable in class net.apartium.cocoabeans.commands.parsers.StringParser
- DEFAULT_KEYWORD - Static variable in class net.apartium.cocoabeans.commands.parsers.StringsParser
- DEFAULT_KEYWORD - Static variable in class net.apartium.cocoabeans.commands.parsers.UUIDParser
- depth - Variable in class net.apartium.cocoabeans.commands.exception.BadCommandResponse
- depth() - Method in record class net.apartium.cocoabeans.commands.requirements.RequirementEvaluationContext
-
Returns the value of the
depthrecord component. - Description - Annotation Interface in net.apartium.cocoabeans.commands
-
This annotation is used to provide a short description for a class or method.
- DoubleParser - Class in net.apartium.cocoabeans.commands.parsers
- DoubleParser(int) - Constructor for class net.apartium.cocoabeans.commands.parsers.DoubleParser
-
Creates new double parser
- DoubleParser(int, String) - Constructor for class net.apartium.cocoabeans.commands.parsers.DoubleParser
-
Creates new double parser
- DummyParser - Class in net.apartium.cocoabeans.commands.parsers
- DummyParser() - Constructor for class net.apartium.cocoabeans.commands.parsers.DummyParser
-
Creates a dummy parser
- DummyParser(int) - Constructor for class net.apartium.cocoabeans.commands.parsers.DummyParser
-
Creates a dummy parser
- DummyParser(String, int) - Constructor for class net.apartium.cocoabeans.commands.parsers.DummyParser
-
Creates a dummy parser
E
- equals(Object) - Method in record class net.apartium.cocoabeans.commands.ArgumentContext
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class net.apartium.cocoabeans.commands.CommandContext
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class net.apartium.cocoabeans.commands.CommandInfo
- equals(Object) - Method in record class net.apartium.cocoabeans.commands.EvaluationContext
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class net.apartium.cocoabeans.commands.exception.HandleExceptionVariant
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class net.apartium.cocoabeans.commands.lexer.SimpleArgumentParserToken
- equals(Object) - Method in class net.apartium.cocoabeans.commands.lexer.SimpleKeywordToken
- equals(Object) - Method in record class net.apartium.cocoabeans.commands.parsers.ArgumentParser.ParseResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class net.apartium.cocoabeans.commands.parsers.ArgumentParser.TabCompletionResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class net.apartium.cocoabeans.commands.parsers.ParserFactory.ParserResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class net.apartium.cocoabeans.commands.parsers.WrappedArgumentParser
- equals(Object) - Method in class net.apartium.cocoabeans.commands.RegisterArgumentParser
- equals(Object) - Method in record class net.apartium.cocoabeans.commands.RegisteredVariant
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class net.apartium.cocoabeans.commands.RegisteredVariant.Parameter
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class net.apartium.cocoabeans.commands.requirements.argument.RangeArgumentRequirementFactory.RangeImpl
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class net.apartium.cocoabeans.commands.requirements.RequirementEvaluationContext
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class net.apartium.cocoabeans.commands.requirements.RequirementResult.Value
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class net.apartium.cocoabeans.commands.requirements.RequirementSet
- equals(Object) - Method in record class net.apartium.cocoabeans.commands.SimpleArgumentMapper.ResultMap
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class net.apartium.cocoabeans.commands.virtual.VirtualCommandDefinition
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class net.apartium.cocoabeans.commands.virtual.VirtualCommandVariant
-
Indicates whether some other object is "equal to" this one.
- error() - Method in record class net.apartium.cocoabeans.commands.CommandContext
-
Returns the value of the
errorrecord component. - error(BadCommandResponse) - Static method in class net.apartium.cocoabeans.commands.requirements.RequirementResult
-
Creates a
RequirementResultrepresenting an error condition. - ESCAPE_CHARACTER - Static variable in class net.apartium.cocoabeans.commands.parsers.ParagraphParser
- ESCAPE_CHARACTER - Static variable in class net.apartium.cocoabeans.commands.parsers.QuotedStringParser
- EvaluationContext - Record Class in net.apartium.cocoabeans.commands
-
Represents the context in which a command is evaluated and processed during registration.
- EvaluationContext(CommandLexer, ArgumentMapper) - Constructor for record class net.apartium.cocoabeans.commands.EvaluationContext
- EvaluationContext(CommandLexer, ArgumentMapper, Map<Class<? extends Annotation>, RequirementFactory>) - Constructor for record class net.apartium.cocoabeans.commands.EvaluationContext
-
Creates an instance of a
EvaluationContextrecord class. - ExceptionHandle - Annotation Interface in net.apartium.cocoabeans.commands.exception
- exceptionType() - Method in record class net.apartium.cocoabeans.commands.exception.HandleExceptionVariant
-
Returns the value of the
exceptionTyperecord component. - externalRequirementFactories() - Method in record class net.apartium.cocoabeans.commands.EvaluationContext
-
Returns the value of the
externalRequirementFactoriesrecord component.
F
- fallbackHandle(Sender, String, String[]) - Method in interface net.apartium.cocoabeans.commands.CommandNode
-
This method should be overriden by implementations in order to provide fallback implementation for the cmd system
- findClassParsers(GenericNode, Class<?>, Map<Class<? extends ParserFactory>, ParserFactory>) - Static method in interface net.apartium.cocoabeans.commands.parsers.ParserFactory
-
Get argument parsers from a class
- FloatParser - Class in net.apartium.cocoabeans.commands.parsers
- FloatParser(int) - Constructor for class net.apartium.cocoabeans.commands.parsers.FloatParser
-
Creates new float parser
- FloatParser(int, String) - Constructor for class net.apartium.cocoabeans.commands.parsers.FloatParser
-
Creates new float parser
- from - Variable in class net.apartium.cocoabeans.commands.lexer.CommandToken
- from() - Method in class net.apartium.cocoabeans.commands.lexer.CommandToken
-
Gets the starting index
- from() - Element in annotation interface net.apartium.cocoabeans.commands.parsers.IntRangeParser
-
Lower bound of the range (excl)
- from() - Element in annotation interface net.apartium.cocoabeans.commands.requirements.argument.Range
- from() - Method in record class net.apartium.cocoabeans.commands.requirements.argument.RangeArgumentRequirementFactory.RangeImpl
-
Returns the value of the
fromrecord component.
G
- GenericNode - Interface in net.apartium.cocoabeans.commands
-
A generic node interface Is use for objects that are related to commands or other commands related objects like compound parsers and flags
- get(ArgumentContext) - Method in interface net.apartium.cocoabeans.commands.ArgumentIndex
-
Get the argument from the context
- getArgs() - Method in class net.apartium.cocoabeans.commands.exception.BadCommandResponse
- getArgs() - Method in exception class net.apartium.cocoabeans.commands.exception.CommandException
- getArgumentMapper() - Method in class net.apartium.cocoabeans.commands.CommandManager
- getArgumentParser(GenericNode, Annotation, GenericDeclaration) - Method in interface net.apartium.cocoabeans.commands.parsers.ParserFactory
-
Construct argument parsers for the given annotation
- getArgumentParsers(GenericNode, Annotation[], GenericDeclaration, boolean, Map<Class<? extends ParserFactory>, ParserFactory>) - Static method in interface net.apartium.cocoabeans.commands.parsers.ParserFactory
-
Get argument parsers from an array of annotations
- getArgumentParsers(GenericNode, Annotation, GenericDeclaration, boolean, Map<Class<? extends ParserFactory>, ParserFactory>) - Static method in interface net.apartium.cocoabeans.commands.parsers.ParserFactory
-
Get argument parsers from an annotation
- getArgumentRequirement(GenericNode, Object) - Method in class net.apartium.cocoabeans.commands.requirements.argument.RangeArgumentRequirementFactory
- getArgumentRequirement(GenericNode, Object) - Method in interface net.apartium.cocoabeans.commands.requirements.ArgumentRequirementFactory
-
Create an argument requirement from the given object
- getArgumentRequirementFactoryClass(Annotation) - Static method in interface net.apartium.cocoabeans.commands.requirements.ArgumentRequirementFactory
-
Get the class of the argument requirement factory
- getArgumentType() - Method in class net.apartium.cocoabeans.commands.parsers.ArgumentParser
-
Get argument type
- getAttempted() - Method in class net.apartium.cocoabeans.commands.parsers.exception.NoSuchElementInMapResponse
-
The attempted key that was not found
- getAttempted() - Method in exception class net.apartium.cocoabeans.commands.parsers.exception.NoSuchElementInMapResponse.NoSuchElementInMapException
-
The attempted key that was not found
- getBadCommandResponse() - Method in exception class net.apartium.cocoabeans.commands.exception.CommandException
- getCommandInfo(String) - Method in class net.apartium.cocoabeans.commands.CommandManager
- getCommandLexer() - Method in class net.apartium.cocoabeans.commands.CommandManager
- getCommandName() - Method in class net.apartium.cocoabeans.commands.exception.BadCommandResponse
- getCommandName() - Method in exception class net.apartium.cocoabeans.commands.exception.CommandException
- getCommandName() - Method in class net.apartium.cocoabeans.commands.exception.UnknownCommandResponse
- getDepth() - Method in class net.apartium.cocoabeans.commands.exception.BadCommandResponse
- getDepth() - Method in exception class net.apartium.cocoabeans.commands.exception.CommandException
- getDescription() - Method in class net.apartium.cocoabeans.commands.CommandInfo
-
Get the first description
- getDescriptions() - Method in class net.apartium.cocoabeans.commands.CommandInfo
-
Get all descriptions
- getError() - Method in class net.apartium.cocoabeans.commands.exception.BadCommandResponse
- getError() - Method in class net.apartium.cocoabeans.commands.exception.InvalidUsageResponse
- getError() - Method in class net.apartium.cocoabeans.commands.exception.UnknownCommandResponse
- getError() - Method in class net.apartium.cocoabeans.commands.parsers.exception.AmbiguousMappedKeyResponse
-
Construct a new instance of the exception to be thrown
- getError() - Method in class net.apartium.cocoabeans.commands.parsers.exception.InvalidParserResponse
-
Construct a new instance of the exception to be thrown
- getError() - Method in class net.apartium.cocoabeans.commands.parsers.exception.InvalidUUIDResponse
-
Construct a new instance of the exception to be thrown
- getError() - Method in class net.apartium.cocoabeans.commands.parsers.exception.NoSuchElementInMapResponse
-
Construct a new instance of the exception to be thrown
- getError() - Method in class net.apartium.cocoabeans.commands.requirements.RequirementResult
-
Returns the error response associated with this result.
- getError() - Method in class net.apartium.cocoabeans.commands.requirements.UnmetRequirementResponse
- getKeys() - Method in exception class net.apartium.cocoabeans.commands.parsers.exception.AmbiguousMappedKeyResponse.AmbiguousMappedKeyException
-
Get the list of ambiguous keys
- getKeys() - Method in class net.apartium.cocoabeans.commands.parsers.exception.AmbiguousMappedKeyResponse
-
Get the list of ambiguous keys
- getKeyword() - Method in class net.apartium.cocoabeans.commands.lexer.KeywordToken
-
Get the keyword
- getKeyword() - Method in class net.apartium.cocoabeans.commands.lexer.SimpleKeywordToken
-
Get the keyword
- getKeyword() - Method in class net.apartium.cocoabeans.commands.parsers.ArgumentParser
-
Get type keyword, like int or string
- getLongDescription() - Method in class net.apartium.cocoabeans.commands.CommandInfo
-
Get the first long description
- getLongDescriptions() - Method in class net.apartium.cocoabeans.commands.CommandInfo
-
Get all long descriptions
- getMap() - Method in class net.apartium.cocoabeans.commands.parsers.MapBasedParser
-
If you want to ignore case to be applied, then remember to lowercase the keyword
- getMap(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.ContextualMapBasedParser
-
If you want to ignore case to be applied, then remember to lowercase the keyword
- getMap(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.MapBasedParser
- getMessage() - Method in class net.apartium.cocoabeans.commands.exception.BadCommandResponse
- getMessage() - Method in exception class net.apartium.cocoabeans.commands.exception.CommandException
- getMetadata(Method) - Method in class net.apartium.cocoabeans.commands.virtual.VirtualCommandFactory
- getMetadata(Collection<Class<?>>) - Method in class net.apartium.cocoabeans.commands.virtual.VirtualCommandFactory
- getParameterName() - Method in class net.apartium.cocoabeans.commands.lexer.ArgumentParserToken
-
Gets the parameter name of the argument parser if it has one
- getParameterName() - Method in class net.apartium.cocoabeans.commands.lexer.SimpleArgumentParserToken
-
Gets the parameter name of the argument parser if it has one
- getParameterName() - Method in class net.apartium.cocoabeans.commands.RegisterArgumentParser
-
Get the parameter name
- getParser() - Method in class net.apartium.cocoabeans.commands.parsers.exception.InvalidParserResponse
-
Get the parser that reported the error
- getParser(Map<String, ArgumentParser<?>>) - Method in class net.apartium.cocoabeans.commands.lexer.ArgumentParserToken
-
Gets the argument parser from the given parsers map
- getParser(Map<String, ArgumentParser<?>>) - Method in class net.apartium.cocoabeans.commands.lexer.SimpleArgumentParserToken
-
Gets the argument parser from the given parsers map
- getParserFactoryClass(Annotation) - Static method in interface net.apartium.cocoabeans.commands.parsers.ParserFactory
-
Get the class of the parser factory from an annotation
- getParserName() - Method in class net.apartium.cocoabeans.commands.lexer.ArgumentParserToken
-
Gets the argument parser name
- getParserName() - Method in class net.apartium.cocoabeans.commands.lexer.SimpleArgumentParserToken
-
Gets the argument parser name
- getPriority() - Method in class net.apartium.cocoabeans.commands.parsers.ArgumentParser
-
Get priority
- getReport() - Method in class net.apartium.cocoabeans.commands.SimpleCommandProcessingContext
-
Retrieving the current report
- getRequirement() - Method in exception class net.apartium.cocoabeans.commands.exception.RequirementException
- getRequirement() - Method in class net.apartium.cocoabeans.commands.requirements.UnmetRequirementResponse
- getRequirement(GenericNode, Object) - Method in interface net.apartium.cocoabeans.commands.requirements.RequirementFactory
-
Create a requirement from the given object
- getRequirementFactoryClass(Annotation) - Static method in interface net.apartium.cocoabeans.commands.requirements.RequirementFactory
-
Get the class of the requirement factory
- getSender() - Method in interface net.apartium.cocoabeans.commands.Sender
-
Returns the underlying platform-specific sender object.
- getToken() - Method in exception class net.apartium.cocoabeans.commands.exception.UnknownTokenException
- getType() - Method in class net.apartium.cocoabeans.commands.lexer.ArgumentParserToken
-
Get the type of the token
- getType() - Method in class net.apartium.cocoabeans.commands.lexer.CommandToken
-
Get the type of the token
- getType() - Method in class net.apartium.cocoabeans.commands.lexer.KeywordToken
-
Get the type of the token
- getTypes() - Method in interface net.apartium.cocoabeans.commands.requirements.Requirement
-
Get list of classes that will be return if requirement is met Note: By default returns an empty list
- getUsage() - Method in class net.apartium.cocoabeans.commands.CommandInfo
-
Get the first usage
- getUsages() - Method in class net.apartium.cocoabeans.commands.CommandInfo
-
Get all usages
- getUserInput() - Method in class net.apartium.cocoabeans.commands.parsers.exception.InvalidUUIDResponse
-
Get the user input
- getUserInput() - Method in exception class net.apartium.cocoabeans.commands.parsers.exception.InvalidUUIDResponse.InvalidUUIDException
-
Get the user input
- getValues() - Method in class net.apartium.cocoabeans.commands.requirements.RequirementResult
-
Returns the optional values associated with this result.
- getVariants(Method, Set<VirtualCommandVariant>) - Method in class net.apartium.cocoabeans.commands.virtual.VirtualCommandFactory
- getVariants(Collection<Class<?>>) - Method in class net.apartium.cocoabeans.commands.virtual.VirtualCommandFactory
H
- handle(Sender, String, String[]) - Method in class net.apartium.cocoabeans.commands.CommandManager
- handleException(Sender, String, String[], Throwable) - Method in interface net.apartium.cocoabeans.commands.CommandNode
- HandleExceptionVariant - Record Class in net.apartium.cocoabeans.commands.exception
- HandleExceptionVariant(Class<? extends Throwable>, MethodHandle, Class<?>[], GenericNode, List<ArgumentIndex<?>>, int) - Constructor for record class net.apartium.cocoabeans.commands.exception.HandleExceptionVariant
-
Creates an instance of a
HandleExceptionVariantrecord class. - handleTabComplete(Sender, String, String[]) - Method in class net.apartium.cocoabeans.commands.CommandManager
- hasError() - Method in class net.apartium.cocoabeans.commands.requirements.RequirementResult
-
Checks whether there is an error associated with this result.
- hashCode() - Method in record class net.apartium.cocoabeans.commands.ArgumentContext
-
Returns a hash code value for this object.
- hashCode() - Method in record class net.apartium.cocoabeans.commands.CommandContext
-
Returns a hash code value for this object.
- hashCode() - Method in class net.apartium.cocoabeans.commands.CommandInfo
- hashCode() - Method in record class net.apartium.cocoabeans.commands.EvaluationContext
-
Returns a hash code value for this object.
- hashCode() - Method in record class net.apartium.cocoabeans.commands.exception.HandleExceptionVariant
-
Returns a hash code value for this object.
- hashCode() - Method in class net.apartium.cocoabeans.commands.lexer.SimpleArgumentParserToken
- hashCode() - Method in class net.apartium.cocoabeans.commands.lexer.SimpleKeywordToken
- hashCode() - Method in record class net.apartium.cocoabeans.commands.parsers.ArgumentParser.ParseResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class net.apartium.cocoabeans.commands.parsers.ArgumentParser.TabCompletionResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class net.apartium.cocoabeans.commands.parsers.ParserFactory.ParserResult
-
Returns a hash code value for this object.
- hashCode() - Method in class net.apartium.cocoabeans.commands.parsers.WrappedArgumentParser
- hashCode() - Method in class net.apartium.cocoabeans.commands.RegisterArgumentParser
- hashCode() - Method in record class net.apartium.cocoabeans.commands.RegisteredVariant
-
Returns a hash code value for this object.
- hashCode() - Method in record class net.apartium.cocoabeans.commands.RegisteredVariant.Parameter
-
Returns a hash code value for this object.
- hashCode() - Method in record class net.apartium.cocoabeans.commands.requirements.argument.RangeArgumentRequirementFactory.RangeImpl
-
Returns a hash code value for this object.
- hashCode() - Method in record class net.apartium.cocoabeans.commands.requirements.RequirementEvaluationContext
-
Returns a hash code value for this object.
- hashCode() - Method in record class net.apartium.cocoabeans.commands.requirements.RequirementResult.Value
-
Returns a hash code value for this object.
- hashCode() - Method in class net.apartium.cocoabeans.commands.requirements.RequirementSet
- hashCode() - Method in record class net.apartium.cocoabeans.commands.SimpleArgumentMapper.ResultMap
-
Returns a hash code value for this object.
- hashCode() - Method in record class net.apartium.cocoabeans.commands.virtual.VirtualCommandDefinition
-
Returns a hash code value for this object.
- hashCode() - Method in record class net.apartium.cocoabeans.commands.virtual.VirtualCommandVariant
-
Returns a hash code value for this object.
I
- ignoreCase() - Element in annotation interface net.apartium.cocoabeans.commands.parsers.SourceParser
-
Whether this variant should ignore case for its label
- ignoreCase() - Element in annotation interface net.apartium.cocoabeans.commands.SubCommand
-
Whether this variant should ignore case for its label
- ignoreCase() - Method in record class net.apartium.cocoabeans.commands.virtual.VirtualCommandVariant
-
Returns the value of the
ignoreCaserecord component. - index() - Method in interface net.apartium.cocoabeans.commands.CommandProcessingContext
-
Returns the current index of processing
- index() - Method in class net.apartium.cocoabeans.commands.SimpleCommandProcessingContext
-
Returns the current index
- info() - Method in record class net.apartium.cocoabeans.commands.virtual.VirtualCommandDefinition
-
Returns the value of the
inforecord component. - info() - Method in record class net.apartium.cocoabeans.commands.virtual.VirtualCommandVariant
-
Returns the value of the
inforecord component. - IntParser - Class in net.apartium.cocoabeans.commands.parsers
- IntParser(int) - Constructor for class net.apartium.cocoabeans.commands.parsers.IntParser
-
Creates a new int parser
- IntParser(int, String) - Constructor for class net.apartium.cocoabeans.commands.parsers.IntParser
-
Creates a new int parser
- IntRangeParser - Annotation Interface in net.apartium.cocoabeans.commands.parsers
-
A parser that parses an integer range
- IntRangeParsers - Annotation Interface in net.apartium.cocoabeans.commands.parsers
- INVALID_QUOTATION_MESSAGE - Static variable in class net.apartium.cocoabeans.commands.parsers.ParagraphParser
- INVALID_QUOTATION_MESSAGE - Static variable in class net.apartium.cocoabeans.commands.parsers.QuotedStringParser
- InvalidParserException(InvalidParserResponse) - Constructor for exception class net.apartium.cocoabeans.commands.parsers.exception.InvalidParserResponse.InvalidParserException
- InvalidParserResponse - Class in net.apartium.cocoabeans.commands.parsers.exception
-
Represents a response that is reported via a parser
- InvalidParserResponse(CommandProcessingContext, ArgumentParser<?>, String) - Constructor for class net.apartium.cocoabeans.commands.parsers.exception.InvalidParserResponse
-
Construct a new instance of invalid parser response
- InvalidParserResponse.InvalidParserException - Exception Class in net.apartium.cocoabeans.commands.parsers.exception
- InvalidUsageException() - Constructor for exception class net.apartium.cocoabeans.commands.exception.InvalidUsageResponse.InvalidUsageException
- InvalidUsageResponse - Class in net.apartium.cocoabeans.commands.exception
- InvalidUsageResponse() - Constructor for class net.apartium.cocoabeans.commands.exception.InvalidUsageResponse
- InvalidUsageResponse(String, String[], int) - Constructor for class net.apartium.cocoabeans.commands.exception.InvalidUsageResponse
- InvalidUsageResponse(String, String[], int, String) - Constructor for class net.apartium.cocoabeans.commands.exception.InvalidUsageResponse
- InvalidUsageResponse.InvalidUsageException - Exception Class in net.apartium.cocoabeans.commands.exception
- InvalidUUIDException() - Constructor for exception class net.apartium.cocoabeans.commands.parsers.exception.InvalidUUIDResponse.InvalidUUIDException
- InvalidUUIDResponse - Class in net.apartium.cocoabeans.commands.parsers.exception
- InvalidUUIDResponse(CommandProcessingContext, ArgumentParser<?>, String, String) - Constructor for class net.apartium.cocoabeans.commands.parsers.exception.InvalidUUIDResponse
-
Construct a new instance of invalid parser response
- InvalidUUIDResponse.InvalidUUIDException - Exception Class in net.apartium.cocoabeans.commands.parsers.exception
- isClass() - Method in enum class net.apartium.cocoabeans.commands.parsers.Scope
-
Whether this scope applies to a class
- isEmpty() - Method in class net.apartium.cocoabeans.commands.requirements.RequirementSet
- isOptional() - Method in class net.apartium.cocoabeans.commands.lexer.ArgumentParserToken
-
Gets if the argument parser is optional
- isOptional() - Method in class net.apartium.cocoabeans.commands.lexer.SimpleArgumentParserToken
-
Gets if the argument parser is optional
- isOptional() - Method in class net.apartium.cocoabeans.commands.RegisterArgumentParser
-
Get if the argument parser accept no argument
- isVariant() - Method in enum class net.apartium.cocoabeans.commands.parsers.Scope
-
Whether this scope applies to a variant
- iterator() - Method in class net.apartium.cocoabeans.commands.requirements.RequirementSet
K
- key() - Element in annotation interface net.apartium.cocoabeans.commands.virtual.VirtualMetadata
- keyword() - Element in annotation interface net.apartium.cocoabeans.commands.parsers.IntRangeParser
-
Keyword for the parser, default is "range"
- keyword() - Element in annotation interface net.apartium.cocoabeans.commands.parsers.SourceParser
-
The keyword that triggers the parser
- keyword() - Element in annotation interface net.apartium.cocoabeans.commands.parsers.WithParser
-
Parser keyword If empty it will use the default keyword of the parser
- KEYWORD - Enum constant in enum class net.apartium.cocoabeans.commands.lexer.CommandTokenType
- KeywordToken - Class in net.apartium.cocoabeans.commands.lexer
-
A Keyword token that represents an keyword
- KeywordToken(int, int, String) - Constructor for class net.apartium.cocoabeans.commands.lexer.KeywordToken
-
Create a new keyword token
L
- label() - Method in interface net.apartium.cocoabeans.commands.CommandProcessingContext
-
Returns the label of the command
- label() - Method in class net.apartium.cocoabeans.commands.SimpleCommandProcessingContext
-
Returns the command name
- lax() - Element in annotation interface net.apartium.cocoabeans.commands.parsers.SourceParser
-
Whether this variant should lazy map for its label
- lexer() - Method in record class net.apartium.cocoabeans.commands.EvaluationContext
-
Returns the value of the
lexerrecord component. - LongDescription - Annotation Interface in net.apartium.cocoabeans.commands
-
This annotation is used to provide a long description for a class or method.
- LongParser - Class in net.apartium.cocoabeans.commands.parsers
- LongParser(int) - Constructor for class net.apartium.cocoabeans.commands.parsers.LongParser
-
Creates a new long parser
- LongParser(int, String) - Constructor for class net.apartium.cocoabeans.commands.parsers.LongParser
-
Creates a new long parser
M
- MapBasedParser<T> - Class in net.apartium.cocoabeans.commands.parsers
-
Map-based parser that map of keyword to value When Map entry not found report
NoSuchElementInMapResponseUnlikeContextualMapBasedParserMapBasedParser doesn't care for context - MapBasedParser(String, Class<T>, int) - Constructor for class net.apartium.cocoabeans.commands.parsers.MapBasedParser
-
Constructor
- MapBasedParser(String, Class<T>, int, boolean) - Constructor for class net.apartium.cocoabeans.commands.parsers.MapBasedParser
-
Constructor with ignoreCase
- MapBasedParser(String, Class<T>, int, boolean, boolean) - Constructor for class net.apartium.cocoabeans.commands.parsers.MapBasedParser
-
Constructor with ignoreCase and lax
- mapIndices(RegisteredVariant.Parameter[], List<RegisterArgumentParser<?>>, List<Requirement>, List<Class<?>>) - Method in interface net.apartium.cocoabeans.commands.ArgumentMapper
-
Maps the command arguments into the argument indexes required by the sub command to be call with the right arguments
- mapIndices(RegisteredVariant.Parameter[], List<RegisterArgumentParser<?>>, List<Requirement>, List<Class<?>>) - Method in class net.apartium.cocoabeans.commands.SimpleArgumentMapper
- mapOfArgumentsByParameterName() - Method in record class net.apartium.cocoabeans.commands.SimpleArgumentMapper.ResultMap
-
Returns the value of the
mapOfArgumentsByParameterNamerecord component. - mapOfArgumentsByType() - Method in record class net.apartium.cocoabeans.commands.SimpleArgumentMapper.ResultMap
-
Returns the value of the
mapOfArgumentsByTyperecord component. - mapper() - Method in record class net.apartium.cocoabeans.commands.EvaluationContext
-
Returns the value of the
mapperrecord component. - meet() - Static method in class net.apartium.cocoabeans.commands.requirements.RequirementResult
-
Creates a
RequirementResultindicating that the requirement has been met without additional values. - meet(RequirementResult.Value...) - Static method in class net.apartium.cocoabeans.commands.requirements.RequirementResult
-
Creates a
RequirementResultindicating that the requirement has been met with optional values. - meetRequirement() - Method in class net.apartium.cocoabeans.commands.requirements.RequirementResult
-
Indicates whether the requirement has been met.
- meetsRequirement(Sender, CommandContext, Object) - Method in record class net.apartium.cocoabeans.commands.requirements.argument.RangeArgumentRequirementFactory.RangeImpl
- meetsRequirement(Sender, CommandContext, Object) - Method in interface net.apartium.cocoabeans.commands.requirements.ArgumentRequirement
- meetsRequirement(RequirementEvaluationContext) - Method in interface net.apartium.cocoabeans.commands.requirements.Requirement
-
Check if given context meets this requirement.
- meetsRequirements(RequirementEvaluationContext) - Method in class net.apartium.cocoabeans.commands.requirements.RequirementSet
- message - Variable in class net.apartium.cocoabeans.commands.exception.BadCommandResponse
- metadata() - Method in record class net.apartium.cocoabeans.commands.virtual.VirtualCommandDefinition
-
Returns the value of the
metadatarecord component. - metadata() - Method in record class net.apartium.cocoabeans.commands.virtual.VirtualCommandVariant
-
Returns the value of the
metadatarecord component. - metaDataMap(AnnotatedElement, Map<String, Object>) - Method in class net.apartium.cocoabeans.commands.virtual.VirtualCommandFactory
- method() - Method in record class net.apartium.cocoabeans.commands.exception.HandleExceptionVariant
-
Returns the value of the
methodrecord component. - method() - Method in record class net.apartium.cocoabeans.commands.RegisteredVariant
-
Returns the value of the
methodrecord component.
N
- name() - Method in record class net.apartium.cocoabeans.commands.virtual.VirtualCommandDefinition
-
Returns the value of the
namerecord component. - net.apartium.cocoabeans.commands - package net.apartium.cocoabeans.commands
-
Platform independent command system
- net.apartium.cocoabeans.commands.exception - package net.apartium.cocoabeans.commands.exception
- net.apartium.cocoabeans.commands.lexer - package net.apartium.cocoabeans.commands.lexer
- net.apartium.cocoabeans.commands.parsers - package net.apartium.cocoabeans.commands.parsers
- net.apartium.cocoabeans.commands.parsers.exception - package net.apartium.cocoabeans.commands.parsers.exception
- net.apartium.cocoabeans.commands.parsers.factory - package net.apartium.cocoabeans.commands.parsers.factory
- net.apartium.cocoabeans.commands.requirements - package net.apartium.cocoabeans.commands.requirements
- net.apartium.cocoabeans.commands.requirements.argument - package net.apartium.cocoabeans.commands.requirements.argument
- net.apartium.cocoabeans.commands.virtual - package net.apartium.cocoabeans.commands.virtual
-
Commands over network system
- NEW_LINE_CHARACTER - Static variable in class net.apartium.cocoabeans.commands.parsers.ParagraphParser
- NEW_LINE_CHARACTER - Static variable in class net.apartium.cocoabeans.commands.parsers.QuotedStringParser
- newIndex() - Method in record class net.apartium.cocoabeans.commands.parsers.ArgumentParser.ParseResult
-
Returns the value of the
newIndexrecord component. - newIndex() - Method in record class net.apartium.cocoabeans.commands.parsers.ArgumentParser.TabCompletionResult
-
Returns the value of the
newIndexrecord component. - node() - Method in record class net.apartium.cocoabeans.commands.exception.HandleExceptionVariant
-
Returns the value of the
noderecord component. - node() - Method in record class net.apartium.cocoabeans.commands.RegisteredVariant
-
Returns the value of the
noderecord component. - NoSuchElementInMapResponse - Class in net.apartium.cocoabeans.commands.parsers.exception
-
Represents a response that is reported via a parser when a mapped key is not found
- NoSuchElementInMapResponse(CommandProcessingContext, ContextualMapBasedParser<?>, String, String) - Constructor for class net.apartium.cocoabeans.commands.parsers.exception.NoSuchElementInMapResponse
-
Construct a new instance of invalid parser response
- NoSuchElementInMapResponse.NoSuchElementInMapException - Exception Class in net.apartium.cocoabeans.commands.parsers.exception
-
NoSuchElementInMapException Represents a response that is reported via a parser when a mapped key is not found
O
- of(GenericNode, Parameter[], Map<Class<? extends ArgumentRequirementFactory>, ArgumentRequirementFactory>) - Static method in record class net.apartium.cocoabeans.commands.RegisteredVariant.Parameter
-
create parameters from the given parameters
- option() - Method in record class net.apartium.cocoabeans.commands.CommandContext
-
Returns the value of the
optionrecord component. - optionalNotMatch() - Method in class net.apartium.cocoabeans.commands.lexer.ArgumentParserToken
-
Gets if the argument parser is optional but does not match
- optionalNotMatch() - Method in class net.apartium.cocoabeans.commands.lexer.SimpleArgumentParserToken
-
Gets if the argument parser is optional but does not match
- optionalNotMatch() - Method in class net.apartium.cocoabeans.commands.RegisterArgumentParser
-
Get if the argument parser accept optional but does not match
P
- ParagraphParser - Class in net.apartium.cocoabeans.commands.parsers
-
Parsers that let you press strings that are more than one word and are limited by using quotation marks and has support for new lines
Example
Input/test Hello\nWorld
OutputHello
World - ParagraphParser(int) - Constructor for class net.apartium.cocoabeans.commands.parsers.ParagraphParser
-
Creates paragraph parser
- ParagraphParser(int, String) - Constructor for class net.apartium.cocoabeans.commands.parsers.ParagraphParser
-
Creates paragraph parser
- Param - Annotation Interface in net.apartium.cocoabeans.commands
- Parameter(Class<?>, Type, ArgumentRequirement[], String) - Constructor for record class net.apartium.cocoabeans.commands.RegisteredVariant.Parameter
-
Creates an instance of a
Parameterrecord class. - parameterizedType() - Method in record class net.apartium.cocoabeans.commands.RegisteredVariant.Parameter
-
Returns the value of the
parameterizedTyperecord component. - parameterName() - Method in record class net.apartium.cocoabeans.commands.RegisteredVariant.Parameter
-
Returns the value of the
parameterNamerecord component. - parameters() - Method in record class net.apartium.cocoabeans.commands.exception.HandleExceptionVariant
-
Returns the value of the
parametersrecord component. - parameters() - Method in record class net.apartium.cocoabeans.commands.RegisteredVariant
-
Returns the value of the
parametersrecord component. - parse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.ArgumentParser
-
Tries to parse next argument in the context
- parse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.BooleanParser
- parse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.CompoundParser
- parse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.ContextualMapBasedParser
- parse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.DoubleParser
- parse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.DummyParser
- parse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.FloatParser
- parse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.IntParser
- parse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.LongParser
- parse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.ParagraphParser
-
Tries to parse next argument in the context
- parse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.QuotedStringParser
-
Tries to parse next argument in the context
- parse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.StringParser
- parse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.StringsParser
- parse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.UUIDParser
- parse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.WrappedArgumentParser
-
Tries to parse next argument in the context
- parse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.RegisterArgumentParser
-
Tries to parse next argument in the context
- parsedArgs() - Method in record class net.apartium.cocoabeans.commands.ArgumentContext
-
Returns the value of the
parsedArgsrecord component. - parsedArgs() - Method in record class net.apartium.cocoabeans.commands.CommandContext
-
Returns the value of the
parsedArgsrecord component. - parser() - Method in record class net.apartium.cocoabeans.commands.parsers.ParserFactory.ParserResult
-
Returns the value of the
parserrecord component. - parser() - Method in class net.apartium.cocoabeans.commands.RegisterArgumentParser
-
Get the argument parser that this register argument parser wraps
- ParseResult(T, int) - Constructor for record class net.apartium.cocoabeans.commands.parsers.ArgumentParser.ParseResult
-
Creates an instance of a
ParseResultrecord class. - ParserFactory - Interface in net.apartium.cocoabeans.commands.parsers
-
A factory associated with specific annotations to create argument parsers based on annotations present in the command class
- ParserFactory.ParserResult - Record Class in net.apartium.cocoabeans.commands.parsers
-
Represents a parser to be registered
- ParserResult(ArgumentParser<?>, Scope) - Constructor for record class net.apartium.cocoabeans.commands.parsers.ParserFactory.ParserResult
-
Creates an instance of a
ParserResultrecord class. - ParserVariant - Annotation Interface in net.apartium.cocoabeans.commands.parsers
-
Parser variant is a variant of compound parser
- ParserVariants - Annotation Interface in net.apartium.cocoabeans.commands.parsers
- PRIMITIVE_TO_WRAPPER_MAP - Static variable in class net.apartium.cocoabeans.commands.SimpleArgumentMapper
- priority() - Element in annotation interface net.apartium.cocoabeans.commands.exception.ExceptionHandle
- priority() - Method in record class net.apartium.cocoabeans.commands.exception.HandleExceptionVariant
-
Returns the value of the
priorityrecord component. - priority() - Element in annotation interface net.apartium.cocoabeans.commands.parsers.IntRangeParser
-
Parser priority
- priority() - Element in annotation interface net.apartium.cocoabeans.commands.parsers.ParserVariant
- priority() - Element in annotation interface net.apartium.cocoabeans.commands.parsers.SourceParser
-
The priority
- priority() - Element in annotation interface net.apartium.cocoabeans.commands.parsers.WithParser
-
Parser priority
- priority() - Method in record class net.apartium.cocoabeans.commands.RegisteredVariant
-
Returns the value of the
priorityrecord component. - priority() - Element in annotation interface net.apartium.cocoabeans.commands.SubCommand
-
Sub command priority
Q
- QUOTATION_CHARACTER - Static variable in class net.apartium.cocoabeans.commands.parsers.ParagraphParser
- QUOTATION_CHARACTER - Static variable in class net.apartium.cocoabeans.commands.parsers.QuotedStringParser
- QuotedStringParser - Class in net.apartium.cocoabeans.commands.parsers
-
Quoted string parser Parsers that let you press strings that are more than one word and are limited by using quotation marks
Examples
Input/test helloOutputhello
Input/test "hello world"Outputhello world - QuotedStringParser(int) - Constructor for class net.apartium.cocoabeans.commands.parsers.QuotedStringParser
-
Creates quoted string parser
- QuotedStringParser(int, String) - Constructor for class net.apartium.cocoabeans.commands.parsers.QuotedStringParser
-
Creates quoted string parser
R
- Range - Annotation Interface in net.apartium.cocoabeans.commands.requirements.argument
- RangeArgumentRequirementFactory - Class in net.apartium.cocoabeans.commands.requirements.argument
- RangeArgumentRequirementFactory() - Constructor for class net.apartium.cocoabeans.commands.requirements.argument.RangeArgumentRequirementFactory
- RangeArgumentRequirementFactory.RangeImpl - Record Class in net.apartium.cocoabeans.commands.requirements.argument
- RangeImpl(double, double, double) - Constructor for record class net.apartium.cocoabeans.commands.requirements.argument.RangeArgumentRequirementFactory.RangeImpl
-
Creates an instance of a
RangeImplrecord class. - RegisterArgumentParser<T> - Class in net.apartium.cocoabeans.commands
-
A register argument parser is a wrapper for an argument parser Used for registering argument parsers because we need extra information for register argument parser
- RegisterArgumentParser(ArgumentParser<T>, boolean, boolean, String) - Constructor for class net.apartium.cocoabeans.commands.RegisterArgumentParser
-
A constructor for a register argument parser
- registerArgumentTypeHandler(Set<ArgumentParser<?>>) - Method in class net.apartium.cocoabeans.commands.CommandManager
- registerArgumentTypeHandler(ArgumentParser<?>) - Method in class net.apartium.cocoabeans.commands.CommandManager
- REGISTERED_VARIANT_COMPARATOR - Static variable in record class net.apartium.cocoabeans.commands.RegisteredVariant
-
Comparator for registered variants
- RegisteredVariant - Record Class in net.apartium.cocoabeans.commands
-
Registered variant for a command
- RegisteredVariant(MethodHandle, RegisteredVariant.Parameter[], GenericNode, List<ArgumentIndex<?>>, int) - Constructor for record class net.apartium.cocoabeans.commands.RegisteredVariant
-
Creates an instance of a
RegisteredVariantrecord class. - RegisteredVariant.Parameter - Record Class in net.apartium.cocoabeans.commands
-
Parameter represent a parameter of the command after has been parsed
- registerRequirementFactory(Class<? extends Annotation>, RequirementFactory) - Method in class net.apartium.cocoabeans.commands.CommandManager
-
Registers an external requirement factory for a specific annotation.
- remove(Object) - Method in class net.apartium.cocoabeans.commands.requirements.RequirementSet
- removeAll(Collection<?>) - Method in class net.apartium.cocoabeans.commands.requirements.RequirementSet
- report(Object, BadCommandResponse) - Method in interface net.apartium.cocoabeans.commands.CommandProcessingContext
-
Report a problem with command parsing, such as invalid arguments
- report(Object, BadCommandResponse) - Method in class net.apartium.cocoabeans.commands.SimpleCommandProcessingContext
-
report a problem with command parsing
- requirement - Variable in exception class net.apartium.cocoabeans.commands.exception.RequirementException
- requirement - Variable in class net.apartium.cocoabeans.commands.requirements.UnmetRequirementResponse
- Requirement - Interface in net.apartium.cocoabeans.commands.requirements
-
Represents a requirement to run a command or a sub command, eg a permission, sender type (player / console etc)
- requirementAnnotation - Variable in class net.apartium.cocoabeans.commands.requirements.UnmetRequirementResponse
- RequirementEvaluationContext - Record Class in net.apartium.cocoabeans.commands.requirements
- RequirementEvaluationContext(Sender, String, String[], int) - Constructor for record class net.apartium.cocoabeans.commands.requirements.RequirementEvaluationContext
-
Creates an instance of a
RequirementEvaluationContextrecord class. - RequirementException - Exception Class in net.apartium.cocoabeans.commands.exception
- RequirementException(UnmetRequirementResponse, Annotation) - Constructor for exception class net.apartium.cocoabeans.commands.exception.RequirementException
- RequirementFactory - Interface in net.apartium.cocoabeans.commands.requirements
- RequirementResult - Class in net.apartium.cocoabeans.commands.requirements
-
Represents the result of a requirement check This class encapsulates whether a requirement has been met, and optionally provides an error response and additional values if the requirement was met
- RequirementResult.Value - Record Class in net.apartium.cocoabeans.commands.requirements
-
Represents a value associated with a requirement result.
- RequirementSet - Class in net.apartium.cocoabeans.commands.requirements
-
Immutable set of command requirements
- RequirementSet() - Constructor for class net.apartium.cocoabeans.commands.requirements.RequirementSet
- RequirementSet(Collection<Requirement>...) - Constructor for class net.apartium.cocoabeans.commands.requirements.RequirementSet
- RequirementSet(Requirement...) - Constructor for class net.apartium.cocoabeans.commands.requirements.RequirementSet
- resolveBuiltInArgumentIndex(Class<?>, Map<Class<?>, Integer>, Map<Class<?>, List<ArgumentIndex<?>>>, int) - Method in class net.apartium.cocoabeans.commands.SimpleArgumentMapper
- result() - Method in record class net.apartium.cocoabeans.commands.parsers.ArgumentParser.ParseResult
-
Returns the value of the
resultrecord component. - result() - Method in record class net.apartium.cocoabeans.commands.parsers.ArgumentParser.TabCompletionResult
-
Returns the value of the
resultrecord component. - ResultMap(Map<Class<?>, List<ArgumentIndex<?>>>, Map<String, ArgumentIndex<?>>) - Constructor for record class net.apartium.cocoabeans.commands.SimpleArgumentMapper.ResultMap
-
Creates an instance of a
ResultMaprecord class. - resultMaxAgeInMills() - Element in annotation interface net.apartium.cocoabeans.commands.parsers.SourceParser
-
The max age of the result in milliseconds When the result is older it will be discarded next time someone use the parser When set to -1 it will never be discarded When set to 0 it will always be discarded
- retainAll(Collection<?>) - Method in class net.apartium.cocoabeans.commands.requirements.RequirementSet
S
- scope() - Element in annotation interface net.apartium.cocoabeans.commands.parsers.CommandParserFactory
- scope() - Method in record class net.apartium.cocoabeans.commands.parsers.ParserFactory.ParserResult
-
Returns the value of the
scoperecord component. - Scope - Enum Class in net.apartium.cocoabeans.commands.parsers
-
Represents the scope of a parser factory
- sender() - Method in record class net.apartium.cocoabeans.commands.ArgumentContext
-
Returns the value of the
senderrecord component. - sender() - Method in record class net.apartium.cocoabeans.commands.CommandContext
-
Returns the value of the
senderrecord component. - sender() - Method in interface net.apartium.cocoabeans.commands.CommandProcessingContext
-
Sender instance
- sender() - Method in record class net.apartium.cocoabeans.commands.requirements.RequirementEvaluationContext
-
Returns the value of the
senderrecord component. - sender() - Method in class net.apartium.cocoabeans.commands.SimpleCommandProcessingContext
-
Returns the sender
- Sender - Interface in net.apartium.cocoabeans.commands
-
Represents a command sender
- senderMeetsRequirement(Requirement) - Method in interface net.apartium.cocoabeans.commands.CommandProcessingContext
-
Check if sender meets given requirement instance.
- senderMeetsRequirement(Requirement) - Method in class net.apartium.cocoabeans.commands.SimpleCommandProcessingContext
-
check if sender meets requirement
- sendMessage(String) - Method in interface net.apartium.cocoabeans.commands.Sender
-
Sends a message to the sender
- sendMessage(String...) - Method in interface net.apartium.cocoabeans.commands.Sender
-
Sends a message to the sender
- SimpleArgumentMapper - Class in net.apartium.cocoabeans.commands
- SimpleArgumentMapper() - Constructor for class net.apartium.cocoabeans.commands.SimpleArgumentMapper
- SimpleArgumentMapper.ResultMap - Record Class in net.apartium.cocoabeans.commands
-
Result of mapping arguments to index
- SimpleArgumentParserToken - Class in net.apartium.cocoabeans.commands.lexer
-
A simple argument parser token is a token that represents an argument parser
- SimpleArgumentParserToken(int, int, String) - Constructor for class net.apartium.cocoabeans.commands.lexer.SimpleArgumentParserToken
-
Create a new argument parser token
- SimpleCommandLexer - Class in net.apartium.cocoabeans.commands.lexer
-
A simple command lexer tokenize commands, and then we could use it to parse the command
- SimpleCommandLexer() - Constructor for class net.apartium.cocoabeans.commands.lexer.SimpleCommandLexer
-
Create a new simple command lexer with SimpleArgumentParserToken and SimpleKeywordToken
- SimpleCommandLexer(CommandTokenSupplier<ArgumentParserToken>, CommandTokenSupplier<KeywordToken>) - Constructor for class net.apartium.cocoabeans.commands.lexer.SimpleCommandLexer
-
Create a new simple command lexer
- SimpleCommandProcessingContext - Class in net.apartium.cocoabeans.commands
-
A simple implementation of
CommandProcessingContext - SimpleCommandProcessingContext(Sender, String, String[], int) - Constructor for class net.apartium.cocoabeans.commands.SimpleCommandProcessingContext
-
Create a simple command processing context
- SimpleKeywordToken - Class in net.apartium.cocoabeans.commands.lexer
-
A simple keyword token that represents a keyword
- SimpleKeywordToken(int, int, String) - Constructor for class net.apartium.cocoabeans.commands.lexer.SimpleKeywordToken
-
Create a new keyword token
- size() - Method in class net.apartium.cocoabeans.commands.requirements.RequirementSet
- SourceParser - Annotation Interface in net.apartium.cocoabeans.commands.parsers
-
Registers a source parser for a specific method that give that class access to it
- step() - Element in annotation interface net.apartium.cocoabeans.commands.parsers.IntRangeParser
-
Input int must be divisible by this number
- step() - Element in annotation interface net.apartium.cocoabeans.commands.requirements.argument.Range
- step() - Method in record class net.apartium.cocoabeans.commands.requirements.argument.RangeArgumentRequirementFactory.RangeImpl
-
Returns the value of the
steprecord component. - StringParser - Class in net.apartium.cocoabeans.commands.parsers
- StringParser(int) - Constructor for class net.apartium.cocoabeans.commands.parsers.StringParser
-
Creates a new string parser
- StringParser(int, String) - Constructor for class net.apartium.cocoabeans.commands.parsers.StringParser
-
Creates a new string parser
- StringsParser - Class in net.apartium.cocoabeans.commands.parsers
- StringsParser(int) - Constructor for class net.apartium.cocoabeans.commands.parsers.StringsParser
-
Creates a new strings parser
- StringsParser(int, String) - Constructor for class net.apartium.cocoabeans.commands.parsers.StringsParser
-
Creates a new strings parser
- SubCommand - Annotation Interface in net.apartium.cocoabeans.commands
-
Represents a sub command to be registered under a command
- SubCommands - Annotation Interface in net.apartium.cocoabeans.commands
T
- tabCompletion(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.ArgumentParser
-
Retrieves available options for tab completion of this argument
- tabCompletion(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.BooleanParser
- tabCompletion(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.CompoundParser
- tabCompletion(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.ContextualMapBasedParser
- tabCompletion(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.DoubleParser
- tabCompletion(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.DummyParser
- tabCompletion(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.FloatParser
- tabCompletion(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.IntParser
- tabCompletion(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.LongParser
- tabCompletion(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.ParagraphParser
-
Retrieves available options for tab completion of this argument
- tabCompletion(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.QuotedStringParser
-
Retrieves available options for tab completion of this argument
- tabCompletion(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.StringParser
- tabCompletion(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.StringsParser
- tabCompletion(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.UUIDParser
- tabCompletion(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.WrappedArgumentParser
-
Retrieves available options for tab completion of this argument
- tabCompletion(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.RegisterArgumentParser
-
Retrieves available options for tab completion of this argument
- TabCompletionResult(Set<String>, int) - Constructor for record class net.apartium.cocoabeans.commands.parsers.ArgumentParser.TabCompletionResult
-
Creates an instance of a
TabCompletionResultrecord class. - text - Variable in class net.apartium.cocoabeans.commands.lexer.CommandToken
- throwError() - Method in class net.apartium.cocoabeans.commands.exception.BadCommandResponse
- to - Variable in class net.apartium.cocoabeans.commands.lexer.CommandToken
- to() - Method in class net.apartium.cocoabeans.commands.lexer.CommandToken
-
Gets the ending index
- to() - Element in annotation interface net.apartium.cocoabeans.commands.parsers.IntRangeParser
-
Upper bound of the range (excl)
- to() - Element in annotation interface net.apartium.cocoabeans.commands.requirements.argument.Range
- to() - Method in record class net.apartium.cocoabeans.commands.requirements.argument.RangeArgumentRequirementFactory.RangeImpl
-
Returns the value of the
torecord component. - toArray() - Method in class net.apartium.cocoabeans.commands.requirements.RequirementSet
- toArray(T[]) - Method in class net.apartium.cocoabeans.commands.requirements.RequirementSet
- tokenize(String) - Method in interface net.apartium.cocoabeans.commands.lexer.CommandLexer
-
Tokenize the command into tokens
- tokenize(String) - Method in class net.apartium.cocoabeans.commands.lexer.SimpleCommandLexer
-
Tokenize the command into tokens
- toString() - Method in record class net.apartium.cocoabeans.commands.ArgumentContext
-
Returns a string representation of this record class.
- toString() - Method in record class net.apartium.cocoabeans.commands.CommandContext
-
Returns a string representation of this record class.
- toString() - Method in record class net.apartium.cocoabeans.commands.EvaluationContext
-
Returns a string representation of this record class.
- toString() - Method in record class net.apartium.cocoabeans.commands.exception.HandleExceptionVariant
-
Returns a string representation of this record class.
- toString() - Method in class net.apartium.cocoabeans.commands.lexer.SimpleArgumentParserToken
- toString() - Method in class net.apartium.cocoabeans.commands.lexer.SimpleKeywordToken
- toString() - Method in record class net.apartium.cocoabeans.commands.parsers.ArgumentParser.ParseResult
-
Returns a string representation of this record class.
- toString() - Method in record class net.apartium.cocoabeans.commands.parsers.ArgumentParser.TabCompletionResult
-
Returns a string representation of this record class.
- toString() - Method in record class net.apartium.cocoabeans.commands.parsers.ParserFactory.ParserResult
-
Returns a string representation of this record class.
- toString() - Method in class net.apartium.cocoabeans.commands.parsers.WrappedArgumentParser
- toString() - Method in record class net.apartium.cocoabeans.commands.RegisteredVariant.Parameter
-
Returns a string representation of this record class.
- toString() - Method in record class net.apartium.cocoabeans.commands.RegisteredVariant
-
Returns a string representation of this record class.
- toString() - Method in record class net.apartium.cocoabeans.commands.requirements.argument.RangeArgumentRequirementFactory.RangeImpl
-
Returns a string representation of this record class.
- toString() - Method in record class net.apartium.cocoabeans.commands.requirements.RequirementEvaluationContext
-
Returns a string representation of this record class.
- toString() - Method in record class net.apartium.cocoabeans.commands.requirements.RequirementResult.Value
-
Returns a string representation of this record class.
- toString() - Method in class net.apartium.cocoabeans.commands.requirements.RequirementSet
- toString() - Method in record class net.apartium.cocoabeans.commands.SimpleArgumentMapper.ResultMap
-
Returns a string representation of this record class.
- toString() - Method in record class net.apartium.cocoabeans.commands.virtual.VirtualCommandDefinition
-
Returns a string representation of this record class.
- toString() - Method in record class net.apartium.cocoabeans.commands.virtual.VirtualCommandVariant
-
Returns a string representation of this record class.
- tryParse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.ArgumentParser
-
Tries to lazily parse next argument in the context
- tryParse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.BooleanParser
- tryParse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.CompoundParser
- tryParse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.ContextualMapBasedParser
- tryParse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.DoubleParser
- tryParse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.DummyParser
- tryParse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.FloatParser
- tryParse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.IntParser
- tryParse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.LongParser
- tryParse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.ParagraphParser
-
Tries to lazily parse next argument in the context
- tryParse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.QuotedStringParser
-
Tries to lazily parse next argument in the context
- tryParse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.StringParser
- tryParse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.StringsParser
- tryParse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.UUIDParser
- tryParse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.parsers.WrappedArgumentParser
-
Tries to lazily parse next argument in the context
- tryParse(CommandProcessingContext) - Method in class net.apartium.cocoabeans.commands.RegisterArgumentParser
-
Tries to lazily parse next argument in the context
- type() - Method in record class net.apartium.cocoabeans.commands.RegisteredVariant.Parameter
-
Returns the value of the
typerecord component.
U
- UnknownCommandException() - Constructor for exception class net.apartium.cocoabeans.commands.exception.UnknownCommandResponse.UnknownCommandException
- UnknownCommandResponse - Class in net.apartium.cocoabeans.commands.exception
- UnknownCommandResponse(String) - Constructor for class net.apartium.cocoabeans.commands.exception.UnknownCommandResponse
- UnknownCommandResponse.UnknownCommandException - Exception Class in net.apartium.cocoabeans.commands.exception
- UnknownTokenException - Exception Class in net.apartium.cocoabeans.commands.exception
- UnknownTokenException(CommandToken) - Constructor for exception class net.apartium.cocoabeans.commands.exception.UnknownTokenException
- UnmetRequirementResponse - Class in net.apartium.cocoabeans.commands.requirements
- UnmetRequirementResponse(Requirement, String, String[], int, String, Annotation) - Constructor for class net.apartium.cocoabeans.commands.requirements.UnmetRequirementResponse
- UnmetRequirementResponse(Requirement, RequirementEvaluationContext, String, Annotation) - Constructor for class net.apartium.cocoabeans.commands.requirements.UnmetRequirementResponse
- Usage - Annotation Interface in net.apartium.cocoabeans.commands
-
This annotation is used to provide a usage for a class or method.
- UUIDParser - Class in net.apartium.cocoabeans.commands.parsers
- UUIDParser() - Constructor for class net.apartium.cocoabeans.commands.parsers.UUIDParser
-
Creates new UUID parser
- UUIDParser(int) - Constructor for class net.apartium.cocoabeans.commands.parsers.UUIDParser
-
Creates new UUID parser
- UUIDParser(String, int) - Constructor for class net.apartium.cocoabeans.commands.parsers.UUIDParser
-
Creates new UUID parser
V
- value() - Element in annotation interface net.apartium.cocoabeans.commands.Command
-
Command label
- value() - Element in annotation interface net.apartium.cocoabeans.commands.Description
- value() - Element in annotation interface net.apartium.cocoabeans.commands.exception.ExceptionHandle
- value() - Element in annotation interface net.apartium.cocoabeans.commands.LongDescription
- value() - Element in annotation interface net.apartium.cocoabeans.commands.Param
- value() - Element in annotation interface net.apartium.cocoabeans.commands.parsers.CommandParserFactory
- value() - Element in annotation interface net.apartium.cocoabeans.commands.parsers.IntRangeParsers
- value() - Element in annotation interface net.apartium.cocoabeans.commands.parsers.ParserVariant
- value() - Element in annotation interface net.apartium.cocoabeans.commands.parsers.ParserVariants
- value() - Element in annotation interface net.apartium.cocoabeans.commands.parsers.WithParser
-
Parser to register
- value() - Element in annotation interface net.apartium.cocoabeans.commands.parsers.WithParsers
- value() - Element in annotation interface net.apartium.cocoabeans.commands.requirements.ArgumentRequirementType
- value() - Element in annotation interface net.apartium.cocoabeans.commands.requirements.CommandRequirementType
- value() - Method in record class net.apartium.cocoabeans.commands.requirements.RequirementResult.Value
-
Returns the value of the
valuerecord component. - value() - Element in annotation interface net.apartium.cocoabeans.commands.SubCommand
-
Sub command label
- value() - Element in annotation interface net.apartium.cocoabeans.commands.SubCommands
- value() - Element in annotation interface net.apartium.cocoabeans.commands.Usage
- value() - Element in annotation interface net.apartium.cocoabeans.commands.virtual.VirtualMetadata
- value() - Element in annotation interface net.apartium.cocoabeans.commands.virtual.VirtualMetadataCollection
- Value(Object, Class<?>) - Constructor for record class net.apartium.cocoabeans.commands.requirements.RequirementResult.Value
-
Creates an instance of a
Valuerecord class. - valueOf(Object) - Static method in class net.apartium.cocoabeans.commands.requirements.RequirementResult
-
Creates a
Valuefrom the specified value. - valueOf(Object, Class<?>) - Static method in class net.apartium.cocoabeans.commands.requirements.RequirementResult
-
Creates a
Valuefrom the specified value and class. - valueOf(String) - Static method in enum class net.apartium.cocoabeans.commands.lexer.CommandTokenType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class net.apartium.cocoabeans.commands.parsers.Scope
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class net.apartium.cocoabeans.commands.lexer.CommandTokenType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class net.apartium.cocoabeans.commands.parsers.Scope
-
Returns an array containing the constants of this enum class, in the order they are declared.
- variant() - Method in record class net.apartium.cocoabeans.commands.virtual.VirtualCommandVariant
-
Returns the value of the
variantrecord component. - VARIANT - Enum constant in enum class net.apartium.cocoabeans.commands.parsers.Scope
-
Scoped to a specific sub command
- variants() - Method in record class net.apartium.cocoabeans.commands.virtual.VirtualCommandDefinition
-
Returns the value of the
variantsrecord component. - VirtualCommandDefinition - Record Class in net.apartium.cocoabeans.commands.virtual
-
A DTO for commands, a serializable form of commands used to send command definition between applications
- VirtualCommandDefinition(String, Set<String>, CommandInfo, Set<VirtualCommandVariant>, Map<String, Object>) - Constructor for record class net.apartium.cocoabeans.commands.virtual.VirtualCommandDefinition
-
Create a new virtual command definition instance
- VirtualCommandFactory - Class in net.apartium.cocoabeans.commands.virtual
-
Used to construct instances of
VirtualCommandDefinition - VirtualCommandFactory() - Constructor for class net.apartium.cocoabeans.commands.virtual.VirtualCommandFactory
- VirtualCommandVariant - Record Class in net.apartium.cocoabeans.commands.virtual
-
Represents a variant in a virtual command
- VirtualCommandVariant(CommandInfo, String, boolean, Map<String, Object>) - Constructor for record class net.apartium.cocoabeans.commands.virtual.VirtualCommandVariant
-
Creates a variant in a virtual command
- VirtualMetadata - Annotation Interface in net.apartium.cocoabeans.commands.virtual
-
Specifies metadata for a command or command variant.
- VirtualMetadataCollection - Annotation Interface in net.apartium.cocoabeans.commands.virtual
W
- WithParser - Annotation Interface in net.apartium.cocoabeans.commands.parsers
-
Registers a parser for a specific command
- WithParsers - Annotation Interface in net.apartium.cocoabeans.commands.parsers
- WrappedArgumentParser<T> - Class in net.apartium.cocoabeans.commands.parsers
- WrappedArgumentParser(ArgumentParser<T>, int) - Constructor for class net.apartium.cocoabeans.commands.parsers.WrappedArgumentParser
-
Wrapped argument parser constructor
- WrappedArgumentParser(ArgumentParser<T>, int, String) - Constructor for class net.apartium.cocoabeans.commands.parsers.WrappedArgumentParser
-
Wrapped argument parser constructor
- WrappedArgumentParser(ArgumentParser<T>, String) - Constructor for class net.apartium.cocoabeans.commands.parsers.WrappedArgumentParser
-
Wrapped argument parser constructor
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form