Index

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

A

ActionArgumentType - Class in io.github.darvil.lanat.argtypes

An argument type that is set in a true state if the argument was used.

ActionArgumentType() - Constructor for class io.github.darvil.lanat.argtypes.ActionArgumentType

addArgument(Argument<Type, TInner>) - Method in class io.github.darvil.lanat.Command

addArgument(Argument<Type, TInner>) - Method in class io.github.darvil.lanat.Group

addArgument(Argument<Type, TInner>) - Method in interface io.github.darvil.lanat.utils.ArgumentAdder

Inserts an argument into this container.

addArgument(Builder<Argument<Type, TInner>>) - Method in interface io.github.darvil.lanat.utils.ArgumentAdder

Inserts an argument into this container.

addCommand(Command) - Method in class io.github.darvil.lanat.Command

addCommand(Command) - Method in interface io.github.darvil.lanat.utils.CommandAdder

Adds the specified Sub-Command to this object.

addError(ArgumentTypeError) - Method in class io.github.darvil.lanat.Argument

addError(ArgumentTypeError) - Method in class io.github.darvil.lanat.ArgumentType

Adds an error to the list of errors.

addError(String) - Method in class io.github.darvil.lanat.argtypes.SimpleArgumentType.ErrorProxy

addError(String) - Method in class io.github.darvil.lanat.ArgumentType

Adds an error to the list of errors that occurred during parsing at the current token index.

addError(String, int) - Method in class io.github.darvil.lanat.ArgumentType

Adds an error to the list of errors that occurred during parsing.

addError(String, int, ErrorLevel) - Method in class io.github.darvil.lanat.argtypes.SimpleArgumentType.ErrorProxy

addError(String, int, ErrorLevel) - Method in class io.github.darvil.lanat.ArgumentType

Adds an error to the list of errors that occurred during parsing.

addError(String, ErrorLevel) - Method in class io.github.darvil.lanat.argtypes.SimpleArgumentType.ErrorProxy

addError(String, ErrorLevel) - Method in class io.github.darvil.lanat.ArgumentType

Adds an error to the list of errors that occurred during parsing.

addError(T) - Method in interface io.github.darvil.lanat.utils.errors.ErrorContainer

Adds an error to the list of errors.

addError(T) - Method in class io.github.darvil.lanat.utils.errors.ErrorContainerImpl

addGroup(Group) - Method in class io.github.darvil.lanat.Command

addGroup(Group) - Method in class io.github.darvil.lanat.Group

addGroup(Group) - Method in interface io.github.darvil.lanat.utils.GroupAdder

Adds an argument group to this container.

addLayoutItems(int, LayoutItem...) - Method in class io.github.darvil.lanat.helpgen.HelpFormatter

Adds one or more LayoutItem to the layout at the specified position.

addLayoutItems(LayoutItem...) - Method in class io.github.darvil.lanat.helpgen.HelpFormatter

Adds one or more LayoutItem to the layout.

addNames(String...) - Method in interface io.github.darvil.lanat.utils.MultipleNamesAndDescription

Add one or more names to this object.

afterInit(ArgumentParser) - Static method in class io.github.darvil.lanat.CommandTemplate

afterInit(Command) - Static method in class io.github.darvil.lanat.CommandTemplate

This method is called after the Command is initialized.

afterInit(Command) - Static method in class io.github.darvil.lanat.CommandTemplate.Default

AfterParseOptions - Class in io.github.darvil.lanat

Provides utilities for the parsed arguments after parsing is done.

AfterParseOptions.AfterParseActions - Class in io.github.darvil.lanat

Provides actions to be executed after parsing is done.

ANGLE_BRACKETS - Enum constant in enum class io.github.darvil.lanat.TupleChar

ANY - Enum constant in enum class io.github.darvil.lanat.argtypes.FileArgumentType.FileType

applyAbsoluteOffset(Range) - Method in class io.github.darvil.lanat.parsing.errors.contexts.ErrorContext

Applies the ErrorContext.getAbsoluteIndex() offset to the given Range.

arg(String) - Method in record class io.github.darvil.lanat.CommandTemplate.CommandBuildContext

Returns the argument builder corresponding to the argument with the given name.

args - Variable in class io.github.darvil.lanat.CLInput

The string of arguments passed to the program.

args() - Method in record class io.github.darvil.lanat.CommandTemplate.CommandBuildContext

Returns the value of the args record component.

argument() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.IncorrectUsagesCountError

Returns the value of the argument record component.

argument() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.IncorrectValueNumberError

Returns the value of the argument record component.

argument() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.RequiredArgumentNotUsedError

Returns the value of the argument record component.

argument() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.SimilarArgumentError

Returns the value of the argument record component.

argument() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.UniqueArgumentUsedError

Returns the value of the argument record component.

argument() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.UnmatchedInArgNameListError

Returns the value of the argument record component.

Argument<Type extends ArgumentType<TInner>,TInner> - Class in io.github.darvil.lanat

Argument

Argument(Type, String...) - Constructor for class io.github.darvil.lanat.Argument

Creates an argument with the specified type and names.

ARGUMENT_NAME - Enum constant in enum class io.github.darvil.lanat.parsing.TokenType

ARGUMENT_NAME_LIST - Enum constant in enum class io.github.darvil.lanat.parsing.TokenType

ARGUMENT_VALUE - Enum constant in enum class io.github.darvil.lanat.parsing.TokenType

ARGUMENT_VALUE_TUPLE_END - Enum constant in enum class io.github.darvil.lanat.parsing.TokenType

ARGUMENT_VALUE_TUPLE_START - Enum constant in enum class io.github.darvil.lanat.parsing.TokenType

Argument.Define - Annotation Interface in io.github.darvil.lanat

Used in CommandTemplates to specify the properties of an argument belonging to the command.

Argument.Prefix - Enum Class in io.github.darvil.lanat

Specifies the prefix character for an Argument.

ArgumentAdder - Interface in io.github.darvil.lanat.utils

An interface for objects that can add Arguments to themselves.

ArgumentAlreadyExistsException - Exception in io.github.darvil.lanat.exceptions

Thrown when an Argument is added to a container that already contains an Argument with the same name.

ArgumentAlreadyExistsException(Argument<?, ?>, T) - Constructor for exception io.github.darvil.lanat.exceptions.ArgumentAlreadyExistsException

ArgumentBuilder<Type extends ArgumentType<TInner>,TInner> - Class in io.github.darvil.lanat

Provides easy ways to build an Argument.

ArgumentNotFoundException - Exception in io.github.darvil.lanat.exceptions

Thrown when an Argument is not found.

ArgumentNotFoundException(Argument<?, ?>) - Constructor for exception io.github.darvil.lanat.exceptions.ArgumentNotFoundException

ArgumentNotFoundException(Argument<?, ?>, NamedWithDescription) - Constructor for exception io.github.darvil.lanat.exceptions.ArgumentNotFoundException

ArgumentNotFoundException(String) - Constructor for exception io.github.darvil.lanat.exceptions.ArgumentNotFoundException

ArgumentParser - Class in io.github.darvil.lanat

Argument Parser

ArgumentParser(Class<? extends CommandTemplate>) - Constructor for class io.github.darvil.lanat.ArgumentParser

Creates a new command based on the given CommandTemplate.

ArgumentParser(String) - Constructor for class io.github.darvil.lanat.ArgumentParser

Creates a new command with the given name and no description.

ArgumentParser(String, String) - Constructor for class io.github.darvil.lanat.ArgumentParser

Creates a new command with the given name and description.

ArgumentRepr - Class in io.github.darvil.lanat.helpgen

Contains methods for generating the help representations of Arguments.

argumentsDescriptions(Command) - Static method in class io.github.darvil.lanat.helpgen.LayoutGenerators

Shows the descriptions of the Arguments and Groups of the command.

ArgumentType<T> - Class in io.github.darvil.lanat

Argument Type

ArgumentType() - Constructor for class io.github.darvil.lanat.ArgumentType

Constructs a new argument type.

ArgumentType(Parseable<T>) - Constructor for class io.github.darvil.lanat.ArgumentType

Constructs a new argument type with the specified parseable.

ArgumentType(T) - Constructor for class io.github.darvil.lanat.ArgumentType

Constructs a new argument type with the specified initial value.

ArgumentType.ParseStateSnapshot - Record Class in io.github.darvil.lanat

A snapshot of the state of the argument type during parsing.

ArgumentTypeError - Class in io.github.darvil.lanat.parsing.errors.handlers

An error that may be thrown by an argument type.

ArgumentTypeError(String, ErrorLevel, int) - Constructor for class io.github.darvil.lanat.parsing.errors.handlers.ArgumentTypeError

Instantiates a new custom error.

ArgumentTypeError(String, ErrorLevel, Pair<Integer, Integer>) - Constructor for class io.github.darvil.lanat.parsing.errors.handlers.ArgumentTypeError

Instantiates a new custom error.

ArgumentTypeException - Exception in io.github.darvil.lanat.exceptions

Thrown when an error occurs in an ArgumentType.

ArgumentTypeException(String) - Constructor for exception io.github.darvil.lanat.exceptions.ArgumentTypeException

ArgumentTypeException(String, Throwable) - Constructor for exception io.github.darvil.lanat.exceptions.ArgumentTypeException

ArgumentTypeInfer - Class in io.github.darvil.lanat

Argument Type Inferring

ArgumentTypeInfer.PredicateInfer<T> - Record Class in io.github.darvil.lanat

A predicate that checks if the argument type should be inferred for the specified type.

ArgumentTypeInferException - Exception in io.github.darvil.lanat.exceptions

Thrown when an error occurs when inferring types for an ArgumentType.

ArgumentTypeInferException(Class<?>) - Constructor for exception io.github.darvil.lanat.exceptions.ArgumentTypeInferException

argWithType(String, Builder<Type>) - Method in record class io.github.darvil.lanat.CommandTemplate.CommandBuildContext

Sets the type of the argument builder with the given name to the given type, and returns it.

argWithType(String, Type) - Method in record class io.github.darvil.lanat.CommandTemplate.CommandBuildContext

Sets the type of the argument builder with the given name to the given type, and returns it.

AT - Enum constant in enum class io.github.darvil.lanat.Argument.Prefix

The at sign (@).

AUTO - Enum constant in enum class io.github.darvil.lanat.Argument.Prefix

Automatically set depending on the Operating System.

B

beforeInit(CommandTemplate.CommandBuildContext) - Static method in class io.github.darvil.lanat.CommandTemplate

This method is called after the Command Template builder reads all the field arguments defined.

BooleanArgumentType - Class in io.github.darvil.lanat.argtypes

An argument type that is set in a true state if the argument was used.

BooleanArgumentType() - Constructor for class io.github.darvil.lanat.argtypes.BooleanArgumentType

BRACES - Enum constant in enum class io.github.darvil.lanat.TupleChar

build() - Method in class io.github.darvil.lanat.argtypes.SimpleArgumentType.SimpleArgumentTypeBuilder

build() - Method in class io.github.darvil.lanat.ArgumentBuilder

Builds the argument.

build() - Method in interface io.github.darvil.lanat.utils.Builder

Builds the object.

Builder<T> - Interface in io.github.darvil.lanat.utils

A builder for a type.

ByteArgumentType - Class in io.github.darvil.lanat.argtypes

An argument type that takes a byte value.

ByteArgumentType() - Constructor for class io.github.darvil.lanat.argtypes.ByteArgumentType

C

checkFile(File) - Method in class io.github.darvil.lanat.argtypes.FileArgumentType

Checks if the file is valid.

checkMatch(char) - Method in class io.github.darvil.lanat.Argument

Checks if this argument matches the given single character name.

checkMatch(String) - Method in class io.github.darvil.lanat.Argument

Checks if this argument matches the given name, including the prefix.

checkUniqueArguments() - Method in interface io.github.darvil.lanat.utils.ArgumentAdder

Checks that all the arguments in this container are unique.

checkUniqueGroups() - Method in interface io.github.darvil.lanat.utils.GroupAdder

Checks that all the argument groups in this container are unique.

CLInput - Class in io.github.darvil.lanat

A class to gather the input from the command line.

close - Variable in enum class io.github.darvil.lanat.TupleChar

cmd() - Method in record class io.github.darvil.lanat.CommandTemplate.CommandBuildContext

Returns the value of the cmd record component.

collect(Command) - Method in class io.github.darvil.lanat.parsing.errors.ErrorCollector

Collects all the errors from the given command.

COLON - Enum constant in enum class io.github.darvil.lanat.Argument.Prefix

The colon (:).

color - Variable in enum class io.github.darvil.lanat.parsing.TokenType

color - Variable in enum class io.github.darvil.lanat.utils.errors.ErrorLevel

ColorTag - Class in io.github.darvil.lanat.helpgen.descriptions.tags

Changes the color of the text.

ColorTag() - Constructor for class io.github.darvil.lanat.helpgen.descriptions.tags.ColorTag

command - Variable in class io.github.darvil.lanat.parsing.errors.contexts.ErrorContext

The command that was being parsed when the error occurred.

command - Variable in class io.github.darvil.lanat.parsing.ParsingStateBase

The command that is being parsed.

Command - Class in io.github.darvil.lanat

Command

Command(Class<? extends CommandTemplate>) - Constructor for class io.github.darvil.lanat.Command

Creates a new command based on the given CommandTemplate.

Command(String) - Constructor for class io.github.darvil.lanat.Command

Creates a new command with the given name and no description.

Command(String, String) - Constructor for class io.github.darvil.lanat.Command

Creates a new command with the given name and description.

COMMAND - Enum constant in enum class io.github.darvil.lanat.parsing.TokenType

Command.CallbackInvocationOption - Enum Class in io.github.darvil.lanat

Command.Define - Annotation Interface in io.github.darvil.lanat

Annotation used to define a command template.

CommandAdder - Interface in io.github.darvil.lanat.utils

An interface for objects that can add Commands to themselves.

CommandAlreadyExistsException - Exception in io.github.darvil.lanat.exceptions

Thrown when a Command is added to a container that already contains a Command with the same name.

CommandAlreadyExistsException(Command, Command) - Constructor for exception io.github.darvil.lanat.exceptions.CommandAlreadyExistsException

