All Classes
-
All Classes Interface Summary Class Summary Enum Summary Exception Summary Class Description AbstractCondition TheAbstractCondition
is an abstract implementation of theArgsSyntax
interface providing the boiler plate when implementing theArgsSyntax
interface as done by theAbstractCondition
's sub-classes.AbstractOperand<T> TheAbstractOperand
is an abstract implementation of anOperand
providing the boiler plate when implementing theOperand
interface.AbstractOption<T> TheAbstractOption
is an abstract implementation of anOption
providing the boiler plate when implementing theOption
interface.AllCondition TheAllCondition
enforces that the encapsulatedSyntaxable
consumes all arguments passed via invoking itsSyntaxable.parseArgs(String[])
, else aSuperfluousArgsException
is thrown.AmbiguousArgsException Thrown in case at least one command line argument is ambiguous regarding expected args vs. provided args.AndCondition AnAndCondition
contains (represents) a list ofArgsSyntax
(Syntaxable
) instances (nested by theAndCondition
) of which all are to be parsed successfully as of invoking theSyntaxable.parseArgs(String[], String[])
methods.AnyCondition Any of the nestedArgsSyntax
conditions may match for theAnyCondition
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.ArgsMismatchException Thrown in case a command line arguments mismatch regarding provided and expected args.ArgsParser TheArgsParser
provides means for parsing command line arguments and constructing a command line utility's help output.ArgsParserAccessor Provides an accessor for aArgsParser
property.ArgsParserAccessor.ArgsParserBuilder<B extends ArgsParserAccessor.ArgsParserBuilder<B>> Provides a builder method for aArgsParser
property returning the builder for applying multiple build operations.ArgsParserAccessor.ArgsParserMutator Provides a mutator for aArgsParser
property.ArgsParserAccessor.ArgsParserProperty Provides aArgsParser
property.ArgsParserImpl A straightforward implementation of theArgsParser
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.ArgsSyntax TheArgsSyntax
interface represents a node (and therewith the syntax for the arguments) in the command line arguments syntax tree; simply extending theSyntaxable
interface and adding the functionality of providing access to the addedOperand
s (leafs).ArrayOperand<T> Creates an array representation facade for the encapsulatedOperand
.ArrayOption<T> Creates an array representation facade for the encapsulatedOption
.CasesCondition TheCasesCondition
is anXorCondition
making sure that all possible cases inside theXorCondition
must(!)CharOption CleanFlag A predefined cleanFlag
: A predefinedFlag
gives itsCleanFlag.SHORT_OPTION
, itsCleanFlag.LONG_OPTION
as well as itsCleanFlag.ALIAS
an according semantics regarded by other subsystems.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.CliSugar Declarative syntactic sugar which may be statically imported in order to allow declarative definitions for the command lineFlag
,ArgsSyntax
,Option
andOperand
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 Interface indicating that theArgsSyntax
semantically represents a condition which usally encapsulates otherSyntaxable
children.ConfigOption TheConfigOption
represents anOption
holding a value specifying a configuration resource (file).DaemonFlag A predefined daemonFlag
: A predefinedFlag
gives itsDaemonFlag.SHORT_OPTION
, itsDaemonFlag.LONG_OPTION
as well as itsDaemonFlag.ALIAS
an according semantics regarded by other subsystems.DebugFlag A predefined debugFlag
: A predefinedFlag
gives itsDebugFlag.SHORT_OPTION
, itsDebugFlag.LONG_OPTION
as well as itsDebugFlag.ALIAS
an according semantics regarded by other subsystems.DoubleOption EnumOption<T extends Enum<T>> The Class EnumOption.Example An example usage item describing a usage scenario.FileOption Flag TheFlag
class implements theOption
interface for representing either atrue
or afalse
state: When a flag is provided to your command line arguments, then it is considered to betrue
, when it is omitted, then it is considered to befalse
as ofFlag.isEnabled()
.FloatOption ForceFlag A predefined forceFlag
: A predefinedFlag
gives itsForceFlag.SHORT_OPTION
, itsForceFlag.LONG_OPTION
as well as itsForceFlag.ALIAS
an according semantics regarded by other subsystems.HelpFlag A predefined helpFlag
: A predefinedFlag
gives itsHelpFlag.SHORT_OPTION
, itsHelpFlag.LONG_OPTION
as well as itsHelpFlag.ALIAS
an according semantics regarded by other subsystems.InitFlag A predefined initFlag
: A predefinedFlag
gives itsInitFlag.SHORT_OPTION
, itsInitFlag.LONG_OPTION
as well as itsInitFlag.ALIAS
an according semantics regarded by other subsystems.IntOption LongOption NoneOperand TheNoneOperand
represents an empty set of arguments, e.g. no command line argument is being passed.Operand<T> AnOperand
represents a value parsed from command line arguments.Operation TheOperation
is an argument representing a function or a method ("command") and is either provided or not provided as ofOperation.isEnabled()
.Option<T> AnOption
represents a command line option with the according option's value.OptionCondition OrCondition AnOrCondition
represents a list ofArgsSyntax
(Syntaxable
) instances of which at least one must be parsed successfully when theSyntaxable
s'Syntaxable.parseArgs(String[], String[])
methods are invoked.ParseArgsException Thrown in case the provided command line arguments do not respect the required syntax or cannot be converted to the required type.QuietFlag A predefined "be quiet"Flag
: A predefinedFlag
gives itsQuietFlag.SHORT_OPTION
, itsQuietFlag.LONG_OPTION
as well as itsQuietFlag.ALIAS
an according semantics regarded by other subsystems.RootConditionAccessor Provides an accessor for a root condition property.RootConditionAccessor.RootConditionBuilder<B extends RootConditionAccessor.RootConditionBuilder<B>> Provides a builder method for a root condition property returning the builder for applying multiple build operations.RootConditionAccessor.RootConditionMutator Provides a mutator for a root condition property.RootConditionAccessor.RootConditionProperty Provides a root condition property.StringOperand StringOption SuperfluousArgsException Thrown in case there were arguments found not being used (superfluous arguments).Synopsis Syntaxable ASyntaxable
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.SyntaxNotation TheSyntaxNotation
is used by a theSyntaxable.toSyntax(SyntaxNotation, String, String, String)
method to determine which notation to be used for the generated syntax.SysInfoFlag A predefined system informationFlag
: A predefinedFlag
gives itsSysInfoFlag.SHORT_OPTION
, itsSysInfoFlag.LONG_OPTION
as well as itsSysInfoFlag.ALIAS
an according semantics regarded by other subsystems..UnknownArgsException Thrown in case not one command line argument matched regarding the provided args vs. the expected args.VerboseFlag A predefined verboseFlag
: A predefinedFlag
gives itsVerboseFlag.SHORT_OPTION
, itsVerboseFlag.LONG_OPTION
as well as itsVerboseFlag.ALIAS
an according semantics regarded by other subsystems.XorCondition AnXorCondition
represents a list ofArgsSyntax
(Syntaxable
) instances of which only one is allowed to be parsed successfully when theSyntaxable.parseArgs(String[], String[])
methods are invoked.