All Classes and Interfaces

Class	Description
ActionArgumentType	An argument type that is set in a true state if the argument was used.
AfterParseOptions	Provides utilities for the parsed arguments after parsing is done.
Argument<Type extends ArgumentType<TInner>,TInner>	Argument
Argument.Define	Used in CommandTemplates to specify the properties of an argument belonging to the command.
Argument.Prefix	Specifies the prefix character for an Argument.
ArgumentAdder	An interface for objects that can add Arguments to themselves.
ArgumentAlreadyExistsException	Thrown when an Argument is added to a container that already contains an Argument with the same name.
ArgumentBuilder<Type extends ArgumentType<TInner>,TInner>	Provides easy ways to build an Argument.
ArgumentNotFoundException	Thrown when an Argument is not found.
ArgumentParser	Argument Parser
ArgumentRepr	Contains methods for generating the help representations of Arguments.
ArgumentType<T>	Argument Type
ArgumentType.ParseStateSnapshot	A snapshot of the state of the argument type during parsing.
ArgumentTypeError	An error that may be thrown by an argument type.
ArgumentTypeException	Thrown when an error occurs in an ArgumentType.
ArgumentTypeInfer	Argument Type Inferring
ArgumentTypeInfer.PredicateInfer<T>	A predicate that checks if the argument type should be inferred for the specified type.
ArgumentTypeInferException	Thrown when an error occurs when inferring types for an ArgumentType.
BooleanArgumentType	An argument type that is set in a true state if the argument was used.
Builder<T>	A builder for a type.
ByteArgumentType	An argument type that takes a byte value.
CLInput	A class to gather the input from the command line.
ColorTag	Changes the color of the text.
Command	Command
Command.CallbackInvocationOption
Command.Define	Annotation used to define a command template.
CommandAdder	An interface for objects that can add Commands to themselves.
CommandAlreadyExistsException	Thrown when a Command is added to a container that already contains a Command with the same name.
CommandNotFoundException	Thrown when a Command is not found.
CommandRepr	Contains methods for generating the help representations of Commands.
CommandTemplate	Command Template
CommandTemplate.CommandAccessor	Annotation used to define a sub-command field in a Command Template.
CommandTemplate.CommandBuildContext	Helper class that contains the command being initialized and the list of argument builders that may be altered.
CommandTemplate.Default	A command template that adds the 'help' and 'version' arguments to the command.
CommandTemplate.Default.WithVerbose	A command template that adds the 'verbose' argument, as well as the 'help' and 'version' arguments defined in CommandTemplate.Default.
CommandTemplate.InitDef	Annotation used to define an init method for a Command Template.
CommandTemplateException	Thrown when an error occurs while parsing a CommandTemplate.
CommandUser	This interface is used for objects that belong to a Command.
CounterArgumentType	An argument type that counts the number of times it is used.
DefaultValueTag	Gets the default value of an argument.
DescriptionParser	A class that parses tags in a description and replaces them with the content generated by them.
DescTag	Gets the description of the target object specified by the route.
DisplayInput	Options used to display the input.
DisplayInput.Highlight	Options used to highlight the input.
DoubleArgumentType	An argument type that takes a double precision floating point number.
EnumArgumentType<T extends Enum<T>>	An argument type that takes a valid enum value.
EnumArgumentType.Default	An annotation that specifies the default value of the enum type.
EnumArgumentType.WithName	An annotation that specifies the name the user will have to write to select this value.
Error<C extends ErrorContext>	An error that indicates a failure in the parsing process.
Error.ParseError	A parse error.
Error.TokenizeError	A tokenize error.
ErrorCallbacks<TOk,TErr>	Interface for classes that have error and success callbacks.
ErrorCollector	Handles all errors generated by the parser and tokenizer.
ErrorContainer<T extends ErrorLevelProvider>	Represents a container of errors.
ErrorContainerImpl<T extends ErrorLevelProvider>	A container for errors.
ErrorContext	Base class for error contexts.
ErrorFormatter	Base class for error formatters.
ErrorFormattingContext	Class used by error handlers to easily format errors to be displayed to the user.
ErrorLevel	Represents the multiple levels that an error can have.
ErrorLevelProvider	Interface for classes that have an error level.
FileArgumentType	An argument type that takes a file path and returns a File instance representing it.
FileArgumentType.FileType	The type of the file.
FloatArgumentType	An argument type that takes a floating point number.
FormatTag	Changes the format of the text.
FromParseableArgumentType<T extends Parseable<TInner>,TInner>	An argument type that uses a Parseable to parse values.
Group	Argument Group
GroupAdder	An interface for objects that can add Groups to themselves.
GroupAlreadyExistsException	Thrown when an Group is added to a container that already contains an Group with the same name.
GroupNotFoundException	Thrown when an Group is not found.
GroupRepr	Contains methods for generating the help representations of Groups.
GroupUser	This interface is used for objects that belong to an Group.
HelpFormatter	Manager for generating the help message of a command.
IncompatibleCommandTemplateTypeException	Thrown when a type of field inside a CommandTemplate is incompatible with the type returned by the argument type inner value.
IntegerArgumentType	An argument type that takes an integer number.
InvalidRouteException	Thrown when a parsed route is invalid.
KeyValuesArgumentType<Type extends ArgumentType<TInner>,TInner>	An argument type that takes key-value pairs.
LanatException	Thrown when an error occurs in Lanat.
LayoutGenerators	This contains methods that may be used in LayoutItems to generate the content of the help message.
LayoutItem	Represents a layout item in the help message generated by HelpFormatter.
LinkTag	Gets the representation of the target object specified by the route.
LongArgumentType	An argument type that takes a long integer number.
MalformedTagException	Thrown when a tag is malformed.
MultipleNamesAndDescription	Represents an object that has multiple names and a description.
NamedWithDescription	Represents an object that has a name and a description.
NoDescriptionDefinedException	Thrown when a description was not defined for an object.
NumberArgumentType<T extends Number>	An abstract class for argument types that are numbers.
NumberRangeArgumentType<T extends Number & Comparable<T>>	An argument type that is a number between a minimum and maximum value.
ObjectAlreadyExistsException	Thrown when an object is added to a container that already contains an object equal to the added one.
ObjectNotFoundException	Thrown when an object is not found.
OptListArgumentType	An argument type that restricts a possible value out of a list of values.
ParentElementGetter<T extends ParentElementGetter<T>>	This interface is used for getting the parent object of an object.
Parseable<T>	The basic interface for all argument types.
ParseErrorContext	Context for parse errors.
ParseErrors	Contains all the errors definitions for errors that occur during parsing.
ParseErrors.IncorrectUsagesCountError	Error that occurs when an argument is used an incorrect amount of times.
ParseErrors.IncorrectValueNumberError	Error that occurs when an argument receives an incorrect number of values.
ParseErrors.MultipleArgsInRestrictedGroupUsedError	Error that occurs when multiple arguments in a restricted group are used.
ParseErrors.RequiredArgumentNotUsedError	Error that occurs when an argument that is required is not used.
ParseErrors.SimilarArgumentError	Warning that occurs when the contents of a token are found to be similar to the name of an argument.
ParseErrors.UniqueArgumentUsedError	Error that occurs when an argument is used while there's a unique argument that has been used.
ParseErrors.UnmatchedInArgNameListError	Warning that occurs when an argument name list receives a value for an argument that does not take any values.
ParseErrors.UnmatchedTokenError	Warning that occurs when a token in the input does not match any argument, argument list, value, or command.
Parser	Parses the tokens that have been tokenized from the CLI input.
ParseResult	Container for all the parsed arguments and their respective values.
ParseResultRoot	Container for all the parsed arguments and their respective values.
ParsingStateBase<T extends ErrorLevelProvider>	Base class for parsing states.
PostCreationInheritor<T>	Interface for objects that inherit properties from another object after creation.
PrettyErrorFormatter	An error formatter that displays the error in the next format:
Resettable	Represents an object that can be reset to its default/initial state.
RouteParser	Parser for simple route syntax used in description tags (e.g.
ShortArgumentType	An argument type that takes a short integer number.
SimpleArgumentType<T>	An argument type that allows to specify its behavior with a builder pattern.
SimpleArgumentType.ParseFunction<T>	A functional interface that allows to specify the parse function of the basic argument type.
SimpleArgumentType.SimpleArgumentTypeBuilder<T>	A builder for a SimpleArgumentType.
SimpleError	A simple error that has a message and an error level.
SimpleErrorFormatter	An error formatter that displays the error in the next format:
SingleValueListArgumentType<T>	An argument type that takes a single value out of a list of values.
StdinArgumentType	An argument type that takes input from stdin (Standard Input).
StringArgumentType	An argument type that takes a string of characters.
Tag	Class for handling parsing of the simple tags used in descriptions.
Token
TokenizeErrorContext	Context for tokenize errors.
TokenizeErrors	Contains all the errors definitions for errors that occur during tokenization.
TokenizeErrors.SpaceRequiredError	Error that occurs when a space is required between two characters.
TokenizeErrors.StringNotClosedError	Error that occurs when a string is not closed.
TokenizeErrors.TupleAlreadyOpenError	Error that occurs when a tuple is already open.
TokenizeErrors.TupleNotClosedError	Error that occurs when a tuple is not closed.
TokenizeErrors.UnexpectedTupleCloseError	Error that occurs when a tuple close character is found without a tuple being open.
Tokenizer	Tokenizes the input string given.
TokenType
TryParseArgumentType<T>	An argument type that attempts to parse a string into the type given in the constructor.
TupleArgumentType<T>	Parses multiple values received from the user by using the argument type provided in the constructor.
TupleChar	Represents a character pair that is used to represent a tuple.
UnknownTagException	Thrown when a tag with an unknown name is attempted to be used.
UtlMisc