CommandBuildContext(Command, List<ArgumentBuilder<?, ?>>) - Constructor for record class io.github.darvil.lanat.CommandTemplate.CommandBuildContext

Creates an instance of a CommandBuildContext record class.

CommandNotFoundException - Exception in io.github.darvil.lanat.exceptions

Thrown when a Command is not found.

CommandNotFoundException(NamedWithDescription) - Constructor for exception io.github.darvil.lanat.exceptions.CommandNotFoundException

CommandNotFoundException(NamedWithDescription, NamedWithDescription) - Constructor for exception io.github.darvil.lanat.exceptions.CommandNotFoundException

CommandNotFoundException(String) - Constructor for exception io.github.darvil.lanat.exceptions.CommandNotFoundException

CommandRepr - Class in io.github.darvil.lanat.helpgen

Contains methods for generating the help representations of Commands.

CommandTemplate - Class in io.github.darvil.lanat

Command Template

CommandTemplate() - Constructor for class io.github.darvil.lanat.CommandTemplate

CommandTemplate.CommandAccessor - Annotation Interface in io.github.darvil.lanat

Annotation used to define a sub-command field in a Command Template.

CommandTemplate.CommandBuildContext - Record Class in io.github.darvil.lanat

Helper class that contains the command being initialized and the list of argument builders that may be altered.

CommandTemplate.Default - Class in io.github.darvil.lanat

A command template that adds the 'help' and 'version' arguments to the command.

CommandTemplate.Default.WithVerbose - Class in io.github.darvil.lanat

A command template that adds the 'verbose' argument, as well as the 'help' and 'version' arguments defined in CommandTemplate.Default.

CommandTemplate.InitDef - Annotation Interface in io.github.darvil.lanat

Annotation used to define an init method for a Command Template.

CommandTemplateException - Exception in io.github.darvil.lanat.exceptions

Thrown when an error occurs while parsing a CommandTemplate.

CommandTemplateException(String) - Constructor for exception io.github.darvil.lanat.exceptions.CommandTemplateException

CommandUser - Interface in io.github.darvil.lanat.utils

This interface is used for objects that belong to a Command.

COMMON_PREFIXES - Static variable in enum class io.github.darvil.lanat.Argument.Prefix

Prefixes that a user may be familiar with.

compareByPriority(Argument<?, ?>, Argument<?, ?>) - Static method in class io.github.darvil.lanat.Argument

Compares two arguments by the synopsis view priority order.

contents() - Method in record class io.github.darvil.lanat.parsing.Token

Returns the value of the contents record component.

CounterArgumentType - Class in io.github.darvil.lanat.argtypes

An argument type that counts the number of times it is used.

CounterArgumentType() - Constructor for class io.github.darvil.lanat.argtypes.CounterArgumentType

create() - Static method in class io.github.darvil.lanat.Argument

Creates an argument builder with no type or names.

create(Builder<Type>, String...) - Static method in class io.github.darvil.lanat.Argument

Creates an argument builder with the specified type and names.

create(Type, String...) - Static method in class io.github.darvil.lanat.Argument

Creates an argument builder with the specified type and names.

createOfActionType(String...) - Static method in class io.github.darvil.lanat.Argument

Creates an argument builder with an ActionArgumentType type.

current - Static variable in enum class io.github.darvil.lanat.TupleChar

The current tuple characters used by the parser.

D

DEBUG - Enum constant in enum class io.github.darvil.lanat.utils.errors.ErrorLevel

debugLayout - Static variable in class io.github.darvil.lanat.helpgen.HelpFormatter

Whether to print debug information about the layout when generating the help message.

Default() - Constructor for class io.github.darvil.lanat.CommandTemplate.Default

DEFAULT - Enum constant in enum class io.github.darvil.lanat.Argument.Prefix

Set to the value of Argument.Prefix.getDefaultPrefix().

DEFAULT_ACTIONS - Static variable in class io.github.darvil.lanat.AfterParseOptions

DEFAULT_TYPE_RANGE - Static variable in class io.github.darvil.lanat.ArgumentTypeInfer

The default range to use for argument types that accept multiple values.

defaultValue(TInner) - Method in class io.github.darvil.lanat.ArgumentBuilder

DefaultValueTag - Class in io.github.darvil.lanat.helpgen.descriptions.tags

Gets the default value of an argument.

DefaultValueTag() - Constructor for class io.github.darvil.lanat.helpgen.descriptions.tags.DefaultValueTag

description() - Element in annotation interface io.github.darvil.lanat.Argument.Define

description() - Element in annotation interface io.github.darvil.lanat.Command.Define

description(String) - Method in class io.github.darvil.lanat.ArgumentBuilder

DescriptionParser - Class in io.github.darvil.lanat.helpgen.descriptions

A class that parses tags in a description and replaces them with the content generated by them.

DescTag - Class in io.github.darvil.lanat.helpgen.descriptions.tags

Gets the description of the target object specified by the route.

DescTag() - Constructor for class io.github.darvil.lanat.helpgen.descriptions.tags.DescTag

DIRECTORY - Enum constant in enum class io.github.darvil.lanat.argtypes.FileArgumentType.FileType

displayAndHighlightInput(DisplayInput.Highlight) - Method in class io.github.darvil.lanat.parsing.errors.contexts.formatting.ErrorFormattingContext

Indicates the formatter to display the user input with the specified highlight options.

displayInput() - Method in class io.github.darvil.lanat.parsing.errors.contexts.formatting.ErrorFormattingContext

Indicates the formatter to display the user input.

displayInput(DisplayInput) - Method in class io.github.darvil.lanat.parsing.errors.contexts.formatting.ErrorFormattingContext

Indicates the formatter to display the user input with the specified options.

DisplayInput - Record Class in io.github.darvil.lanat.parsing.errors.contexts.formatting

Options used to display the input.

DisplayInput() - Constructor for record class io.github.darvil.lanat.parsing.errors.contexts.formatting.DisplayInput

Instantiates a new display input with no highlight options.

DisplayInput(DisplayInput.Highlight) - Constructor for record class io.github.darvil.lanat.parsing.errors.contexts.formatting.DisplayInput

Creates an instance of a DisplayInput record class.

DisplayInput.Highlight - Record Class in io.github.darvil.lanat.parsing.errors.contexts.formatting

Options used to highlight the input.

DoubleArgumentType - Class in io.github.darvil.lanat.argtypes

An argument type that takes a double precision floating point number.

DoubleArgumentType() - Constructor for class io.github.darvil.lanat.argtypes.DoubleArgumentType

E

EnumArgumentType<T extends Enum<T>> - Class in io.github.darvil.lanat.argtypes

An argument type that takes a valid enum value.

EnumArgumentType(Class<T>) - Constructor for class io.github.darvil.lanat.argtypes.EnumArgumentType

Creates a new enum argument type.

EnumArgumentType.Default - Annotation Interface in io.github.darvil.lanat.argtypes

An annotation that specifies the default value of the enum type.

EnumArgumentType.WithName - Annotation Interface in io.github.darvil.lanat.argtypes

An annotation that specifies the name the user will have to write to select this value.

equals(Object) - Method in class io.github.darvil.lanat.Argument

Returns true if the argument specified by the given name is equal to this argument.

equals(Object) - Method in class io.github.darvil.lanat.Command

Returns true if the argument specified by the given name is equal to this argument.

equals(Object) - Method in class io.github.darvil.lanat.Group

equals(Object) - Method in record class io.github.darvil.lanat.ArgumentType.ParseStateSnapshot

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.darvil.lanat.ArgumentTypeInfer.PredicateInfer

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.darvil.lanat.CommandTemplate.CommandBuildContext

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.darvil.lanat.parsing.errors.contexts.formatting.DisplayInput

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.darvil.lanat.parsing.errors.contexts.formatting.DisplayInput.Highlight

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.IncorrectUsagesCountError

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.IncorrectValueNumberError

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.MultipleArgsInRestrictedGroupUsedError

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.RequiredArgumentNotUsedError

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.SimilarArgumentError

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.UniqueArgumentUsedError

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.UnmatchedInArgNameListError

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.UnmatchedTokenError

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.SpaceRequiredError

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.StringNotClosedError

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.TupleAlreadyOpenError

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.TupleNotClosedError

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.UnexpectedTupleCloseError

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.darvil.lanat.parsing.Token

Indicates whether some other object is "equal to" this one.

equalsByNamesAndParentCmd(T, T) - Static method in class io.github.darvil.lanat.utils.UtlMisc

Returns true if the given objects have the same names and parent command.

Error<C extends ErrorContext> - Interface in io.github.darvil.lanat.parsing.errors

An error that indicates a failure in the parsing process.

ERROR - Enum constant in enum class io.github.darvil.lanat.utils.errors.ErrorLevel

Error.ParseError - Interface in io.github.darvil.lanat.parsing.errors

A parse error.

Error.TokenizeError - Interface in io.github.darvil.lanat.parsing.errors

A tokenize error.

ErrorCallbacks<TOk,TErr> - Interface in io.github.darvil.lanat.utils.errors

Interface for classes that have error and success callbacks.

ErrorCollector - Class in io.github.darvil.lanat.parsing.errors

Handles all errors generated by the parser and tokenizer.

ErrorCollector(List<Token>, String) - Constructor for class io.github.darvil.lanat.parsing.errors.ErrorCollector

Instantiates a new errors collector.

ErrorContainer<T extends ErrorLevelProvider> - Interface in io.github.darvil.lanat.utils.errors

Represents a container of errors.

ErrorContainerImpl<T extends ErrorLevelProvider> - Class in io.github.darvil.lanat.utils.errors

A container for errors.

ErrorContainerImpl() - Constructor for class io.github.darvil.lanat.utils.errors.ErrorContainerImpl

Creates a new ErrorContainerImpl with the default values, those being ErrorLevel.ERROR for ErrorContainerImpl.errorExitThreshold and ErrorLevel.INFO for ErrorContainerImpl.errorDisplayThreshold.

ErrorContainerImpl(ModifyRecord<ErrorLevel>, ModifyRecord<ErrorLevel>) - Constructor for class io.github.darvil.lanat.utils.errors.ErrorContainerImpl

Creates a new ErrorContainerImpl with the given values.

ErrorContext - Class in io.github.darvil.lanat.parsing.errors.contexts

Base class for error contexts.

ErrorContext(Command) - Constructor for class io.github.darvil.lanat.parsing.errors.contexts.ErrorContext

Instantiates a new error context.

ErrorFormatter - Class in io.github.darvil.lanat.parsing.errors

Base class for error formatters.

ErrorFormatter(ErrorContext) - Constructor for class io.github.darvil.lanat.parsing.errors.ErrorFormatter

Instantiates a new error formatter.

errorFormatterClass - Static variable in class io.github.darvil.lanat.parsing.errors.ErrorFormatter

The error formatter class used to generate the error messages.

ErrorFormattingContext - Class in io.github.darvil.lanat.parsing.errors.contexts.formatting

Class used by error handlers to easily format errors to be displayed to the user.

ErrorFormattingContext() - Constructor for class io.github.darvil.lanat.parsing.errors.contexts.formatting.ErrorFormattingContext

ErrorLevel - Enum Class in io.github.darvil.lanat.utils.errors

Represents the multiple levels that an error can have.

ErrorLevelProvider - Interface in io.github.darvil.lanat.utils.errors

Interface for classes that have an error level.

errorValue() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.UnmatchedInArgNameListError

Returns the value of the errorValue record component.

exitIfErrors() - Method in class io.github.darvil.lanat.AfterParseOptions.AfterParseActions

Exits the program with the error code returned by AfterParseOptions.getErrorCode() if any errors occurred during parsing.

exitIfNoInput() - Method in class io.github.darvil.lanat.AfterParseOptions.AfterParseActions

Exits the program with a code of 0 if no arguments were passed to the program.

F

FileArgumentType - Class in io.github.darvil.lanat.argtypes

An argument type that takes a file path and returns a File instance representing it.

FileArgumentType(boolean) - Constructor for class io.github.darvil.lanat.argtypes.FileArgumentType

Creates a new file argument type which accepts any kind of file.

FileArgumentType(boolean, FileArgumentType.FileType) - Constructor for class io.github.darvil.lanat.argtypes.FileArgumentType

Creates a new file argument type.

FileArgumentType.FileType - Enum Class in io.github.darvil.lanat.argtypes

The type of the file.

finishParsing() - Method in class io.github.darvil.lanat.Argument

This method is called when the command is finished parsing.

FloatArgumentType - Class in io.github.darvil.lanat.argtypes

An argument type that takes a floating point number.

FloatArgumentType() - Constructor for class io.github.darvil.lanat.argtypes.FloatArgumentType

FormatTag - Class in io.github.darvil.lanat.helpgen.descriptions.tags

Changes the format of the text.

FormatTag() - Constructor for class io.github.darvil.lanat.helpgen.descriptions.tags.FormatTag

FORWARD_VALUE - Enum constant in enum class io.github.darvil.lanat.parsing.TokenType

from(Class<? extends CommandTemplate>) - Static method in class io.github.darvil.lanat.ArgumentParser

Constructs a new ArgumentParser based on the given CommandTemplate, taking Sub-Commands into account.

from(String) - Static method in class io.github.darvil.lanat.CLInput

Constructs a new CLInput from the given arguments string.

from(String[]) - Static method in class io.github.darvil.lanat.CLInput

Constructs a new CLInput from the given arguments array.

fromField(Class<? extends CommandTemplate>, String) - Static method in class io.github.darvil.lanat.ArgumentBuilder

Builds an Argument from the specified field name in the specified CommandTemplate subclass.

fromField(Field) - Static method in class io.github.darvil.lanat.ArgumentBuilder

Builds an Argument from the specified field annotated with Argument.Define.

fromFile(File) - Static method in class io.github.darvil.lanat.CLInput

Constructs a new CLInput from the given file.

FromParseableArgumentType<T extends Parseable<TInner>,TInner> - Class in io.github.darvil.lanat.argtypes

An argument type that uses a Parseable to parse values.

