AbstractCondition
is an abstract implementation of an
Condition
providing the boiler plate when implementing the
Condition
interface.AbstractOperand
is an abstract implementation of an
Operand
providing the boiler plate when implementing the
Operand
interface.Operand
with the given arguments.AbstractOption
is an abstract implementation of an Option
providing the boiler plate when implementing the Option
interface.Option
with the given arguments.Option
with the given arguments.AbstractSyntaxable
just implements the
#evalArgs(String[])
method which delegates to the
Syntaxable.parseArgs(String[])
method and determines the superfluous arguments.AndConditionImpl
represents a list of Syntaxable
instances
of which all are be parsed successfully when the Syntaxable
s'
Syntaxable.parseArgs(String[])
methods are invoked.ArgsParser
provides means for parsing command line arguments and
constructing a command line utility's help output.ArgsParser
interface.ArgsParser
instance with the given root
Condition
and the default SyntaxNotation.REFCODES
.Condition
interface represents a node in the command line
arguments syntax tree; simply extending the Syntaxable
interface and
adding the functionality of providing access to the added Operand
s
(leafs).ArgsParser.withConsoleWidth(int)
method.Condition
.ArgsParser.evalArgs(String[])
with the difference that the elements
representing the arguments are passed as a list instead of an array.Syntaxable.parseArgs(String[])
method, then the
Operand.getArgs()
method returns the command line arguments representing
this Operand
instance (also including the short or the long
options, see Operand
).Option
instance.Syntaxable
hierarchy to be traversed when determining the syntax for command line
arguments or when evaluating the command line arguments.Option
instance.Syntaxable.parseArgs(String[])
method, then the
Operand.getValue()
method returns the parsed value.Operand
represents a value parsed from command line arguments.An
Operand
has a state which changes with each invocation of the
Syntaxable.parseArgs(String[])
method.Option
represents a command line option with the according
option's value.ConsoleConsts
interface;
being the ConsoleConsts.SHORT_OPTION_PREFIX
and the
"--".OrConditionImpl
represents a list of Syntaxable
instances
of which at least one must be parsed successfully when the Syntaxable
s' Syntaxable.parseArgs(String[])
methods are invoked.impls
package contains implementations of the types defined
by this artifact.Syntaxable
instance or, in case of
being a node in the syntax tree (such as a Condition
, traversing
the child Syntaxable
instances' Syntaxable.parseArgs(String[])
methods.Syntaxable
; when
invoking syntax retrieval inside the Syntaxable
hierarchy use the
method Syntaxable.toSyntax(SyntaxNotation)
.ArgsParser.withCopyrightNote(String)
method; with regards to to the console
width as specified by the ArgsParser.withConsoleWidth(int)
method.ArgsParser.withDescription(String)
method with regards to the console width as specified by the
ArgsParser.withConsoleWidth(int)
method.ArgsParser.withStandardOut(PrintStream)
method.ArgsParser.withLicenseNote(String)
method; with regards to to the console
width as specified by the ArgsParser.withConsoleWidth(int)
method.ArgsParser.withConsoleWidth(int)
method.Option
s (short- and the long-options), the
Switch
es and the Operator
and their description with
regards to the console width as specified by the
ArgsParser.withConsoleWidth(int)
method.ArgsParser.withSeparatorChar(char)
method; with regards to to the console
width as specified by the ArgsParser.withConsoleWidth(int)
method.Condition#
with
regards to the SyntaxNotation
set by the
ArgsParser.withSyntaxNotation(SyntaxNotation)
method; making use of the
usage label as passed by the ArgsParser.withUsageLabel(String)
method.Operand
and
its value as parsed by the AbstractOperand.parseArgs(String[])
method.ArgsParser.printHelp()
method when
writing out the copyright claim and make other adjustments with the
result (with regards to the builder pattern).PrintStream
and make other adjustments with the
result (with regards to the builder pattern).ArgsParser.printHelp()
method when writing
out the licensing conditions.ArgsParser.printSeparatorLn()
method.PrintStream
and make other adjustments with
the result (with regards to the builder pattern).SyntaxNotation
.ArgsParser.printHelp()
method when writing
out the syntax.Operand
as parsed by the
AbstractOperand.parseArgs(String[])
method.Switch
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.SyntaxNotation
is used by a the
Syntaxable.toSyntax(SyntaxNotation)
method to determine which
notation to be used for the generated syntax.Operand
instances found in the provided List
s
and adds all therein found argument arrays (as of
Operand.getArgs()
) to the result.List
s therein found argument arrays subset (as of
Operand.getArgs()
).Operand
;Operand
.Operand
consisting of the
options specification (if any) as of ConsoleUtility.toOptionsSpec(Operand)
and
the parameter specification (if any) as of
ConsoleUtility.toParameterSpec(Operand)
.Syntaxable.toState()
method might be used by the #toString()
method and prints out the state of the syntaxable and (if any) its
children.Syntaxable
hierarchy;
use the method Syntaxable.parseSyntax(SyntaxNotation)
in case you invoke
syntax retrieval from the root Syntaxable
.AbstractOperand
for converting a command line argument to the
required Operand
's type.ArgsParser.printHelp()
method when
writing out the copyright claim and make other adjustments with the
result (with regards to the builder pattern).PrintStream
and make other adjustments with the
result (with regards to the builder pattern).ArgsParser.printHelp()
method when writing
out the licensing conditions and make other adjustments with the result
(with regards to the builder pattern).ArgsParser.printSeparatorLn()
method.PrintStream
and make other adjustments with
the result (with regards to the builder pattern).SyntaxNotation
and make other adjustments with the result
(with regards to the builder pattern).ArgsParser.printHelp()
method when writing
out the syntax and make other adjustments with the result (with regards
to the builder pattern).XorConditionImpl
represents a list of Syntaxable
instances
of which only one is allowed to be parsed successfully when the
Syntaxable
s' Syntaxable.parseArgs(String[])
methods are
invoked.Copyright © 2016. All rights reserved.