Module org.refcodes.cli

Package org.refcodes.cli

package org.refcodes.cli

This artifact defines some helpful toolkit to parse your command line arguments (as passed to your public static void main( String[] args) { ... } method. It lets you define the exact valid combinations of command line arguments, it parses them arguments for you and it lets you print the syntax as you programmatically defined it. Let's get started!

Please refer to the refcodes-cli: Parse your args[] documentation for an up-to-date and detailed description on the usage of this artifact.

Class	Description
AbstractCondition	The AbstractCondition is an abstract implementation of the Condition interface providing the boiler plate when implementing the Condition interface as done by the AbstractCondition's sub-classes.
AbstractOperand<T>	The AbstractOperand is an abstract implementation of an Operand providing the boiler plate when implementing the Operand interface.
AbstractOption<T>	The AbstractOption is an abstract implementation of an Option providing the boiler plate when implementing the Option interface.
AllCondition	The AllCondition enforces that the encapsulated Constituent consumes all arguments passed via invoking its Constituent.parseArgs(String[], CliContext), else a SuperfluousArgsException is thrown.
AmbiguousArgsException	Thrown in case the command line arguments do not match the required syntax.
AndCondition	An AndCondition contains (represents) a list of Condition (Constituent) instances (nested by the AndCondition) of which all are to be parsed successfully as of invoking the Constituent.parseArgs(String[], String[], CliContext) methods.
AnyCondition	Any of the nested Condition conditions may match for the AnyCondition to match, e.g. all of the nested conditions are optional.
ArgsAccessor	Provides an accessor for a command line arguments (short "args") array.
ArgsAccessor.ArgsMutator	Provides a mutator for a args property.
ArgsAccessor.ArgsProperty	Provides a args property.
ArgsFilter	Enumeration declaring command line argument filter.
ArgsParser	The ArgsParser provides means for parsing command line arguments and constructing a command line utility's help output.
ArgsParserAccessor	Provides an accessor for a ArgsParser property.
ArgsParserAccessor.ArgsParserBuilder<B extends ArgsParserAccessor.ArgsParserBuilder<B>>	Provides a builder method for a ArgsParser property returning the builder for applying multiple build operations.
ArgsParserAccessor.ArgsParserMutator	Provides a mutator for a ArgsParser property.
ArgsParserAccessor.ArgsParserProperty	Provides a ArgsParser property.
ArgsParserImpl	A straightforward implementation of the ArgsParser interface.
ArgsParserMixin<B extends ArgsParserMixin<B>>	This mixin provides builder additions (as of the builder pattern for chained configuring method calls) for parsing command line arguments.
ArgsSyntaxAccessor	Provides an accessor for a root condition property.
ArgsSyntaxAccessor.ArgsSyntaxBuilder<B extends ArgsSyntaxAccessor.ArgsSyntaxBuilder<B>>	Provides a builder method for a root condition property returning the builder for applying multiple build operations.
ArgsSyntaxAccessor.ArgsSyntaxMutator	Provides a mutator for a root condition property.
ArgsSyntaxAccessor.ArgsSyntaxProperty	Provides a root condition property.
ArgsSyntaxException	Thrown in case of a command line arguments mismatch regarding provided and expected args.
ArgumentEscapeCodeAccessor	Provides an accessor for a argument Escape-Code property.
ArgumentEscapeCodeAccessor.ArgumentEscapeCodeBuilder<B extends ArgumentEscapeCodeAccessor.ArgumentEscapeCodeBuilder<B>>	Provides a builder method for a argument Escape-Code property returning the builder for applying multiple build operations.
ArgumentEscapeCodeAccessor.ArgumentEscapeCodeMutator	Provides a mutator for a argument Escape-Code property.
ArgumentEscapeCodeAccessor.ArgumentEscapeCodeProperty	Provides a argument Escape-Code property.
ArgumentPrefixAccessor	Provides an accessor for an argument prefix property.
ArgumentPrefixAccessor.ArgumentPrefixBuilder<B extends ArgumentPrefixAccessor.ArgumentPrefixBuilder<B>>	Provides a builder method for an argument prefix property returning the builder for applying multiple build operations.
ArgumentPrefixAccessor.ArgumentPrefixMutator	Provides a mutator for an argument prefix property.
ArgumentPrefixAccessor.ArgumentPrefixProperty	Provides an argument prefix property.
ArgumentSuffixAccessor	Provides an accessor for an argument suffix property.
ArgumentSuffixAccessor.ArgumentSuffixBuilder<B extends ArgumentSuffixAccessor.ArgumentSuffixBuilder<B>>	Provides a builder method for an argument suffix property returning the builder for applying multiple build operations.
ArgumentSuffixAccessor.ArgumentSuffixMutator	Provides a mutator for an argument suffix property.
ArgumentSuffixAccessor.ArgumentSuffixProperty	Provides an argument suffix property.
ArrayOperand<T>	Creates an array representation facade for the encapsulated Operand.
ArrayOption<T>	Creates an array representation facade for the encapsulated Option.
CasesCondition	The CasesCondition is an XorCondition making sure that all possible cases inside the XorCondition must(!)
CharOption	The CharOption represents an Option holding String values.
CleanFlag	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.
CliContext	The CliContext describes the context in which an ArgsParser is running.
CliContext.Builder	Builder to build SyntaxMetricsAccessor.SyntaxMetricsBuilder instances.
CliContextAccessor	Provides an accessor for a CliContext property.
CliContextAccessor.RootConditionBuilder<B extends CliContextAccessor.RootConditionBuilder<B>>	Provides a builder method for a CliContext property returning the builder for applying multiple build operations.
CliContextAccessor.RootConditionMutator	Provides a mutator for a CliContext property.
CliContextAccessor.RootConditionProperty	Provides a CliContext property.
CliException	Base exception for the console artifact.
CliException.ConsoleArgsException	This abstract exception is the base exception for all command line argument related exceptions.
CliException.ConsoleCliException	The Class ConsoleCliException.
CliMetrics	The CliMetrics define the attributes required to parse a Constituent tree's syntax by an ArgsParser.
CliSchema	The purpose of a CliSchema is automatically generate documentation of Constituent structures.
CliSugar	Declarative syntactic sugar which may be statically imported in order to allow declarative definitions for the command line Flag, Condition, Option and Operand elements.
CliUtility	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.
Condition	The Condition interface represents a node (and therewith the syntax for the arguments) in the command line arguments syntax tree; simply extending the Constituent interface and adding the functionality of providing access to the added Operands (leafs).
ConfigOption	The ConfigOption represents an Option holding a value specifying a configuration resource (file).
Constituent	A Constituent 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.
DaemonFlag	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.
DebugFlag	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.
DoubleOption	The DoubleOption represents an Option holding double values.
EnumOption<T extends Enum<T>>	The EnumOption represents an Option of enumeration types.
Example	An example usage item describing a usage scenario.
FileOption	The FileOption represents an Option holding File values.
Flag	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().
FloatOption	The FloatOption represents an Option holding float values.
ForceFlag	A predefined force Flag: A predefined Flag gives its ForceFlag.SHORT_OPTION, its ForceFlag.LONG_OPTION as well as its ForceFlag.ALIAS an according semantics regarded by other subsystems.
HelpFlag	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.
InitFlag	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.
IntOption	The IntOption represents an Option holding int values.
LongOption	The LongOption represents an Option holding long values.
LongOptionPrefixAccessor	Provides an accessor for a long option prefix property.
LongOptionPrefixAccessor.LongOptionPrefixBuilder<B extends LongOptionPrefixAccessor.LongOptionPrefixBuilder<B>>	Provides a builder method for a long option prefix property returning the builder for applying multiple build operations.
LongOptionPrefixAccessor.LongOptionPrefixMutator	Provides a mutator for a long option prefix property.
LongOptionPrefixAccessor.LongOptionPrefixProperty	Provides a long option prefix property.
NoneOperand	The NoneOperand represents an empty set of arguments, e.g. no command line argument is being passed.
Operand<T>	An Operand represents a value parsed from command line arguments.
Operation	The Operation is an argument representing a function or a method ("command") and is either provided or not provided as of Operation.isEnabled().
Option<T>	An Option represents a command line option with the according option's value.
Optionable	Provides means to determine context specific information on Option instances.
OptionEscapeCodeAccessor	Provides an accessor for a option Escape-Code property.
OptionEscapeCodeAccessor.OptionEscapeCodeBuilder<B extends OptionEscapeCodeAccessor.OptionEscapeCodeBuilder<B>>	Provides a builder method for a option Escape-Code property returning the builder for applying multiple build operations.
OptionEscapeCodeAccessor.OptionEscapeCodeMutator	Provides a mutator for a option Escape-Code property.
OptionEscapeCodeAccessor.OptionEscapeCodeProperty	Provides a option Escape-Code property.
OrCondition	An OrCondition represents a list of Condition (Constituent) instances of which at least one must be parsed successfully when the Constituent s' Constituent.parseArgs(String[], String[], CliContext) methods are invoked.
ParseArgsException	Thrown in case the provided command line arguments do not respect the required semantics or cannot be converted to the required type.
QuietFlag	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.
ShortOptionPrefixAccessor	Provides an accessor for a short option prefix property.
ShortOptionPrefixAccessor.ShortOptionPrefixBuilder<B extends ShortOptionPrefixAccessor.ShortOptionPrefixBuilder<B>>	Provides a builder method for a short option prefix property returning the builder for applying multiple build operations.
ShortOptionPrefixAccessor.ShortOptionPrefixMutator	Provides a mutator for a short option prefix property.
ShortOptionPrefixAccessor.ShortOptionPrefixProperty	Provides a short option prefix property.
StringOperand	An Operand (neither a short option nor a long option prepended nor being a switch) being s String.
StringOption	The StringOption represents an Option holding String values.
SuperfluousArgsException	Thrown in case there were arguments found not being used (superfluous arguments).
Synopsisable	The Synopsisable interface defines those methods required to create a human readable usage String similar to a manpage's synopsis from the implementing instance.
SyntaxMetrics	The SyntaxMetrics provides properties specific to a specific command line syntax notation.
SyntaxMetricsAccessor	Provides an accessor for a SyntaxMetrics property.
SyntaxMetricsAccessor.SyntaxMetricsBuilder<B extends SyntaxMetricsAccessor.SyntaxMetricsBuilder<B>>	Provides a builder method for a SyntaxMetrics property returning the builder for applying multiple build operations.
SyntaxMetricsAccessor.SyntaxMetricsMutator	Provides a mutator for a SyntaxMetrics property.
SyntaxMetricsAccessor.SyntaxMetricsProperty	Provides a SyntaxMetrics property.
SyntaxMetricsImpl	The SyntaxMetricsImpl class implements the SyntaxMetrics interface for building custom SyntaxMetrics instances.
SyntaxMetricsImpl.Builder	Builder to build SyntaxMetrics instances.
SyntaxNotation	The SyntaxNotation is used by a the Constituent.toSyntax(CliContext) method to determine which notation to be used for the generated syntax.
SysInfoFlag	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..
UnknownArgsException	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.
VerboseFlag	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.
XorCondition	An XorCondition represents a list of Condition (Constituent) instances of which only one is allowed to be parsed successfully when the Constituent.parseArgs(String[], String[], CliContext) methods are invoked.