FromParseableArgumentType(T) - Constructor for class io.github.darvil.lanat.argtypes.FromParseableArgumentType

Creates a new argument type that uses a Parseable to parse values with a default error message of "Invalid value for type x.".

FromParseableArgumentType(T, String) - Constructor for class io.github.darvil.lanat.argtypes.FromParseableArgumentType

Creates a new argument type that uses a Parseable to parse values.

fromStandardInput() - Static method in class io.github.darvil.lanat.CLInput

Constructs a new CLInput from the standard input.

fromSystemProperty() - Static method in class io.github.darvil.lanat.CLInput

Gets the arguments passed to the program from the system property "sun.java.command".

G

generate() - Method in class io.github.darvil.lanat.parsing.errors.ErrorFormatter

Generates the final formatted error message that will be displayed to the user.

generate() - Method in class io.github.darvil.lanat.parsing.errors.formatters.PrettyErrorFormatter

generate() - Method in class io.github.darvil.lanat.parsing.errors.formatters.SimpleErrorFormatter

generate(Command) - Method in class io.github.darvil.lanat.helpgen.HelpFormatter

Generates the help message.

generate(Command) - Method in class io.github.darvil.lanat.helpgen.LayoutItem

Generates the content of the layout item.

generateInputView(TokenizeErrorContext) - Method in class io.github.darvil.lanat.parsing.errors.ErrorFormatter

Generates the input view for a tokenize error when the error is a Error.TokenizeError.

generateInputView(TokenizeErrorContext) - Method in class io.github.darvil.lanat.parsing.errors.formatters.PrettyErrorFormatter

generateInputView(TokenizeErrorContext) - Method in class io.github.darvil.lanat.parsing.errors.formatters.SimpleErrorFormatter

generateInternal(Error<?>, ErrorFormattingContext) - Method in class io.github.darvil.lanat.parsing.errors.ErrorFormatter

Generates the formatted error message for the specified error.

generateTokensView(ParseErrorContext) - Method in class io.github.darvil.lanat.parsing.errors.ErrorFormatter

Generates the tokens view for a parse error when the error is a Error.ParseError.

generateTokensView(ParseErrorContext) - Method in class io.github.darvil.lanat.parsing.errors.formatters.PrettyErrorFormatter

generateTokensView(ParseErrorContext) - Method in class io.github.darvil.lanat.parsing.errors.formatters.SimpleErrorFormatter

get(Argument<?, T>) - Method in class io.github.darvil.lanat.ParseResult

Returns the parsed value of the argument with the given name.

get(Class<?>) - Static method in class io.github.darvil.lanat.ArgumentTypeInfer

Returns a new argument type instance for the specified type.

get(String...) - Method in class io.github.darvil.lanat.ParseResult

Specify the route of Sub-Commands for reaching the argument desired.

getAbsoluteIndex() - Method in class io.github.darvil.lanat.parsing.errors.contexts.ErrorContext

Returns the absolute index of the context.

getAbsoluteIndex() - Method in class io.github.darvil.lanat.parsing.errors.contexts.ParseErrorContext

getAbsoluteIndex() - Method in class io.github.darvil.lanat.parsing.errors.contexts.TokenizeErrorContext

getAbsoluteIndex(int) - Method in class io.github.darvil.lanat.parsing.errors.contexts.ErrorContext

Returns the absolute index of the context, offset by the given index.

getArgument(String) - Method in interface io.github.darvil.lanat.utils.ArgumentAdder

Returns the argument with the given name.

getArguments() - Method in class io.github.darvil.lanat.Command

getArguments() - Method in class io.github.darvil.lanat.Group

getArguments() - Method in interface io.github.darvil.lanat.utils.ArgumentAdder

Returns a list of the arguments in this container.

getArgumentTypeFromField(Field) - Static method in class io.github.darvil.lanat.ArgumentBuilder

Returns an ArgumentType instance based on the specified field.

getArgValuesStream(String[]) - Method in class io.github.darvil.lanat.ArgumentType

Returns a stream of the values that this argument received when being parsed.

getCallbackInvocationOption() - Method in class io.github.darvil.lanat.Command

getCharacter() - Method in enum class io.github.darvil.lanat.Argument.Prefix

Returns the character that represents this prefix.

getCommand() - Method in class io.github.darvil.lanat.CommandTemplate

Returns the Command instance used by this Command Template.

getCommand() - Method in class io.github.darvil.lanat.ParseResult

Returns the Command that this ParseResult object belongs to.

getCommand() - Method in class io.github.darvil.lanat.parsing.errors.contexts.ErrorContext

Returns the command that was being parsed when the error occurred.

getCommand(String) - Method in interface io.github.darvil.lanat.utils.CommandAdder

Returns the Sub-Command with the specified name.

getCommandOf(NamedWithDescription) - Static method in class io.github.darvil.lanat.helpgen.descriptions.RouteParser

Returns the command the object belongs to.

getCommands() - Method in class io.github.darvil.lanat.Command

Returns a list of all the Sub-Commands that belong to this command.

getCommands() - Method in interface io.github.darvil.lanat.utils.CommandAdder

Returns a list of all the Sub-Commands that belong to this command.

getContent() - Method in class io.github.darvil.lanat.parsing.errors.contexts.formatting.ErrorFormattingContext

Returns the content of the error message.

getContent() - Method in class io.github.darvil.lanat.parsing.errors.ErrorFormatter

Returns the contents of the error.

getContentSingleLine() - Method in class io.github.darvil.lanat.parsing.errors.ErrorFormatter

Returns the contents of the error, with all newlines replaced with spaces.

getContentWrapped() - Method in class io.github.darvil.lanat.parsing.errors.ErrorFormatter

Returns the contents of the error, wrapped to fit HelpFormatter.getLineWrapMax().

getCount() - Method in class io.github.darvil.lanat.parsing.errors.contexts.ErrorContext

Returns the number of input values in the context.

getCount() - Method in class io.github.darvil.lanat.parsing.errors.contexts.ParseErrorContext

getCount() - Method in class io.github.darvil.lanat.parsing.errors.contexts.TokenizeErrorContext

getCurrentErrorContext() - Method in class io.github.darvil.lanat.parsing.errors.ErrorFormatter

Returns the error context.

getCurrentTokenIndex() - Method in class io.github.darvil.lanat.parsing.Parser

Returns the index of the current token that is being parsed.

getDefaultPrefix() - Static method in enum class io.github.darvil.lanat.Argument.Prefix

Returns the default prefix character.

getDefaultValue() - Method in class io.github.darvil.lanat.Argument

Returns the default value of this argument.

getDescription() - Method in class io.github.darvil.lanat.argtypes.BooleanArgumentType

getDescription() - Method in class io.github.darvil.lanat.argtypes.ByteArgumentType

getDescription() - Method in class io.github.darvil.lanat.argtypes.CounterArgumentType

getDescription() - Method in class io.github.darvil.lanat.argtypes.DoubleArgumentType

getDescription() - Method in class io.github.darvil.lanat.argtypes.FileArgumentType

getDescription() - Method in class io.github.darvil.lanat.argtypes.FloatArgumentType

getDescription() - Method in class io.github.darvil.lanat.argtypes.FromParseableArgumentType

getDescription() - Method in class io.github.darvil.lanat.argtypes.IntegerArgumentType

getDescription() - Method in class io.github.darvil.lanat.argtypes.KeyValuesArgumentType

getDescription() - Method in class io.github.darvil.lanat.argtypes.LongArgumentType

getDescription() - Method in class io.github.darvil.lanat.argtypes.NumberRangeArgumentType

getDescription() - Method in interface io.github.darvil.lanat.argtypes.Parseable

getDescription() - Method in class io.github.darvil.lanat.argtypes.ShortArgumentType

getDescription() - Method in class io.github.darvil.lanat.argtypes.SimpleArgumentType

getDescription() - Method in class io.github.darvil.lanat.argtypes.SingleValueListArgumentType

getDescription() - Method in class io.github.darvil.lanat.argtypes.StdinArgumentType

getDescription() - Method in class io.github.darvil.lanat.argtypes.StringArgumentType

getDescription() - Method in class io.github.darvil.lanat.argtypes.TryParseArgumentType

getDescription() - Method in class io.github.darvil.lanat.argtypes.TupleArgumentType

getDescription() - Method in class io.github.darvil.lanat.Argument

getDescription() - Method in class io.github.darvil.lanat.Command

getDescription() - Method in class io.github.darvil.lanat.Group

getDescription() - Method in interface io.github.darvil.lanat.utils.NamedWithDescription

Returns the description of this object.

getDescription(Argument<?, ?>, boolean) - Static method in class io.github.darvil.lanat.helpgen.ArgumentRepr

Returns the ArgumentRepr.getRepresentation(Argument, boolean) and description of the given argument like shown below:

getDescription(Command) - Static method in class io.github.darvil.lanat.helpgen.CommandRepr

Returns the parsed description of the given command.

getDescription(Group) - Static method in class io.github.darvil.lanat.helpgen.GroupRepr

Returns the name and description of the given group like shown below:

getDescriptions(Group) - Static method in class io.github.darvil.lanat.helpgen.GroupRepr

Returns the descriptions of the arguments and subgroups of the given group like shown below:

getDescriptions(List<Argument<?, ?>>, boolean) - Static method in class io.github.darvil.lanat.helpgen.ArgumentRepr

Returns the descriptions of the given arguments like shown below:

getDetails() - Method in class io.github.darvil.lanat.ArgumentParser

Returns the details of this program.

getDisplayOptions() - Method in class io.github.darvil.lanat.parsing.errors.contexts.formatting.ErrorFormattingContext

Returns the options used to display input.

getDisplayOptions() - Method in class io.github.darvil.lanat.parsing.errors.ErrorFormatter

Returns the display options for the current error.

getErrorCode() - Method in class io.github.darvil.lanat.AfterParseOptions

getErrorCode() - Method in class io.github.darvil.lanat.Command

Get the error code of this Command.

getErrorDisplayThreshold() - Method in class io.github.darvil.lanat.Argument

getErrorDisplayThreshold() - Method in interface io.github.darvil.lanat.utils.errors.ErrorContainer

Returns the threshold error level at which errors will be displayed to the user.

getErrorDisplayThreshold() - Method in class io.github.darvil.lanat.utils.errors.ErrorContainerImpl

getErrorExitThreshold() - Method in class io.github.darvil.lanat.Argument

getErrorExitThreshold() - Method in interface io.github.darvil.lanat.utils.errors.ErrorContainer

Returns the threshold error level that will cause the program to exit.

getErrorExitThreshold() - Method in class io.github.darvil.lanat.utils.errors.ErrorContainerImpl

getErrorLevel() - Method in interface io.github.darvil.lanat.parsing.errors.Error

Returns the error level of the error.

getErrorLevel() - Method in class io.github.darvil.lanat.parsing.errors.ErrorFormatter

getErrorLevel() - Method in class io.github.darvil.lanat.parsing.errors.handlers.ArgumentTypeError

getErrorLevel() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.SimilarArgumentError

getErrorLevel() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.UniqueArgumentUsedError

getErrorLevel() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.UnmatchedInArgNameListError

getErrorLevel() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.UnmatchedTokenError

getErrorLevel() - Method in class io.github.darvil.lanat.parsing.errors.handlers.SimpleError

getErrorLevel() - Method in interface io.github.darvil.lanat.utils.errors.ErrorLevelProvider

Returns the error level of the object.

getErrorLevelFormatter() - Method in class io.github.darvil.lanat.parsing.errors.ErrorFormatter

Returns a TextFormatter with the error level name, colored with the error level color.

getErrors() - Method in class io.github.darvil.lanat.AfterParseOptions

Returns a list of all the error messages that occurred during parsing.

getErrorsUnderDisplayThreshold() - Method in class io.github.darvil.lanat.Argument

getErrorsUnderDisplayThreshold() - Method in interface io.github.darvil.lanat.utils.errors.ErrorContainer

Returns a list of all the errors under the display level defined in this error container.

getErrorsUnderDisplayThreshold() - Method in class io.github.darvil.lanat.utils.errors.ErrorContainerImpl

getErrorsUnderExitThreshold() - Method in class io.github.darvil.lanat.Argument

getErrorsUnderExitThreshold() - Method in interface io.github.darvil.lanat.utils.errors.ErrorContainer

Returns a list of all the errors under the exit level defined in this error container.

getErrorsUnderExitThreshold() - Method in class io.github.darvil.lanat.utils.errors.ErrorContainerImpl

getErrorsUnderThreshold(List<TErr>, ErrorLevel) - Method in class io.github.darvil.lanat.utils.errors.ErrorContainerImpl

getFinalTokens() - Method in class io.github.darvil.lanat.parsing.Tokenizer

Returns the list of all tokens that have been tokenized.

getFinalValue() - Method in class io.github.darvil.lanat.ArgumentType

Returns the final value of this argument type.

getFormatter() - Method in record class io.github.darvil.lanat.parsing.Token

Returns a TextFormatter instance that can be used to display the token.

getForwardValue() - Method in class io.github.darvil.lanat.ParseResultRoot

Returns the forward value.

getForwardValue() - Method in class io.github.darvil.lanat.parsing.Parser

Returns the forward value if one was found.

getFromMaybeDefault(Argument.Prefix) - Static method in enum class io.github.darvil.lanat.Argument.Prefix

Returns a Argument.Prefix that can't be Argument.Prefix.DEFAULT from the given Argument.Prefix.

getFullTokenList() - Method in class io.github.darvil.lanat.Command

Get all the tokens of all Sub-Commands (the ones that we can get without errors) into one single list.

getGeneratedView() - Method in class io.github.darvil.lanat.parsing.errors.ErrorFormatter

Gets the appropriate generated view for the current error, depending on the type of the current error context.

getGenerator() - Method in class io.github.darvil.lanat.helpgen.LayoutItem

Returns the Function that generates the content of the layout item.

getGroup(String) - Method in interface io.github.darvil.lanat.utils.GroupAdder

Returns the argument group with the given name.

getGroups() - Method in class io.github.darvil.lanat.Command

getGroups() - Method in class io.github.darvil.lanat.Group

getGroups() - Method in interface io.github.darvil.lanat.utils.GroupAdder

