All Classes and Interfaces
Class
Description
The
AbstractCondition is an abstract implementation of the
ArgsSyntax interface providing the boiler plate when implementing the
ArgsSyntax interface as done by the AbstractCondition's
sub-classes.The
AbstractOperand is an abstract implementation of an
Operand providing the boiler plate when implementing the
Operand interface.The
AbstractOption is an abstract implementation of an Option
providing the boiler plate when implementing the Option interface.The
AllCondition enforces that the encapsulated Syntaxable
consumes all arguments passed via invoking its
Syntaxable.parseArgs(String[]), else a
SuperfluousArgsException is thrown.Thrown in case the command line arguments do not match the required syntax.
An
AndCondition contains (represents) a list of ArgsSyntax
(Syntaxable) instances (nested by the AndCondition) of which
all are to be parsed successfully as of invoking the
Syntaxable.parseArgs(String[], String[]) methods.Any of the nested
ArgsSyntax conditions may match for the
AnyCondition to match, e.g. all of the nested conditions are
optional.Provides an accessor for a command line arguments (short "args") array.
Provides a mutator for a args property.
Provides a args property.
Enumeration declaring command line argument filter.
The
ArgsParser provides means for parsing command line arguments and
constructing a command line utility's help output.Provides an accessor for a
ArgsParser property.Provides a builder method for a
ArgsParser property returning the
builder for applying multiple build operations.Provides a mutator for a
ArgsParser property.Provides a
ArgsParser property.A straightforward implementation of the
ArgsParser interface.This mixin provides builder additions (as of the builder pattern for chained
configuring method calls) for parsing command line arguments.
The
ArgsSyntax interface represents a node (and therewith the syntax
for the arguments) in the command line arguments syntax tree; simply
extending the Syntaxable interface and adding the functionality of
providing access to the added Operands (leafs).Thrown in case of a command line arguments mismatch regarding provided and
expected args.
Creates an array representation facade for the encapsulated
Operand.Creates an array representation facade for the encapsulated
Option.The
CasesCondition is an XorCondition making sure that all
possible cases inside the XorCondition must(!)A predefined clean
Flag: A predefined Flag gives its
CleanFlag.SHORT_OPTION, its CleanFlag.LONG_OPTION as well as its CleanFlag.ALIAS
an according semantics regarded by other subsystems.Base exception for the console artifact.
This abstract exception is the base exception for all command line
argument related exceptions.
The Class ConsoleCliException.
The purpose of a
CliSchema is automatically generate documentation of
Syntaxable structures.Declarative syntactic sugar which may be statically imported in order to
allow declarative definitions for the command line
Flag,
ArgsSyntax, Option and Operand elements.This utility class provides method useful for the refcodes-cli artifact and
whose implementation has been motivated by the implementation of the
refcodes-cli artifact.
Interface indicating that the
ArgsSyntax semantically represents a
condition which usally encapsulates other Syntaxable children.The
ConfigOption represents an Option holding a value
specifying a configuration resource (file).A predefined daemon
Flag: A predefined Flag gives its
DaemonFlag.SHORT_OPTION, its DaemonFlag.LONG_OPTION as well as its DaemonFlag.ALIAS
an according semantics regarded by other subsystems.A predefined debug
Flag: A predefined Flag gives its
DebugFlag.SHORT_OPTION, its DebugFlag.LONG_OPTION as well as its DebugFlag.ALIAS
an according semantics regarded by other subsystems.The Class EnumOption.
An example usage item describing a usage scenario.
The
Flag class implements the Option interface for
representing either a true or a false state: When a
flag is provided to your command line arguments, then it is considered to be
true, when it is omitted, then it is considered to be
false as of Flag.isEnabled().A predefined force
Flag: A predefined Flag gives its
SHORT_OPTION, its LONG_OPTION as well as its ALIAS
an according semantics regarded by other subsystems.A predefined help
Flag: A predefined Flag gives its
HelpFlag.SHORT_OPTION, its HelpFlag.LONG_OPTION as well as its HelpFlag.ALIAS
an according semantics regarded by other subsystems.A predefined init
Flag: A predefined Flag gives its
InitFlag.SHORT_OPTION, its InitFlag.LONG_OPTION as well as its InitFlag.ALIAS
an according semantics regarded by other subsystems.The
NoneOperand represents an empty set of arguments, e.g. no command
line argument is being passed.An
Operand represents a value parsed from command line arguments.The
Operation is an argument representing a function or a method
("command") and is either provided or not provided as of
Operation.isEnabled().An
Option represents a command line option with the according
option's value.An
OrCondition represents a list of ArgsSyntax
(Syntaxable) instances of which at least one must be parsed
successfully when the Syntaxable s'
Syntaxable.parseArgs(String[], String[]) methods are invoked.Thrown in case the provided command line arguments do not respect the
required semantics or cannot be converted to the required type.
A predefined "be quiet"
Flag: A predefined Flag gives its
QuietFlag.SHORT_OPTION, its QuietFlag.LONG_OPTION as well as its QuietFlag.ALIAS
an according semantics regarded by other subsystems.Provides an accessor for a root condition property.
Provides a builder method for a root condition property returning the
builder for applying multiple build operations.
Provides a mutator for a root condition property.
Provides a root condition property.
Thrown in case there were arguments found not being used (superfluous
arguments).
The
Synopsisable interface defines those methods required to create a
human readable usage String similar to a manpage's synopsis from the
implementing instance.A
Syntaxable defines the methods at least required when building a
command line arguments syntax tree for traversing the syntax tree; either for
parsing command line arguments or for constructing the command line arguments
syntax.The
SyntaxNotation is used by a the
Syntaxable.toSyntax(SyntaxNotation, String, String, String) method to
determine which notation to be used for the generated syntax.A predefined system information
Flag: A predefined Flag gives
its SysInfoFlag.SHORT_OPTION, its SysInfoFlag.LONG_OPTION as well as its
SysInfoFlag.ALIAS an according semantics regarded by other subsystems..Thrown in case command line arguments were not processed (did not match the
expected arguments), e.g. the arguments were rejected as them did not work
for the according syntax.
A predefined verbose
Flag: A predefined Flag gives its
VerboseFlag.SHORT_OPTION, its VerboseFlag.LONG_OPTION as well as its VerboseFlag.ALIAS
an according semantics regarded by other subsystems.An
XorCondition represents a list of ArgsSyntax
(Syntaxable) instances of which only one is allowed to be parsed
successfully when the Syntaxable.parseArgs(String[], String[])
methods are invoked.