java.lang.Object
org.refcodes.cli.AbstractCondition
org.refcodes.cli.AndCondition
- All Implemented Interfaces:
Condition
,Constituent
,Synopsisable
,org.refcodes.mixin.DescriptionAccessor
,org.refcodes.mixin.Resetable
,org.refcodes.mixin.Schemable<CliSchema>
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. The
command line arguments syntax -a & -b & -c
specifies
that all "-a", "-b" and "-c" must be set. In case at least one is not set,
then the AndCondition
will terminate the
parseArgs(String[], String[], CliContext)
method with an exception.
If one argument is optional, then consider nesting it in an
AnyCondition
.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.refcodes.mixin.DescriptionAccessor
org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<B extends org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<B>>, org.refcodes.mixin.DescriptionAccessor.DescriptionMutator, org.refcodes.mixin.DescriptionAccessor.DescriptionProperty
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionparseArgs
(String[] aArgs, String[] aOptions, CliContext aCliCtx) Parses the provided command line arguments and determines the according values by evaluating thisConstituent
instance or, in case of being a node in the syntax tree (such as aCondition
, traversing the childConstituent
instances'Constituent.parseArgs(String[], String[], CliContext)
methods.toSynopsis
(CliContext aCliCtx) Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the rootConstituent
and the childConstituent
s, the methodConstituent.toSyntax(CliContext)
is called from inside aConstituent
hierarchy.toSyntax
(CliContext aCliCtx) This method is to be called from inside theConstituent
hierarchy; use the methodSynopsisable.toSynopsis(SyntaxNotation)
in case you invoke syntax retrieval from the rootConstituent
.Methods inherited from class org.refcodes.cli.AbstractCondition
addChild, getChildren, getFirst, reset, toOperand, toOperands, toSchema, toString, toValue
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.refcodes.cli.Condition
toOperand, toOperand, toOperand, toOperands
Methods inherited from interface org.refcodes.cli.Constituent
parseArgs, toSyntax, toSyntax, toSyntax, toSyntax, toValue
Methods inherited from interface org.refcodes.mixin.DescriptionAccessor
getDescription
Methods inherited from interface org.refcodes.mixin.Resetable
reset
Methods inherited from interface org.refcodes.mixin.Schemable
toSchema
Methods inherited from interface org.refcodes.cli.Synopsisable
toSynopsis, toSynopsis, toSynopsis, toSynopsis
-
Field Details
-
_description
-
-
Constructor Details
-
AndCondition
- Parameters:
aArgs
- TheConstituent
(Condition
) instances to be nested.
-
-
Method Details
-
parseArgs
public List<? extends Operand<?>> parseArgs(String[] aArgs, String[] aOptions, CliContext aCliCtx) throws ArgsSyntaxException Parses the provided command line arguments and determines the according values by evaluating thisConstituent
instance or, in case of being a node in the syntax tree (such as aCondition
, traversing the childConstituent
instances'Constituent.parseArgs(String[], String[], CliContext)
methods. In case of successfully parsing thisConstituent
and / or the childConstituent
instances, the evaluated command line arguments are returned: Depending on theConstituent
subclasses representing the evaluated command line arguments, instances ofFlag
classes,Option
classes orOperand
classes may be found in the result. In case of parsing failure, an according exception is thrown. ATTENTION: This method does not test for superfluous command line arguments being passed; e.g. command line arguments not being evaluated by any of theConstituent
instance being traversed. This method is commonly used by a rootConstituent
'sArgsParser.evalArgs(String[])
method, which delegates to theConstituent.parseArgs(String[], String[], CliContext)
method and after which it determines whether there are superfluous arguments to be taken care of (by throwing an according exception). Business logic therefore should invoke the root node'sConstituent.parseArgs(String[], String[], CliContext)
method as ignoring superfluous command line arguments will cause unexpected behavior from the point of view of the invoker.- Specified by:
parseArgs
in interfaceConstituent
- Parameters:
aArgs
- The command line arguments to be parsed.aOptions
- The list of options (short and as well as long) which are reserved and cannot be used as value.aCliCtx
- the cli context- Returns:
- The list of evaluated command line arguments being instances of
the
Operand
interfaces or its sub-types. - Throws:
ArgsSyntaxException
- thrown in case of a command line arguments mismatch regarding provided and expected args.
-
toSyntax
This method is to be called from inside theConstituent
hierarchy; use the methodSynopsisable.toSynopsis(SyntaxNotation)
in case you invoke syntax retrieval from the rootConstituent
. Returns the human readable (verbose) syntax of thisConstituent
instance including, in case of being a node in the syntax tree (such as aCondition
, the syntax of the childConstituent
instances. ATTENTION: As of different parenthesis settings for some notations regarding the rootConstituent
and the childConstituent
s, the methodConstituent.toSyntax(CliContext)
is called from inside theConstituent
hierarchy. In case the syntax is to be retrieved from the rootConstituent
, then the applicable method to be called isSynopsisable.toSynopsis(SyntaxNotation)
, as for some notations it will for example not create the most outer braces.- Specified by:
toSyntax
in interfaceConstituent
- Overrides:
toSyntax
in classAbstractCondition
- Parameters:
aCliCtx
- TheCliContext
for which the syntax is being generated.- Returns:
- The human readable (verbose) command line arguments syntax.
-
toSynopsis
Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the rootConstituent
and the childConstituent
s, the methodConstituent.toSyntax(CliContext)
is called from inside aConstituent
hierarchy. In case the syntax is to be retrieved from the rootConstituent
or an encapsulating and different type, then the applicable method to be called isSynopsisable.toSynopsis(SyntaxNotation)
, as for some notations it will for example not create the most outer braces.- Specified by:
toSynopsis
in interfaceConstituent
- Specified by:
toSynopsis
in interfaceSynopsisable
- Parameters:
aCliCtx
- TheCliContext
for which the syntax is being generated.- Returns:
- The human readable (verbose) command line arguments syntax.
-
getDescription
- Specified by:
getDescription
in interfaceorg.refcodes.mixin.DescriptionAccessor
-