Returns a list of the argument groups in this container.

getHelp() - Method in class io.github.darvil.lanat.Command

Generates and returns the help message of this command.

getHelpArgumentBuilder(Command, int) - Static method in class io.github.darvil.lanat.CommandTemplate.Default

Returns a 'help' argument builder which shows the help message of the command (provided by the Command.getHelp() method), and then exits the program with the given return code.

getHelpFormatter() - Method in class io.github.darvil.lanat.Command

getHighlightOptions() - Method in class io.github.darvil.lanat.parsing.errors.ErrorFormatter

Returns the highlight options for the current error if the ErrorFormatter.getDisplayOptions() are present.

getIndentSize() - Static method in class io.github.darvil.lanat.helpgen.HelpFormatter

Returns the indent size.

getIndex() - Method in class io.github.darvil.lanat.parsing.errors.handlers.ArgumentTypeError

Returns the index of the token that caused the error.

getIndexAndOffset() - Method in record class io.github.darvil.lanat.ArgumentType.ParseStateSnapshot

Returns a pair of ArgumentType.ParseStateSnapshot.tokenIndex and ArgumentType.ParseStateSnapshot.receivedValuesCount.

getInitialValue() - Method in class io.github.darvil.lanat.ArgumentType

Returns the initial value of this argument type, if specified.

getInputNear(int, int) - Method in class io.github.darvil.lanat.parsing.errors.contexts.TokenizeErrorContext

Returns a substring of the input string, centered around the given index.

getInputString() - Method in class io.github.darvil.lanat.parsing.Tokenizer

Returns the input string that is being tokenized.

getInputString(boolean) - Method in class io.github.darvil.lanat.parsing.errors.contexts.TokenizeErrorContext

Returns the input string.

getLastParseState() - Method in class io.github.darvil.lanat.ArgumentType

getLayout() - Method in class io.github.darvil.lanat.helpgen.HelpFormatter

Returns the layout of the help message.

getLineWrapMax() - Static method in class io.github.darvil.lanat.helpgen.HelpFormatter

Returns the maximum length of a line in the help message.

getMatchingArgument(char) - Method in class io.github.darvil.lanat.parsing.ParsingStateBase

Returns the argument found by the single character name specified.

getMatchingArgument(String) - Method in class io.github.darvil.lanat.parsing.ParsingStateBase

Returns the argument found by the name specified.

getName() - Method in class io.github.darvil.lanat.argtypes.FromParseableArgumentType

getName() - Method in interface io.github.darvil.lanat.argtypes.Parseable

Returns the name of this argument type.

getName() - Method in class io.github.darvil.lanat.argtypes.SimpleArgumentType

getName() - Method in class io.github.darvil.lanat.Group

getName() - Method in interface io.github.darvil.lanat.utils.MultipleNamesAndDescription

Returns the name of this object.

getName() - Method in interface io.github.darvil.lanat.utils.NamedWithDescription

Returns the name of this object.

getName(Group) - Static method in class io.github.darvil.lanat.helpgen.GroupRepr

Returns the name of the given group, formatted with bold and underline if restricted.

getNames() - Method in class io.github.darvil.lanat.Argument

getNames() - Method in class io.github.darvil.lanat.Command

getNames() - Method in interface io.github.darvil.lanat.utils.MultipleNamesAndDescription

Returns all the names of this object.

getNestingOffset() - Method in class io.github.darvil.lanat.parsing.ParsingStateBase

Returns the offset position of the input values from the previous parser.

getOffsetFromIndex() - Method in class io.github.darvil.lanat.parsing.errors.handlers.ArgumentTypeError

Returns the offset from the index, which is the number of tokens that caused the error.

getParent() - Method in class io.github.darvil.lanat.ArgumentType

getParent() - Method in class io.github.darvil.lanat.Command

getParent() - Method in class io.github.darvil.lanat.Group

getParent() - Method in interface io.github.darvil.lanat.utils.ParentElementGetter

Gets the parent object of this object.

getParentCommand() - Method in class io.github.darvil.lanat.Argument

getParentCommand() - Method in class io.github.darvil.lanat.Command

getParentCommand() - Method in class io.github.darvil.lanat.Group

getParentCommand() - Method in interface io.github.darvil.lanat.utils.CommandUser

Gets the Command object that this object belongs to.

getParentGroup() - Method in class io.github.darvil.lanat.Argument

Returns the Group that contains this argument, or null if it does not have one.

getParentGroup() - Method in class io.github.darvil.lanat.Group

getParentGroup() - Method in interface io.github.darvil.lanat.utils.GroupUser

Gets the Group object that this object belongs to.

getParsedArgsMap() - Method in class io.github.darvil.lanat.parsing.Parser

Returns a hashmap of Arguments and their corresponding parsed values.

getParseFunction() - Method in class io.github.darvil.lanat.argtypes.ByteArgumentType

getParseFunction() - Method in class io.github.darvil.lanat.argtypes.DoubleArgumentType

getParseFunction() - Method in class io.github.darvil.lanat.argtypes.FloatArgumentType

getParseFunction() - Method in class io.github.darvil.lanat.argtypes.IntegerArgumentType

getParseFunction() - Method in class io.github.darvil.lanat.argtypes.LongArgumentType

getParseFunction() - Method in class io.github.darvil.lanat.argtypes.NumberArgumentType

Returns the function that will parse a string as a number.

getParseFunction() - Method in class io.github.darvil.lanat.argtypes.ShortArgumentType

getParser() - Method in class io.github.darvil.lanat.Command

Returns the current parser of this command.

getParseResult() - Method in class io.github.darvil.lanat.CommandTemplate

Returns the ParseResult instance used by this Command Template.

getPositionalArguments() - Method in class io.github.darvil.lanat.Command

Returns a list of all the positional arguments of this command.

getPredicateInfers() - Static method in class io.github.darvil.lanat.ArgumentTypeInfer

Returns a list of all the predicate infers that are registered.

getPrefix() - Method in class io.github.darvil.lanat.Argument

Returns the prefix of this argument.

getRepresentation() - Method in class io.github.darvil.lanat.argtypes.ActionArgumentType

getRepresentation() - Method in class io.github.darvil.lanat.argtypes.BooleanArgumentType

getRepresentation() - Method in class io.github.darvil.lanat.argtypes.CounterArgumentType

getRepresentation() - Method in class io.github.darvil.lanat.argtypes.FileArgumentType

getRepresentation() - Method in class io.github.darvil.lanat.argtypes.FromParseableArgumentType

getRepresentation() - Method in class io.github.darvil.lanat.argtypes.KeyValuesArgumentType

getRepresentation() - Method in class io.github.darvil.lanat.argtypes.NumberRangeArgumentType

getRepresentation() - Method in interface io.github.darvil.lanat.argtypes.Parseable

Returns the representation of this parseable type.

getRepresentation() - Method in class io.github.darvil.lanat.argtypes.SimpleArgumentType

getRepresentation() - Method in class io.github.darvil.lanat.argtypes.SingleValueListArgumentType

getRepresentation() - Method in class io.github.darvil.lanat.argtypes.StdinArgumentType

getRepresentation() - Method in class io.github.darvil.lanat.argtypes.StringArgumentType

getRepresentation() - Method in class io.github.darvil.lanat.argtypes.TupleArgumentType

getRepresentation(Argument<?, ?>, boolean) - Static method in class io.github.darvil.lanat.helpgen.ArgumentRepr

Returns the representation of the given argument like shown below:

getRepresentation(Command) - Static method in class io.github.darvil.lanat.helpgen.CommandRepr

Returns the representation of the given command like shown below:

getRepresentation(Group) - Static method in class io.github.darvil.lanat.helpgen.GroupRepr

Returns the representation of the given group like shown below:

getRepresentation(NamedWithDescription) - Static method in class io.github.darvil.lanat.helpgen.HelpFormatter

Returns the representation of the object specified.

getRepresentationColor() - Method in class io.github.darvil.lanat.Argument

The color that will be used to represent this argument in the help message.

getResult() - Method in class io.github.darvil.lanat.AfterParseOptions

Returns a ParseResultRoot object that contains all the parsed arguments.

getRoot() - Method in interface io.github.darvil.lanat.utils.ParentElementGetter

Gets the root object in the hierarchy it belongs to.

getRootCommandToken() - Method in class io.github.darvil.lanat.parsing.errors.contexts.ParseErrorContext

Returns a token representing the root command.

getSubCommandsDescriptions(Command) - Static method in class io.github.darvil.lanat.helpgen.CommandRepr

Returns the name and representation of the Sub-Commands of the given command like shown below:

getSubCommandsRepresentation(Command) - Static method in class io.github.darvil.lanat.helpgen.CommandRepr

Returns the CommandRepr.getRepresentation(Command) of the Sub-Commands of the given command like shown below:

getSubResult(String) - Method in class io.github.darvil.lanat.ParseResult

Returns the sub ParseResult with the given name.

getTagNameFromTagClass(Class<? extends Tag>) - Static method in class io.github.darvil.lanat.helpgen.descriptions.Tag

Returns the name of the tag class.

getTemplateNames(Class<? extends CommandTemplate>) - Static method in class io.github.darvil.lanat.CommandTemplate

Returns the names of the command template.

getTokenAt(int) - Method in class io.github.darvil.lanat.parsing.errors.contexts.ParseErrorContext

Returns the token at the given index.

getTokenizedCommands() - Method in class io.github.darvil.lanat.parsing.Tokenizer

Returns a list of all tokenized Sub-Commands children of ParsingStateBase.command.

getTokenizedSubCommand() - Method in class io.github.darvil.lanat.parsing.Tokenizer

Returns the tokenized Sub-Command of ParsingStateBase.command.

getTokenizer() - Method in class io.github.darvil.lanat.Command

Returns the current tokenizer of this command.

getTokens(boolean) - Method in class io.github.darvil.lanat.parsing.errors.contexts.ParseErrorContext

Returns a list of the tokens.

getTokensInRange(Range) - Method in class io.github.darvil.lanat.parsing.errors.contexts.ParseErrorContext

Returns a list of all the tokens in the given range (inclusive).

getUsageCount() - Method in class io.github.darvil.lanat.Argument

The number of times this argument has been used in a command during parsing.

getUsageCountBounds() - Method in class io.github.darvil.lanat.argtypes.CounterArgumentType

getUsageCountBounds() - Method in class io.github.darvil.lanat.argtypes.FromParseableArgumentType

getUsageCountBounds() - Method in interface io.github.darvil.lanat.argtypes.Parseable

Specifies the number of times this argument type can be used during parsing.

getUsageCountBounds() - Method in class io.github.darvil.lanat.argtypes.SimpleArgumentType

getUsedResults() - Method in class io.github.darvil.lanat.ParseResultRoot

Returns a list of all the ParseResult objects that belong to a command that was used by the user.

getValue() - Method in class io.github.darvil.lanat.ArgumentType

Returns the current value of this argument type.

getValueCountBounds() - Method in class io.github.darvil.lanat.argtypes.ActionArgumentType

getValueCountBounds() - Method in class io.github.darvil.lanat.argtypes.BooleanArgumentType

getValueCountBounds() - Method in class io.github.darvil.lanat.argtypes.CounterArgumentType

getValueCountBounds() - Method in class io.github.darvil.lanat.argtypes.FromParseableArgumentType

getValueCountBounds() - Method in class io.github.darvil.lanat.argtypes.KeyValuesArgumentType

getValueCountBounds() - Method in interface io.github.darvil.lanat.argtypes.Parseable

Specifies the number of values that this parser should receive when calling Parseable.parseValues(String[]).

getValueCountBounds() - Method in class io.github.darvil.lanat.argtypes.SimpleArgumentType

getValueCountBounds() - Method in class io.github.darvil.lanat.argtypes.StdinArgumentType

getValueCountBounds() - Method in class io.github.darvil.lanat.argtypes.TupleArgumentType

getVersion() - Method in class io.github.darvil.lanat.ArgumentParser

Returns the version of this program.

getVersionArgumentBuilder(ArgumentParser, int) - Static method in class io.github.darvil.lanat.CommandTemplate.Default

Returns a 'version' argument builder which shows the version of the program (provided by the ArgumentParser.getVersion() method), and then exits the program with the given return code.

group() - Element in annotation interface io.github.darvil.lanat.Argument.Define

The name of the group this argument will be added to; in the case the named group does not exist then it will be created.

group() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.MultipleArgsInRestrictedGroupUsedError

Returns the value of the group record component.

Group - Class in io.github.darvil.lanat

Argument Group

Group(String) - Constructor for class io.github.darvil.lanat.Group

Creates a new Argument Group with the given name and no description.

Group(String, String) - Constructor for class io.github.darvil.lanat.Group

Creates a new Argument Group with the given name and description.

GroupAdder - Interface in io.github.darvil.lanat.utils

An interface for objects that can add Groups to themselves.

GroupAlreadyExistsException - Exception in io.github.darvil.lanat.exceptions

Thrown when an Group is added to a container that already contains an Group with the same name.

GroupAlreadyExistsException(Group, T) - Constructor for exception io.github.darvil.lanat.exceptions.GroupAlreadyExistsException

GroupNotFoundException - Exception in io.github.darvil.lanat.exceptions

Thrown when an Group is not found.

GroupNotFoundException(Group) - Constructor for exception io.github.darvil.lanat.exceptions.GroupNotFoundException

GroupNotFoundException(String) - Constructor for exception io.github.darvil.lanat.exceptions.GroupNotFoundException

GroupRepr - Class in io.github.darvil.lanat.helpgen

Contains methods for generating the help representations of Groups.

GroupUser - Interface in io.github.darvil.lanat.utils

This interface is used for objects that belong to an Group.

H

handle(ErrorFormattingContext, ParseErrorContext) - Method in class io.github.darvil.lanat.parsing.errors.handlers.ArgumentTypeError

handle(ErrorFormattingContext, ParseErrorContext) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.IncorrectUsagesCountError

handle(ErrorFormattingContext, ParseErrorContext) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.IncorrectValueNumberError

handle(ErrorFormattingContext, ParseErrorContext) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.MultipleArgsInRestrictedGroupUsedError

handle(ErrorFormattingContext, ParseErrorContext) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.RequiredArgumentNotUsedError

handle(ErrorFormattingContext, ParseErrorContext) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.SimilarArgumentError

handle(ErrorFormattingContext, ParseErrorContext) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.UniqueArgumentUsedError

handle(ErrorFormattingContext, ParseErrorContext) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.UnmatchedInArgNameListError

handle(ErrorFormattingContext, ParseErrorContext) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.UnmatchedTokenError

handle(ErrorFormattingContext, ParseErrorContext) - Method in class io.github.darvil.lanat.parsing.errors.handlers.SimpleError

handle(ErrorFormattingContext, TokenizeErrorContext) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.SpaceRequiredError

handle(ErrorFormattingContext, TokenizeErrorContext) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.StringNotClosedError

handle(ErrorFormattingContext, TokenizeErrorContext) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.TupleAlreadyOpenError

handle(ErrorFormattingContext, TokenizeErrorContext) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.TupleNotClosedError

handle(ErrorFormattingContext, TokenizeErrorContext) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.UnexpectedTupleCloseError

handle(ErrorFormattingContext, C) - Method in interface io.github.darvil.lanat.parsing.errors.Error

Formats the error message to be displayed to the user.

handleErrors() - Method in class io.github.darvil.lanat.parsing.errors.ErrorCollector

Handles all the errors that were collected.

hasArgument(String) - Method in interface io.github.darvil.lanat.utils.ArgumentAdder

Checks if this container has an argument with the given name.

hasCommand(String) - Method in interface io.github.darvil.lanat.utils.CommandAdder

Returns true if this object has a Sub-Command with the specified name.

hasDisplayErrors() - Method in class io.github.darvil.lanat.Argument

hasDisplayErrors() - Method in class io.github.darvil.lanat.Command

hasDisplayErrors() - Method in interface io.github.darvil.lanat.utils.errors.ErrorContainer

Returns true if there are errors under the display level defined in this error container.

hasDisplayErrors() - Method in class io.github.darvil.lanat.utils.errors.ErrorContainerImpl

hasErrors() - Method in class io.github.darvil.lanat.AfterParseOptions

Returns whether any errors occurred during parsing.

hasExitErrors() - Method in class io.github.darvil.lanat.Argument

hasExitErrors() - Method in class io.github.darvil.lanat.Command

hasExitErrors() - Method in interface io.github.darvil.lanat.utils.errors.ErrorContainer

Returns true if there are errors under the exit level defined in this error container.

hasExitErrors() - Method in class io.github.darvil.lanat.utils.errors.ErrorContainerImpl

hasFinished - Variable in class io.github.darvil.lanat.parsing.ParsingStateBase

Whether the parsing/tokenizing has finished.

hasFinished() - Method in class io.github.darvil.lanat.parsing.ParsingStateBase

Returns true if the parsing of the input has finished, false otherwise.

hasGroup(String) - Method in interface io.github.darvil.lanat.utils.GroupAdder

Checks if this container has an argument group with the given name.

hashCode() - Method in record class io.github.darvil.lanat.ArgumentType.ParseStateSnapshot

Returns a hash code value for this object.

hashCode() - Method in record class io.github.darvil.lanat.ArgumentTypeInfer.PredicateInfer

Returns a hash code value for this object.

hashCode() - Method in record class io.github.darvil.lanat.CommandTemplate.CommandBuildContext

Returns a hash code value for this object.

hashCode() - Method in record class io.github.darvil.lanat.parsing.errors.contexts.formatting.DisplayInput

Returns a hash code value for this object.

hashCode() - Method in record class io.github.darvil.lanat.parsing.errors.contexts.formatting.DisplayInput.Highlight

Returns a hash code value for this object.

hashCode() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.IncorrectUsagesCountError

Returns a hash code value for this object.

hashCode() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.IncorrectValueNumberError

Returns a hash code value for this object.

hashCode() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.MultipleArgsInRestrictedGroupUsedError

Returns a hash code value for this object.

hashCode() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.RequiredArgumentNotUsedError

Returns a hash code value for this object.

hashCode() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.SimilarArgumentError

Returns a hash code value for this object.

hashCode() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.UniqueArgumentUsedError

Returns a hash code value for this object.

hashCode() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.UnmatchedInArgNameListError

Returns a hash code value for this object.

hashCode() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.UnmatchedTokenError

Returns a hash code value for this object.

hashCode() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.SpaceRequiredError

Returns a hash code value for this object.

hashCode() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.StringNotClosedError

Returns a hash code value for this object.

hashCode() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.TupleAlreadyOpenError

Returns a hash code value for this object.

hashCode() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.TupleNotClosedError

Returns a hash code value for this object.

hashCode() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.UnexpectedTupleCloseError

Returns a hash code value for this object.

hashCode() - Method in record class io.github.darvil.lanat.parsing.Token

Returns a hash code value for this object.

hasName(String) - Method in interface io.github.darvil.lanat.utils.MultipleNamesAndDescription

Checks if this object has the given name.

hasReceivedInput() - Method in class io.github.darvil.lanat.AfterParseOptions

Returns whether any input was received during parsing.

heading(String) - Static method in class io.github.darvil.lanat.helpgen.LayoutGenerators

Shows a heading with the given content, centered and surrounded by dashes.

heading(String, char) - Static method in class io.github.darvil.lanat.helpgen.LayoutGenerators

HelpFormatter - Class in io.github.darvil.lanat.helpgen

Manager for generating the help message of a command.

HelpFormatter() - Constructor for class io.github.darvil.lanat.helpgen.HelpFormatter

Creates a new HelpFormatter, initializing the layout.

highlight() - Method in record class io.github.darvil.lanat.parsing.errors.contexts.formatting.DisplayInput

Returns the value of the highlight record component.

Highlight(int) - Constructor for record class io.github.darvil.lanat.parsing.errors.contexts.formatting.DisplayInput.Highlight

Instantiates a new highlight options object.

Highlight(int, boolean) - Constructor for record class io.github.darvil.lanat.parsing.errors.contexts.formatting.DisplayInput.Highlight

Instantiates a new highlight options object.

Highlight(int, int, boolean) - Constructor for record class io.github.darvil.lanat.parsing.errors.contexts.formatting.DisplayInput.Highlight

Instantiates a new highlight options object.

Highlight(Pair<Integer, Integer>, boolean) - Constructor for record class io.github.darvil.lanat.parsing.errors.contexts.formatting.DisplayInput.Highlight

Instantiates a new highlight options object.

Highlight(Range, boolean) - Constructor for record class io.github.darvil.lanat.parsing.errors.contexts.formatting.DisplayInput.Highlight

Creates an instance of a Highlight record class.

I

IncompatibleCommandTemplateTypeException - Exception in io.github.darvil.lanat.exceptions

Thrown when a type of field inside a CommandTemplate is incompatible with the type returned by the argument type inner value.

IncompatibleCommandTemplateTypeException(String) - Constructor for exception io.github.darvil.lanat.exceptions.IncompatibleCommandTemplateTypeException

IncorrectUsagesCountError(Pair<Integer, Integer>, Argument<?, ?>) - Constructor for record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.IncorrectUsagesCountError

Creates an instance of a IncorrectUsagesCountError record class.

IncorrectValueNumberError(int, Argument<?, ?>, int, boolean, boolean) - Constructor for record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.IncorrectValueNumberError

Creates an instance of a IncorrectValueNumberError record class.

indent(String) - Static method in class io.github.darvil.lanat.helpgen.HelpFormatter

Indents a string by the indent size specified in HelpFormatter.getIndentSize().

index() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.IncorrectValueNumberError

Returns the value of the index record component.

index() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.SimilarArgumentError

Returns the value of the index record component.

index() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.UnmatchedInArgNameListError

Returns the value of the index record component.

index() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.UnmatchedTokenError

Returns the value of the index record component.

index() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.SpaceRequiredError

Returns the value of the index record component.

index() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.StringNotClosedError

Returns the value of the index record component.

index() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.TupleAlreadyOpenError

Returns the value of the index record component.

index() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.TupleNotClosedError

Returns the value of the index record component.

index() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.UnexpectedTupleCloseError

Returns the value of the index record component.

indexAndOffset() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.IncorrectUsagesCountError

Returns the value of the indexAndOffset record component.

indexAndOffset() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.MultipleArgsInRestrictedGroupUsedError

Returns the value of the indexAndOffset record component.

indexAndOffset() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.UniqueArgumentUsedError

Returns the value of the indexAndOffset record component.

INFO - Enum constant in enum class io.github.darvil.lanat.utils.errors.ErrorLevel

inheritProperties(Command) - Method in class io.github.darvil.lanat.ArgumentType

inheritProperties(Command) - Method in class io.github.darvil.lanat.Command

inheritProperties(T) - Method in interface io.github.darvil.lanat.utils.PostCreationInheritor

Inherits certain properties from another object, only if they are not already set to something.

initLayout() - Method in class io.github.darvil.lanat.helpgen.HelpFormatter

Initializes the layout of the help message.

IntegerArgumentType - Class in io.github.darvil.lanat.argtypes

An argument type that takes an integer number.

IntegerArgumentType() - Constructor for class io.github.darvil.lanat.argtypes.IntegerArgumentType

into(Class<T>) - Method in class io.github.darvil.lanat.AfterParseOptions

Instantiates the given Command Template class and sets all the fields annotated with Argument.Define corresponding to their respective parsed arguments.

inTuple() - Method in record class io.github.darvil.lanat.ArgumentType.ParseStateSnapshot

Returns the value of the inTuple record component.

InvalidRouteException - Exception in io.github.darvil.lanat.helpgen.descriptions.exceptions

Thrown when a parsed route is invalid.

InvalidRouteException(NamedWithDescription, String) - Constructor for exception io.github.darvil.lanat.helpgen.descriptions.exceptions.InvalidRouteException

InvalidRouteException(NamedWithDescription, String, String) - Constructor for exception io.github.darvil.lanat.helpgen.descriptions.exceptions.InvalidRouteException

InvalidRouteException(String) - Constructor for exception io.github.darvil.lanat.helpgen.descriptions.exceptions.InvalidRouteException

invokeCallbacks() - Method in class io.github.darvil.lanat.Argument

NOTE: Only invokes the error callback! Use Argument.invokeCallbacks(Object) for invoking both.

invokeCallbacks() - Method in class io.github.darvil.lanat.Command

invokeCallbacks() - Method in interface io.github.darvil.lanat.utils.errors.ErrorCallbacks

Executes the correct or error callback.

io.github.darvil.lanat - module io.github.darvil.lanat

io.github.darvil.lanat - package io.github.darvil.lanat

io.github.darvil.lanat.argtypes - package io.github.darvil.lanat.argtypes

io.github.darvil.lanat.exceptions - package io.github.darvil.lanat.exceptions

io.github.darvil.lanat.helpgen - package io.github.darvil.lanat.helpgen

io.github.darvil.lanat.helpgen.descriptions - package io.github.darvil.lanat.helpgen.descriptions

io.github.darvil.lanat.helpgen.descriptions.exceptions - package io.github.darvil.lanat.helpgen.descriptions.exceptions

io.github.darvil.lanat.helpgen.descriptions.tags - package io.github.darvil.lanat.helpgen.descriptions.tags

io.github.darvil.lanat.parsing - package io.github.darvil.lanat.parsing

io.github.darvil.lanat.parsing.errors - package io.github.darvil.lanat.parsing.errors

io.github.darvil.lanat.parsing.errors.contexts - package io.github.darvil.lanat.parsing.errors.contexts

io.github.darvil.lanat.parsing.errors.contexts.formatting - package io.github.darvil.lanat.parsing.errors.contexts.formatting

io.github.darvil.lanat.parsing.errors.formatters - package io.github.darvil.lanat.parsing.errors.formatters

io.github.darvil.lanat.parsing.errors.handlers - package io.github.darvil.lanat.parsing.errors.handlers

io.github.darvil.lanat.utils - package io.github.darvil.lanat.utils

io.github.darvil.lanat.utils.errors - package io.github.darvil.lanat.utils.errors

isArgumentSpecifier() - Method in enum class io.github.darvil.lanat.parsing.TokenType

Returns true if this token type represents an argument specifier.

isEmpty() - Method in class io.github.darvil.lanat.CLInput

Returns true if no arguments were passed to the program.

isEmpty() - Method in class io.github.darvil.lanat.Group

Returns true if this group has no arguments and no subgroups.

isInArgNameList() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.IncorrectValueNumberError

Returns the value of the isInArgNameList record component.

isInThreshold(ErrorLevel) - Method in enum class io.github.darvil.lanat.utils.errors.ErrorLevel

Returns whether this error level is under the given threshold.

isInTuple() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.IncorrectValueNumberError

Returns the value of the isInTuple record component.

isOrphan() - Method in class io.github.darvil.lanat.Argument

Returns true if this argument is not part of any command or group.

isPositional() - Method in class io.github.darvil.lanat.Argument

Returns true if this argument is positional.

isRequired() - Method in class io.github.darvil.lanat.Argument

Returns true if this argument is required.

isRestricted() - Method in class io.github.darvil.lanat.Group

Returns true if this group is restricted.

isRoot() - Method in class io.github.darvil.lanat.ArgumentParser

isRoot() - Method in interface io.github.darvil.lanat.utils.ParentElementGetter

Checks if this object is the root object in the hierarchy it belongs to.

isSamePrefix() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.SimilarArgumentError

Returns the value of the isSamePrefix record component.

isTuple() - Method in enum class io.github.darvil.lanat.parsing.TokenType

Returns true if this token type represents a tuple.

isUnique() - Method in class io.github.darvil.lanat.Argument

Returns true if this argument has priority over other arguments, even if they are required.

isValue() - Method in enum class io.github.darvil.lanat.parsing.TokenType

Returns true if this token type represents a value.

isVisible() - Method in class io.github.darvil.lanat.Argument

Returns true if this argument is visible.

K

KeyValuesArgumentType<Type extends ArgumentType<TInner>,TInner> - Class in io.github.darvil.lanat.argtypes

An argument type that takes key-value pairs.

KeyValuesArgumentType(Type) - Constructor for class io.github.darvil.lanat.argtypes.KeyValuesArgumentType

Creates a new key-values argument type.

L

LanatException - Exception in io.github.darvil.lanat.exceptions

Thrown when an error occurs in Lanat.

LanatException(String) - Constructor for exception io.github.darvil.lanat.exceptions.LanatException

LanatException(String, Throwable) - Constructor for exception io.github.darvil.lanat.exceptions.LanatException

last(List<T>) - Static method in class io.github.darvil.lanat.utils.UtlMisc

Returns the last element of the given list.

LayoutGenerators - Class in io.github.darvil.lanat.helpgen

This contains methods that may be used in LayoutItems to generate the content of the help message.

LayoutItem - Class in io.github.darvil.lanat.helpgen

Represents a layout item in the help message generated by HelpFormatter.

LINE_WRAP_DEFAULT - Static variable in class io.github.darvil.lanat.helpgen.HelpFormatter

The default maximum length of a line in the help message.

LinkTag - Class in io.github.darvil.lanat.helpgen.descriptions.tags

Gets the representation of the target object specified by the route.

LinkTag() - Constructor for class io.github.darvil.lanat.helpgen.descriptions.tags.LinkTag

listValues - Variable in class io.github.darvil.lanat.argtypes.SingleValueListArgumentType

The list of values that the argument type will accept.

listValuesStr - Variable in class io.github.darvil.lanat.argtypes.SingleValueListArgumentType

The list of string representations for the values.

LongArgumentType - Class in io.github.darvil.lanat.argtypes

An argument type that takes a long integer number.

LongArgumentType() - Constructor for class io.github.darvil.lanat.argtypes.LongArgumentType

M

MalformedTagException - Exception in io.github.darvil.lanat.helpgen.descriptions.exceptions

Thrown when a tag is malformed.

MalformedTagException(Class<? extends Tag>, String) - Constructor for exception io.github.darvil.lanat.helpgen.descriptions.exceptions.MalformedTagException

MalformedTagException(String) - Constructor for exception io.github.darvil.lanat.helpgen.descriptions.exceptions.MalformedTagException

MINUS - Enum constant in enum class io.github.darvil.lanat.Argument.Prefix

The minus sign (-).

moveLayoutItem(int, int) - Method in class io.github.darvil.lanat.helpgen.HelpFormatter

Moves a LayoutItem from one position to another and returns the moved item.

MultipleArgsInRestrictedGroupUsedError(Pair<Integer, Integer>, Group) - Constructor for record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.MultipleArgsInRestrictedGroupUsedError

Creates an instance of a MultipleArgsInRestrictedGroupUsedError record class.

MultipleNamesAndDescription - Interface in io.github.darvil.lanat.utils

Represents an object that has multiple names and a description.

N

name() - Method in record class io.github.darvil.lanat.ArgumentTypeInfer.PredicateInfer

Returns the value of the name record component.

NamedWithDescription - Interface in io.github.darvil.lanat.utils

Represents an object that has a name and a description.

names() - Element in annotation interface io.github.darvil.lanat.Argument.Define

names() - Element in annotation interface io.github.darvil.lanat.Command.Define

names(String...) - Method in class io.github.darvil.lanat.ArgumentBuilder

nestingOffset - Variable in class io.github.darvil.lanat.parsing.ParsingStateBase

The offset position of the input values from the previous parser.

NO_ERROR_IN_ALL_COMMANDS - Enum constant in enum class io.github.darvil.lanat.Command.CallbackInvocationOption

The callback will only be invoked when there are no errors in the whole command tree.

NO_ERROR_IN_ARGUMENT - Enum constant in enum class io.github.darvil.lanat.Command.CallbackInvocationOption

The callback will only be invoked when there are no errors in the argument.

NO_ERROR_IN_COMMAND - Enum constant in enum class io.github.darvil.lanat.Command.CallbackInvocationOption

The callback will only be invoked when there are no errors in the command it belongs to.

NO_ERROR_IN_COMMAND_AND_SUBCOMMANDS - Enum constant in enum class io.github.darvil.lanat.Command.CallbackInvocationOption

The callback will only be invoked when there are no errors in the command it belongs to, and all its Sub-Commands.

NoDescriptionDefinedException - Exception in io.github.darvil.lanat.helpgen.descriptions.exceptions

Thrown when a description was not defined for an object.

NoDescriptionDefinedException(NamedWithDescription) - Constructor for exception io.github.darvil.lanat.helpgen.descriptions.exceptions.NoDescriptionDefinedException

NumberArgumentType<T extends Number> - Class in io.github.darvil.lanat.argtypes

An abstract class for argument types that are numbers.

NumberArgumentType() - Constructor for class io.github.darvil.lanat.argtypes.NumberArgumentType

NumberRangeArgumentType<T extends Number & Comparable<T>> - Class in io.github.darvil.lanat.argtypes

An argument type that is a number between a minimum and maximum value.

NumberRangeArgumentType(T, T) - Constructor for class io.github.darvil.lanat.argtypes.NumberRangeArgumentType

Creates a new number range argument type.

O

ObjectAlreadyExistsException - Exception in io.github.darvil.lanat.exceptions

Thrown when an object is added to a container that already contains an object equal to the added one.

ObjectAlreadyExistsException(String, NamedWithDescription, NamedWithDescription) - Constructor for exception io.github.darvil.lanat.exceptions.ObjectAlreadyExistsException

ObjectNotFoundException - Exception in io.github.darvil.lanat.exceptions

Thrown when an object is not found.

ObjectNotFoundException(String, NamedWithDescription) - Constructor for exception io.github.darvil.lanat.exceptions.ObjectNotFoundException

ObjectNotFoundException(String, NamedWithDescription, NamedWithDescription) - Constructor for exception io.github.darvil.lanat.exceptions.ObjectNotFoundException

ObjectNotFoundException(String, String) - Constructor for exception io.github.darvil.lanat.exceptions.ObjectNotFoundException

of(SimpleArgumentType.ParseFunction<T>) - Static method in class io.github.darvil.lanat.argtypes.SimpleArgumentType

Creates a new SimpleArgumentType with the specified parse function.

of(String) - Static method in class io.github.darvil.lanat.helpgen.LayoutItem

Creates a new LayoutItem with the given String as content.

of(Function<Command, String>) - Static method in class io.github.darvil.lanat.helpgen.LayoutItem

Creates a new LayoutItem with the given Function that generates a String for a given Command.

of(Supplier<String>) - Static method in class io.github.darvil.lanat.helpgen.LayoutItem

Creates a new LayoutItem with the given Supplier that generates a String.

offsetIndex(int) - Method in class io.github.darvil.lanat.parsing.errors.handlers.ArgumentTypeError

Offsets the index by the given positive amount.

onErr(Consumer<Argument<Type, TInner>>) - Method in class io.github.darvil.lanat.ArgumentBuilder

onOk(Consumer<TInner>) - Method in class io.github.darvil.lanat.ArgumentBuilder

onSubTypeError(ArgumentTypeError) - Method in class io.github.darvil.lanat.ArgumentType

This is called when a subtype of this argument type has an error.

onUsed(ParseResult) - Method in class io.github.darvil.lanat.CommandTemplate

Called when the Command of this Template is used in the command line.

open - Variable in enum class io.github.darvil.lanat.TupleChar

OptListArgumentType - Class in io.github.darvil.lanat.argtypes

An argument type that restricts a possible value out of a list of values.

OptListArgumentType(String...) - Constructor for class io.github.darvil.lanat.argtypes.OptListArgumentType

Creates a new optional list argument type.

OptListArgumentType(List<String>) - Constructor for class io.github.darvil.lanat.argtypes.OptListArgumentType

Creates a new optional list argument type.

OptListArgumentType(List<String>, String) - Constructor for class io.github.darvil.lanat.argtypes.OptListArgumentType

Creates a new optional list argument type.

P

ParentElementGetter<T extends ParentElementGetter<T>> - Interface in io.github.darvil.lanat.utils

This interface is used for getting the parent object of an object.

PARENTHESIS - Enum constant in enum class io.github.darvil.lanat.TupleChar

parse(CLInput) - Method in class io.github.darvil.lanat.ArgumentParser

Parses the given command line arguments and returns a AfterParseOptions object.

parse(NamedWithDescription, String) - Static method in class io.github.darvil.lanat.helpgen.descriptions.DescriptionParser

Parses desc within the context of user and replaces all tags with the content generated by them.

parse(NamedWithDescription, String) - Static method in class io.github.darvil.lanat.helpgen.descriptions.RouteParser

Parses a route and returns the object it points to.

parse(NamedWithDescription, String) - Method in class io.github.darvil.lanat.helpgen.descriptions.Tag

This method will parse the tag value and return the parsed value.

parse(NamedWithDescription, String) - Method in class io.github.darvil.lanat.helpgen.descriptions.tags.ColorTag

parse(NamedWithDescription, String) - Method in class io.github.darvil.lanat.helpgen.descriptions.tags.DefaultValueTag

parse(NamedWithDescription, String) - Method in class io.github.darvil.lanat.helpgen.descriptions.tags.DescTag

parse(NamedWithDescription, String) - Method in class io.github.darvil.lanat.helpgen.descriptions.tags.FormatTag

parse(NamedWithDescription, String) - Method in class io.github.darvil.lanat.helpgen.descriptions.tags.LinkTag

parse(String[], SimpleArgumentType.ErrorProxy) - Method in interface io.github.darvil.lanat.argtypes.SimpleArgumentType.ParseFunction

Parses the received values and returns the result.

parse(T) - Static method in class io.github.darvil.lanat.helpgen.descriptions.DescriptionParser

Parses the description of the given user and replaces all tags with the content generated by them.

Parseable<T> - Interface in io.github.darvil.lanat.argtypes

The basic interface for all argument types.

parseAndUpdateValue(ArgumentType.ParseStateSnapshot, String...) - Method in class io.github.darvil.lanat.ArgumentType

Saves the specified tokenIndex and the number of values received, and then parses the values.

ParseErrorContext - Class in io.github.darvil.lanat.parsing.errors.contexts

Context for parse errors.

ParseErrorContext(Command, List<Token>) - Constructor for class io.github.darvil.lanat.parsing.errors.contexts.ParseErrorContext

Instantiates a new parse error context.

ParseErrors - Class in io.github.darvil.lanat.parsing.errors.handlers

Contains all the errors definitions for errors that occur during parsing.

ParseErrors.IncorrectUsagesCountError - Record Class in io.github.darvil.lanat.parsing.errors.handlers

Error that occurs when an argument is used an incorrect amount of times.

ParseErrors.IncorrectValueNumberError - Record Class in io.github.darvil.lanat.parsing.errors.handlers

Error that occurs when an argument receives an incorrect number of values.

ParseErrors.MultipleArgsInRestrictedGroupUsedError - Record Class in io.github.darvil.lanat.parsing.errors.handlers

Error that occurs when multiple arguments in a restricted group are used.

ParseErrors.RequiredArgumentNotUsedError - Record Class in io.github.darvil.lanat.parsing.errors.handlers

Error that occurs when an argument that is required is not used.

ParseErrors.SimilarArgumentError - Record Class in io.github.darvil.lanat.parsing.errors.handlers

Warning that occurs when the contents of a token are found to be similar to the name of an argument.

ParseErrors.UniqueArgumentUsedError - Record Class in io.github.darvil.lanat.parsing.errors.handlers

Error that occurs when an argument is used while there's a unique argument that has been used.

ParseErrors.UnmatchedInArgNameListError - Record Class in io.github.darvil.lanat.parsing.errors.handlers

Warning that occurs when an argument name list receives a value for an argument that does not take any values.

ParseErrors.UnmatchedTokenError - Record Class in io.github.darvil.lanat.parsing.errors.handlers

Warning that occurs when a token in the input does not match any argument, argument list, value, or command.

parseFromInto(Class<T>, CLInput) - Static method in class io.github.darvil.lanat.ArgumentParser

Constructs a new ArgumentParser based on the given CommandTemplate, parses the given input, and populates the template with the parsed values.

parseFromInto(Class<T>, CLInput, Consumer<AfterParseOptions.AfterParseActions>) - Static method in class io.github.darvil.lanat.ArgumentParser

Constructs a new ArgumentParser based on the given CommandTemplate, parses the given input, and populates the template with the parsed values.

parseFromInto(Class<T>, String[]) - Static method in class io.github.darvil.lanat.ArgumentParser

Constructs a new ArgumentParser based on the given CommandTemplate, parses the given input, and populates the template with the parsed values.

Parser - Class in io.github.darvil.lanat.parsing

Parses the tokens that have been tokenized from the CLI input.

Parser(Command) - Constructor for class io.github.darvil.lanat.parsing.Parser

ParseResult - Class in io.github.darvil.lanat

Container for all the parsed arguments and their respective values.

ParseResultRoot - Class in io.github.darvil.lanat

Container for all the parsed arguments and their respective values.

ParseStateSnapshot(int, int, boolean, boolean) - Constructor for record class io.github.darvil.lanat.ArgumentType.ParseStateSnapshot

Creates an instance of a ParseStateSnapshot record class.

parseTokens(Parser) - Method in class io.github.darvil.lanat.parsing.Parser

Parses the tokens that have been set.

parseValues(String[]) - Method in class io.github.darvil.lanat.argtypes.FileArgumentType

parseValues(String[]) - Method in class io.github.darvil.lanat.argtypes.FromParseableArgumentType

parseValues(String[]) - Method in class io.github.darvil.lanat.argtypes.NumberArgumentType

parseValues(String...) - Method in class io.github.darvil.lanat.argtypes.NumberRangeArgumentType

parseValues(String...) - Method in interface io.github.darvil.lanat.argtypes.Parseable

Parses the received values and returns the result.

parseValues(String...) - Method in class io.github.darvil.lanat.argtypes.SimpleArgumentType

parseValues(String[]) - Method in class io.github.darvil.lanat.argtypes.SingleValueListArgumentType

parseValues(String[]) - Method in class io.github.darvil.lanat.argtypes.StdinArgumentType

parseValues(String[]) - Method in class io.github.darvil.lanat.argtypes.StringArgumentType

parseValues(String[]) - Method in class io.github.darvil.lanat.argtypes.TryParseArgumentType

parseValues(String...) - Method in class io.github.darvil.lanat.argtypes.TupleArgumentType

parseValues(String[]) - Method in class io.github.darvil.lanat.argtypes.ActionArgumentType

parseValues(String[]) - Method in class io.github.darvil.lanat.argtypes.BooleanArgumentType

parseValues(String[]) - Method in class io.github.darvil.lanat.argtypes.CounterArgumentType

parseValues(String[]) - Method in class io.github.darvil.lanat.argtypes.KeyValuesArgumentType

ParsingStateBase<T extends ErrorLevelProvider> - Class in io.github.darvil.lanat.parsing

Base class for parsing states.

ParsingStateBase(Command) - Constructor for class io.github.darvil.lanat.parsing.ParsingStateBase

Instantiates a new parsing state.

PERCENT - Enum constant in enum class io.github.darvil.lanat.Argument.Prefix

The percent sign (%).

PLUS - Enum constant in enum class io.github.darvil.lanat.Argument.Prefix

The plus sign (+).

positional() - Element in annotation interface io.github.darvil.lanat.Argument.Define

positional() - Method in record class io.github.darvil.lanat.ArgumentType.ParseStateSnapshot

Returns the value of the positional record component.

positional(boolean) - Method in class io.github.darvil.lanat.ArgumentBuilder

PostCreationInheritor<T> - Interface in io.github.darvil.lanat.utils

Interface for objects that inherit properties from another object after creation.

predicate() - Method in record class io.github.darvil.lanat.ArgumentTypeInfer.PredicateInfer

Returns the value of the predicate record component.

PredicateInfer(Predicate<Class<?>>, Function<Class<T>, ? extends ArgumentType<?>>, String) - Constructor for record class io.github.darvil.lanat.ArgumentTypeInfer.PredicateInfer

Creates an instance of a PredicateInfer record class.

prefix() - Element in annotation interface io.github.darvil.lanat.Argument.Define

Specifies the prefix character for this argument.

prefix(Argument.Prefix) - Method in class io.github.darvil.lanat.ArgumentBuilder

PrettyErrorFormatter - Class in io.github.darvil.lanat.parsing.errors.formatters

An error formatter that displays the error in the next format:

PrettyErrorFormatter(ErrorContext) - Constructor for class io.github.darvil.lanat.parsing.errors.formatters.PrettyErrorFormatter

printErrors() - Method in class io.github.darvil.lanat.AfterParseOptions.AfterParseActions

Prints all errors that occurred during parsing to System.err.

printHelpIfNoInput() - Method in class io.github.darvil.lanat.AfterParseOptions.AfterParseActions

Prints the help message to System.out if no arguments were passed to the program.

programDetails(Command) - Static method in class io.github.darvil.lanat.helpgen.LayoutGenerators

Shows the details of the command, if any.

R

range() - Method in record class io.github.darvil.lanat.parsing.errors.contexts.formatting.DisplayInput.Highlight

Returns the value of the range record component.

receivedValueCount() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.IncorrectValueNumberError

Returns the value of the receivedValueCount record component.

receivedValuesCount() - Method in record class io.github.darvil.lanat.ArgumentType.ParseStateSnapshot

Returns the value of the receivedValuesCount record component.

register(String, Class<? extends Tag>) - Static method in class io.github.darvil.lanat.helpgen.descriptions.Tag

Register a tag class to be used in descriptions.

register(Predicate<Class<?>>, Function<Class<T>, ? extends ArgumentType<?>>, String) - Static method in class io.github.darvil.lanat.ArgumentTypeInfer

Registers an argument type to be inferred for the specified type, if the predicate is true.

register(Supplier<? extends ArgumentType<?>>, Class<?>) - Static method in class io.github.darvil.lanat.ArgumentTypeInfer

Registers an argument type to be inferred for the specified type.

registerSubType(ArgumentType<?>) - Method in class io.github.darvil.lanat.ArgumentType

Registers a subtype.

registerToCommand(Command) - Method in class io.github.darvil.lanat.Argument

Sets the parent command of this argument.

registerToCommand(Command) - Method in class io.github.darvil.lanat.Command

registerToCommand(Command) - Method in class io.github.darvil.lanat.Group

Sets this group's parent command, and also passes all its arguments to the command.

registerToCommand(Command) - Method in interface io.github.darvil.lanat.utils.CommandUser

Sets the parent command of this object.

registerToGroup(Group) - Method in class io.github.darvil.lanat.Argument

Sets the parent group of this argument.

registerToGroup(Group) - Method in class io.github.darvil.lanat.Group

registerToGroup(Group) - Method in interface io.github.darvil.lanat.utils.GroupUser

Sets the parent group of this object.

registerWithPrimitive(Supplier<? extends ArgumentType<?>>, Class<?>, Class<?>) - Static method in class io.github.darvil.lanat.ArgumentTypeInfer

Registers an argument type to be inferred for the specified type, including the primitive form.

REGULAR_FILE - Enum constant in enum class io.github.darvil.lanat.argtypes.FileArgumentType.FileType

removeLayoutItems(int...) - Method in class io.github.darvil.lanat.helpgen.HelpFormatter

Removes one or more LayoutItem from the layout.

removePrefix(String, char) - Static method in class io.github.darvil.lanat.Argument

Removes the prefix from the given name.

representationColor(Color) - Method in class io.github.darvil.lanat.ArgumentBuilder

required() - Element in annotation interface io.github.darvil.lanat.Argument.Define

required(boolean) - Method in class io.github.darvil.lanat.ArgumentBuilder

RequiredArgumentNotUsedError(Argument<?, ?>) - Constructor for record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.RequiredArgumentNotUsedError

Creates an instance of a RequiredArgumentNotUsedError record class.

requireUniqueElements(List<T>, Function<T, RuntimeException>) - Static method in class io.github.darvil.lanat.utils.UtlMisc

Checks if the elements in the given list are unique.

requireValidName(String) - Static method in class io.github.darvil.lanat.utils.UtlMisc

Check if a string is a valid name.

resetState() - Method in class io.github.darvil.lanat.Argument

resetState() - Method in class io.github.darvil.lanat.ArgumentType

resetState() - Method in class io.github.darvil.lanat.Command

resetState() - Method in class io.github.darvil.lanat.Group

resetState() - Method in class io.github.darvil.lanat.parsing.ParsingStateBase

resetState() - Method in class io.github.darvil.lanat.utils.errors.ErrorContainerImpl

resetState() - Method in interface io.github.darvil.lanat.utils.Resettable

Resets the object to its default/initial state.

Resettable - Interface in io.github.darvil.lanat.utils

Represents an object that can be reset to its default/initial state.

RouteParser - Class in io.github.darvil.lanat.helpgen.descriptions

Parser for simple route syntax used in description tags (e.g.

runForMatchingArgument(char, Consumer<Argument<?, ?>>) - Method in class io.github.darvil.lanat.parsing.ParsingStateBase

Executes a callback for the argument found by the single character name specified.

runForMatchingArgument(String, Consumer<Argument<?, ?>>) - Method in class io.github.darvil.lanat.parsing.ParsingStateBase

Executes a callback for the argument found by the name specified.

S

setCallbackInvocationOption(Command.CallbackInvocationOption) - Method in class io.github.darvil.lanat.Command

Specifies in which cases the Argument.setOnOkCallback(Consumer) should be invoked.

setDefaultPrefix(Argument.Prefix) - Static method in enum class io.github.darvil.lanat.Argument.Prefix

Sets the default prefix character.

setDefaultValue(TInner) - Method in class io.github.darvil.lanat.Argument

The value that should be used if the user does not specify a value for this argument.

setDescription(String) - Method in class io.github.darvil.lanat.Command

setDescription(String) - Method in class io.github.darvil.lanat.Group

Sets the description of this group.

setDescription(String) - Method in interface io.github.darvil.lanat.utils.MultipleNamesAndDescription

Sets the description of this object.

setDescription(String) - Method in class io.github.darvil.lanat.Argument

Sets the description of this argument.

setDetails(String) - Method in class io.github.darvil.lanat.ArgumentParser

Sets the details of this program.

setErrorCode(int) - Method in class io.github.darvil.lanat.Command

Specifies the error code that the program should return when this command failed to parse.

setErrorDisplayThreshold(ErrorLevel) - Method in class io.github.darvil.lanat.Argument

setErrorDisplayThreshold(ErrorLevel) - Method in interface io.github.darvil.lanat.utils.errors.ErrorContainer

Specify the error level threshold at which errors should be displayed to the user.

setErrorDisplayThreshold(ErrorLevel) - Method in class io.github.darvil.lanat.utils.errors.ErrorContainerImpl

setErrorExitThreshold(ErrorLevel) - Method in class io.github.darvil.lanat.Argument

setErrorExitThreshold(ErrorLevel) - Method in interface io.github.darvil.lanat.utils.errors.ErrorContainer

Specify the error level threshold at which the program should exit.

setErrorExitThreshold(ErrorLevel) - Method in class io.github.darvil.lanat.utils.errors.ErrorContainerImpl

setHelpFormatter(HelpFormatter) - Method in class io.github.darvil.lanat.Command

Sets the help formatter that will be used to generate the help message of this command.

setIndentSize(int) - Static method in class io.github.darvil.lanat.helpgen.HelpFormatter

Sets the indent size to the specified value.

setInitialValue(T) - Method in class io.github.darvil.lanat.ArgumentType

Sets the initial value of this argument type.

setLayout(LayoutItem...) - Method in class io.github.darvil.lanat.helpgen.HelpFormatter

Sets the layout to the specified LayoutItems.

setLayout(List<LayoutItem>) - Method in class io.github.darvil.lanat.helpgen.HelpFormatter

Sets the layout to the specified LayoutItems.

setLineWrapMax(int) - Static method in class io.github.darvil.lanat.helpgen.HelpFormatter

Sets the maximum length of a line in the help message to the specified value.

setNames(List<String>) - Method in class io.github.darvil.lanat.Argument

Set the names of this object.

setNames(List<String>) - Method in class io.github.darvil.lanat.Command

setNames(List<String>) - Method in interface io.github.darvil.lanat.utils.MultipleNamesAndDescription

Set the names of this object.

setOnErrorCallback(Consumer<Argument<Type, TInner>>) - Method in class io.github.darvil.lanat.Argument

Specify a function that will be called if an error occurs when parsing this argument.

setOnErrorCallback(Consumer<Command>) - Method in class io.github.darvil.lanat.Command

setOnErrorCallback(Consumer<TErr>) - Method in interface io.github.darvil.lanat.utils.errors.ErrorCallbacks

Specify a function that will be called on error.

setOnOkCallback(Consumer<ParseResult>) - Method in class io.github.darvil.lanat.Command

Specify a function that will be called on success.

setOnOkCallback(Consumer<TInner>) - Method in class io.github.darvil.lanat.Argument

Specify a function that will be called with the value introduced by the user.

setOnOkCallback(Consumer<TOk>) - Method in interface io.github.darvil.lanat.utils.errors.ErrorCallbacks

Specify a function that will be called on success.

setOnUsedCallback(Consumer<ParseResult>) - Method in class io.github.darvil.lanat.Command

Sets the callback that will be invoked when this command is used by the user.

setPositional(boolean) - Method in class io.github.darvil.lanat.Argument

Marks the argument as positional.

setPrefix(Argument.Prefix) - Method in class io.github.darvil.lanat.Argument

Specify the prefix of this argument.

setRepresentationColor(Color) - Method in class io.github.darvil.lanat.Argument

Sets the color that will be used to represent this argument in the help message.

setRequired(boolean) - Method in class io.github.darvil.lanat.Argument

Marks the argument as required.

setRestricted(boolean) - Method in class io.github.darvil.lanat.Group

Sets this group to be restricted, meaning that only one argument in it can be used at a time.

setTokens(List<Token>) - Method in class io.github.darvil.lanat.parsing.Parser

Sets the tokens that this parser will parse.

setUnique(boolean) - Method in class io.github.darvil.lanat.Argument

Specifies that this argument has priority over other arguments, even if they are required.

setVersion(String) - Method in class io.github.darvil.lanat.ArgumentParser

Sets the version of this program.

setVisible(boolean) - Method in class io.github.darvil.lanat.Argument

Specifies whether this argument should appear in the help message or not.

ShortArgumentType - Class in io.github.darvil.lanat.argtypes

An argument type that takes a short integer number.

ShortArgumentType() - Constructor for class io.github.darvil.lanat.argtypes.ShortArgumentType

shouldRemoveOther(Error<?>) - Method in interface io.github.darvil.lanat.parsing.errors.Error

Determine whether this error should remove the other error from the list of errors.

shouldRemoveOther(Error<?>) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.IncorrectValueNumberError

shouldRemoveOther(Error<?>) - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.SimilarArgumentError

showArrows() - Method in record class io.github.darvil.lanat.parsing.errors.contexts.formatting.DisplayInput.Highlight

Returns the value of the showArrows record component.

SimilarArgumentError(int, Argument<?, ?>, boolean) - Constructor for record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.SimilarArgumentError

Creates an instance of a SimilarArgumentError record class.

SimpleArgumentType<T> - Class in io.github.darvil.lanat.argtypes

An argument type that allows to specify its behavior with a builder pattern.

SimpleArgumentType.ErrorProxy - Class in io.github.darvil.lanat.argtypes

A proxy class that allows to add errors to the argument type.

SimpleArgumentType.ParseFunction<T> - Interface in io.github.darvil.lanat.argtypes

A functional interface that allows to specify the parse function of the basic argument type.

SimpleArgumentType.SimpleArgumentTypeBuilder<T> - Class in io.github.darvil.lanat.argtypes

A builder for a SimpleArgumentType.

SimpleError - Class in io.github.darvil.lanat.parsing.errors.handlers

A simple error that has a message and an error level.

SimpleError(String, ErrorLevel) - Constructor for class io.github.darvil.lanat.parsing.errors.handlers.SimpleError

Instantiates a new simple error.

SimpleError(String, ErrorLevel, boolean) - Constructor for class io.github.darvil.lanat.parsing.errors.handlers.SimpleError

Instantiates a new simple error.

SimpleErrorFormatter - Class in io.github.darvil.lanat.parsing.errors.formatters

An error formatter that displays the error in the next format:

SimpleErrorFormatter(ErrorContext) - Constructor for class io.github.darvil.lanat.parsing.errors.formatters.SimpleErrorFormatter

SingleValueListArgumentType<T> - Class in io.github.darvil.lanat.argtypes

An argument type that takes a single value out of a list of values.

SingleValueListArgumentType(T[]) - Constructor for class io.github.darvil.lanat.argtypes.SingleValueListArgumentType

Creates a new single value list argument type.

SingleValueListArgumentType(T[], T) - Constructor for class io.github.darvil.lanat.argtypes.SingleValueListArgumentType

Creates a new single value list argument type.

SLASH - Enum constant in enum class io.github.darvil.lanat.Argument.Prefix

The slash (/).

sortByPriority(List<Argument<?, ?>>) - Static method in class io.github.darvil.lanat.Argument

Sorts the given list of arguments by the synopsis view priority order.

SpaceRequiredError(int) - Constructor for record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.SpaceRequiredError

Creates an instance of a SpaceRequiredError record class.

SQUARE_BRACKETS - Enum constant in enum class io.github.darvil.lanat.TupleChar

StdinArgumentType - Class in io.github.darvil.lanat.argtypes

An argument type that takes input from stdin (Standard Input).

StdinArgumentType() - Constructor for class io.github.darvil.lanat.argtypes.StdinArgumentType

StringArgumentType - Class in io.github.darvil.lanat.argtypes

An argument type that takes a string of characters.

StringArgumentType() - Constructor for class io.github.darvil.lanat.argtypes.StringArgumentType

StringNotClosedError(int) - Constructor for record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.StringNotClosedError

Creates an instance of a StringNotClosedError record class.

subCommandsDescriptions(Command) - Static method in class io.github.darvil.lanat.helpgen.LayoutGenerators

Shows the descriptions of the sub-commands of the command.

subResults - Variable in class io.github.darvil.lanat.ParseResult

The other inner ParseResults for the sub-commands

synopsis(Command) - Static method in class io.github.darvil.lanat.helpgen.LayoutGenerators

Shows the synopsis of the command, if any.

T

Tag - Class in io.github.darvil.lanat.helpgen.descriptions

Class for handling parsing of the simple tags used in descriptions.

Tag() - Constructor for class io.github.darvil.lanat.helpgen.descriptions.Tag

TILDE - Enum constant in enum class io.github.darvil.lanat.Argument.Prefix

The tilde (~).

titleAndDescription(Command) - Static method in class io.github.darvil.lanat.helpgen.LayoutGenerators

Shows the title of the command, followed by a description, if any.

Token - Record Class in io.github.darvil.lanat.parsing

Token(TokenType, String) - Constructor for record class io.github.darvil.lanat.parsing.Token

Creates an instance of a Token record class.

tokenIndex() - Method in record class io.github.darvil.lanat.ArgumentType.ParseStateSnapshot

Returns the value of the tokenIndex record component.

tokenize(String, Tokenizer) - Method in class io.github.darvil.lanat.parsing.Tokenizer

Tokenizes the input string given.

TokenizeErrorContext - Class in io.github.darvil.lanat.parsing.errors.contexts

Context for tokenize errors.

TokenizeErrorContext(Command, String) - Constructor for class io.github.darvil.lanat.parsing.errors.contexts.TokenizeErrorContext

Instantiates a new tokenize error context.

TokenizeErrors - Class in io.github.darvil.lanat.parsing.errors.handlers

Contains all the errors definitions for errors that occur during tokenization.

TokenizeErrors.SpaceRequiredError - Record Class in io.github.darvil.lanat.parsing.errors.handlers

Error that occurs when a space is required between two characters.

TokenizeErrors.StringNotClosedError - Record Class in io.github.darvil.lanat.parsing.errors.handlers

Error that occurs when a string is not closed.

TokenizeErrors.TupleAlreadyOpenError - Record Class in io.github.darvil.lanat.parsing.errors.handlers

Error that occurs when a tuple is already open.

TokenizeErrors.TupleNotClosedError - Record Class in io.github.darvil.lanat.parsing.errors.handlers

Error that occurs when a tuple is not closed.

TokenizeErrors.UnexpectedTupleCloseError - Record Class in io.github.darvil.lanat.parsing.errors.handlers

Error that occurs when a tuple close character is found without a tuple being open.

Tokenizer - Class in io.github.darvil.lanat.parsing

Tokenizes the input string given.

Tokenizer(Command) - Constructor for class io.github.darvil.lanat.parsing.Tokenizer

TokenType - Enum Class in io.github.darvil.lanat.parsing

toString() - Method in enum class io.github.darvil.lanat.Argument.Prefix

toString() - Method in class io.github.darvil.lanat.Argument

toString() - Method in record class io.github.darvil.lanat.ArgumentType.ParseStateSnapshot

Returns a string representation of this record class.

toString() - Method in record class io.github.darvil.lanat.ArgumentTypeInfer.PredicateInfer

Returns a string representation of this record class.

toString() - Method in class io.github.darvil.lanat.Command

toString() - Method in record class io.github.darvil.lanat.CommandTemplate.CommandBuildContext

Returns a string representation of this record class.

toString() - Method in class io.github.darvil.lanat.Group

toString() - Method in record class io.github.darvil.lanat.parsing.errors.contexts.formatting.DisplayInput.Highlight

Returns a string representation of this record class.

toString() - Method in record class io.github.darvil.lanat.parsing.errors.contexts.formatting.DisplayInput

Returns a string representation of this record class.

toString() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.IncorrectUsagesCountError

Returns a string representation of this record class.

toString() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.IncorrectValueNumberError

Returns a string representation of this record class.

toString() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.MultipleArgsInRestrictedGroupUsedError

Returns a string representation of this record class.

toString() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.RequiredArgumentNotUsedError

Returns a string representation of this record class.

toString() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.SimilarArgumentError

Returns a string representation of this record class.

toString() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.UniqueArgumentUsedError

Returns a string representation of this record class.

toString() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.UnmatchedInArgNameListError

Returns a string representation of this record class.

toString() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.UnmatchedTokenError

Returns a string representation of this record class.

toString() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.SpaceRequiredError

Returns a string representation of this record class.

toString() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.StringNotClosedError

Returns a string representation of this record class.

toString() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.TupleAlreadyOpenError

Returns a string representation of this record class.

toString() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.TupleNotClosedError

Returns a string representation of this record class.

toString() - Method in record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.UnexpectedTupleCloseError

Returns a string representation of this record class.

toString() - Method in record class io.github.darvil.lanat.parsing.Token

Returns a string representation of this record class.

TryParseArgumentType<T> - Class in io.github.darvil.lanat.argtypes

An argument type that attempts to parse a string into the type given in the constructor.

TryParseArgumentType(Class<T>) - Constructor for class io.github.darvil.lanat.argtypes.TryParseArgumentType

Creates a new argument type that will attempt to parse a string into the type given in the constructor.

TupleAlreadyOpenError(int) - Constructor for record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.TupleAlreadyOpenError

Creates an instance of a TupleAlreadyOpenError record class.

TupleArgumentType<T> - Class in io.github.darvil.lanat.argtypes

Parses multiple values received from the user by using the argument type provided in the constructor.

TupleArgumentType(Range, ArgumentType<T>) - Constructor for class io.github.darvil.lanat.argtypes.TupleArgumentType

Creates a new TupleArgumentType with the specified range and argument type.

TupleChar - Enum Class in io.github.darvil.lanat

Represents a character pair that is used to represent a tuple.

TupleNotClosedError(int) - Constructor for record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.TupleNotClosedError

Creates an instance of a TupleNotClosedError record class.

type - Variable in class io.github.darvil.lanat.Argument

The type of this argument.

type() - Element in annotation interface io.github.darvil.lanat.Argument.Define

type() - Method in record class io.github.darvil.lanat.parsing.Token

Returns the value of the type record component.

type(Builder<Type>) - Method in class io.github.darvil.lanat.ArgumentBuilder

The Argument Type is the class that will be used to parse the argument value.

type(Type) - Method in class io.github.darvil.lanat.ArgumentBuilder

The Argument Type is the class that will be used to parse the argument value.

typeSupplier() - Method in record class io.github.darvil.lanat.ArgumentTypeInfer.PredicateInfer

Returns the value of the typeSupplier record component.

U

UnexpectedTupleCloseError(int) - Constructor for record class io.github.darvil.lanat.parsing.errors.handlers.TokenizeErrors.UnexpectedTupleCloseError

Creates an instance of a UnexpectedTupleCloseError record class.

unique() - Element in annotation interface io.github.darvil.lanat.Argument.Define

unique(boolean) - Method in class io.github.darvil.lanat.ArgumentBuilder

UniqueArgumentUsedError(Pair<Integer, Integer>, Argument<?, ?>) - Constructor for record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.UniqueArgumentUsedError

Creates an instance of a UniqueArgumentUsedError record class.

UnknownTagException - Exception in io.github.darvil.lanat.helpgen.descriptions.exceptions

Thrown when a tag with an unknown name is attempted to be used.

UnknownTagException(String) - Constructor for exception io.github.darvil.lanat.helpgen.descriptions.exceptions.UnknownTagException

UnmatchedInArgNameListError(int, Argument<?, ?>, String) - Constructor for record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.UnmatchedInArgNameListError

Creates an instance of a UnmatchedInArgNameListError record class.

UnmatchedTokenError(int) - Constructor for record class io.github.darvil.lanat.parsing.errors.handlers.ParseErrors.UnmatchedTokenError

Creates an instance of a UnmatchedTokenError record class.

unregister(Class<?>) - Static method in class io.github.darvil.lanat.ArgumentTypeInfer

Removes the argument type inference for the specified type.

unregister(String) - Static method in class io.github.darvil.lanat.ArgumentTypeInfer

Removes the ArgumentTypeInfer.PredicateInfer with the specified name.

unregister(String) - Static method in class io.github.darvil.lanat.helpgen.descriptions.Tag

Unregister a tag.

unregisterSubType(ArgumentType<?>) - Method in class io.github.darvil.lanat.ArgumentType

Unregisters the specified subtype from this argument type.

unregisterWithPrimitive(Class<?>, Class<?>) - Static method in class io.github.darvil.lanat.ArgumentTypeInfer

Removes the argument type inference for the specified type, including the primitive form.

UtlMisc - Class in io.github.darvil.lanat.utils

V

value() - Element in annotation interface io.github.darvil.lanat.argtypes.EnumArgumentType.WithName

valueOf(String) - Static method in enum class io.github.darvil.lanat.argtypes.FileArgumentType.FileType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.github.darvil.lanat.Argument.Prefix

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.github.darvil.lanat.Command.CallbackInvocationOption

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.github.darvil.lanat.parsing.TokenType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.github.darvil.lanat.TupleChar

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.github.darvil.lanat.utils.errors.ErrorLevel

Returns the enum constant of this class with the specified name.

values() - Static method in enum class io.github.darvil.lanat.argtypes.FileArgumentType.FileType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.github.darvil.lanat.Argument.Prefix

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.github.darvil.lanat.Command.CallbackInvocationOption

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.github.darvil.lanat.parsing.TokenType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.github.darvil.lanat.TupleChar

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.github.darvil.lanat.utils.errors.ErrorLevel

Returns an array containing the constants of this enum class, in the order they are declared.

valueToString(T) - Method in class io.github.darvil.lanat.argtypes.EnumArgumentType

valueToString(T) - Method in class io.github.darvil.lanat.argtypes.SingleValueListArgumentType

Converts the given value to a string.

verbose - Variable in class io.github.darvil.lanat.CommandTemplate.Default.WithVerbose

visible() - Element in annotation interface io.github.darvil.lanat.Argument.Define

visible(boolean) - Method in class io.github.darvil.lanat.ArgumentBuilder

W

WARNING - Enum constant in enum class io.github.darvil.lanat.utils.errors.ErrorLevel

wasUsed() - Method in class io.github.darvil.lanat.CommandTemplate

Returns true if the Command of this Template was used in the command line.

wasUsed() - Method in class io.github.darvil.lanat.ParseResult

Returns true if the command was used, false otherwise.

withActions(Consumer<AfterParseOptions.AfterParseActions>) - Method in class io.github.darvil.lanat.AfterParseOptions

Sets the actions to be executed after parsing is done.

withContent(String) - Method in class io.github.darvil.lanat.parsing.errors.contexts.formatting.ErrorFormattingContext

Sets the content of the error message.

withDescription(String) - Method in class io.github.darvil.lanat.argtypes.SimpleArgumentType.SimpleArgumentTypeBuilder

withIndent(int) - Method in class io.github.darvil.lanat.helpgen.LayoutItem

Sets the indent of the layout item.

withMargin(int) - Method in class io.github.darvil.lanat.helpgen.LayoutItem

Sets the margin at the top and bottom of the layout item.

withMarginBottom(int) - Method in class io.github.darvil.lanat.helpgen.LayoutItem

Sets the margin at the bottom of the layout item.

withMarginTop(int) - Method in class io.github.darvil.lanat.helpgen.LayoutItem

Sets the margin at the top of the layout item.

withName(String) - Method in class io.github.darvil.lanat.argtypes.SimpleArgumentType.SimpleArgumentTypeBuilder

Sets the name of the argument type, which will be displayed in the help message.

withTitle(String) - Method in class io.github.darvil.lanat.helpgen.LayoutItem

Sets the title of the layout item.

withUsageCountBounds(Range) - Method in class io.github.darvil.lanat.argtypes.SimpleArgumentType.SimpleArgumentTypeBuilder

withValueCountBounds(Range) - Method in class io.github.darvil.lanat.argtypes.SimpleArgumentType.SimpleArgumentTypeBuilder

WithVerbose() - Constructor for class io.github.darvil.lanat.CommandTemplate.Default.WithVerbose

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