java.lang.Object
org.refcodes.cli.AbstractCondition
org.refcodes.cli.AllCondition
- All Implemented Interfaces:
Condition
,MatchCountAccessor
,Synopsisable
,Term
,org.refcodes.exception.ExceptionAccessor<ArgsSyntaxException>
,org.refcodes.graphical.VisibleAccessor
,org.refcodes.graphical.VisibleAccessor.VisibleBuilder<Term>
,org.refcodes.graphical.VisibleAccessor.VisibleMutator
,org.refcodes.graphical.VisibleAccessor.VisibleProperty
,org.refcodes.mixin.ChildrenAccessor<Term[]>
,org.refcodes.mixin.DescriptionAccessor
,org.refcodes.mixin.Resetable
,org.refcodes.schema.Schemable
The
AllCondition
enforces that the encapsulated Term
consumes
all arguments passed via invoking its
Term.parseArgs(String[], CliContext)
, else a
SuperfluousArgsException
is thrown. This enables the construction of
a syntax which otherwise would not be unambiguous when encapsulated within an
XorCondition
.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.refcodes.mixin.ChildrenAccessor
org.refcodes.mixin.ChildrenAccessor.ChildrenBuilder<T,
B extends org.refcodes.mixin.ChildrenAccessor.ChildrenBuilder<T, B>>, org.refcodes.mixin.ChildrenAccessor.ChildrenMutator<T>, org.refcodes.mixin.ChildrenAccessor.ChildrenProperty<T> 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
Nested classes/interfaces inherited from interface org.refcodes.exception.ExceptionAccessor
org.refcodes.exception.ExceptionAccessor.ExceptionBuilder<EXC extends Throwable,
B extends org.refcodes.exception.ExceptionAccessor.ExceptionBuilder<EXC, B>>, org.refcodes.exception.ExceptionAccessor.ExceptionMutator<EXC extends Throwable>, org.refcodes.exception.ExceptionAccessor.ExceptionProperty<EXC extends Throwable> Nested classes/interfaces inherited from interface org.refcodes.cli.MatchCountAccessor
MatchCountAccessor.MatchCountBuilder<B extends MatchCountAccessor.MatchCountBuilder<B>>, MatchCountAccessor.MatchCountMutator, MatchCountAccessor.MatchCountProperty
Nested classes/interfaces inherited from interface org.refcodes.graphical.VisibleAccessor
org.refcodes.graphical.VisibleAccessor.VisibleBuilder<B extends org.refcodes.graphical.VisibleAccessor.VisibleBuilder<B>>, org.refcodes.graphical.VisibleAccessor.VisibleMutator, org.refcodes.graphical.VisibleAccessor.VisibleProperty
-
Field Summary
Modifier and TypeFieldDescriptionprotected String
protected ArgsSyntaxException
protected boolean
Fields inherited from class org.refcodes.cli.AbstractCondition
_children
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected Term
getChild()
Returns the one and only child of thisTerm
.Retrieves theArgsSyntaxException
exception in case invokingTerm.parseArgs(String[], CliContext)
failed.Operand<?>[]
parseArgs
(String[] aArgs, String[] aOptions, CliContext aCliCtx) Parses the provided command line arguments and determines the according values by evaluating thisTerm
instance or, in case of being a node in the syntax tree (such as aCondition
, traversing the childTerm
instances'Term.parseArgs(String[], String[], CliContext)
methods.void
setVisible
(boolean isVisible) Visibility in this context means displaying or hiding thisTerm
's existence to the user (defaults totrue
).protected static String[]
toArgsDiff
(String[] aArgs, String[] aArgsSubset) Creates the difference between the provided set and the provided subset.protected static String[]
toArgsDiff
(String[] aArgs, List<? extends Operand<?>> aArgsSubset) Creates the difference between the provided set and the providedList
s therein found argument arrays subset (as ofOperand.getParsedArgs()
).protected static String[]
toArgsDiff
(String[] aArgs, Operand<?>[] aArgsSubset) Creates the difference between the provided set and the providedList
s therein found argument arrays subset (as ofOperand.getParsedArgs()
).protected static String[]
toParsedArgs
(Operand<?>[]... aOperands) Takes allOperand
instances found in the providedList
s and adds all therein found argument arrays (as ofOperand.getParsedArgs()
) to the result.toSynopsis
(CliContext aCliCtx) Returns the human readable (verbose) syntax of the implementing class ATTENTION: As of different parenthesis settings for some notations regarding the rootTerm
and the childTerm
s, the methodTerm.toSyntax(CliContext)
is called from inside aTerm
hierarchy.toSyntax
(CliContext aCliCtx) This method is to be called from inside theTerm
hierarchy; use the methodSynopsisable.toSynopsis(SyntaxNotation)
in case you invoke syntax retrieval from the rootTerm
.withVisible
(boolean isVisible) Visibility in this context means displaying or hiding thisTerm
's existence to the user (defaults totrue
).Methods inherited from class org.refcodes.cli.AbstractCondition
getChildren, getMatchCount, isVisible, 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
hasChild, isChild, toConditions, toOperand, toOperand, toOperands
Methods inherited from interface org.refcodes.mixin.DescriptionAccessor
getDescription
Methods inherited from interface org.refcodes.cli.Synopsisable
toSynopsis, toSynopsis, toSynopsis, toSynopsis
Methods inherited from interface org.refcodes.cli.Term
getException, parseArgs, setVisible, toSyntax, toSyntax, toSyntax, toSyntax
Methods inherited from interface org.refcodes.graphical.VisibleAccessor.VisibleBuilder
withHide, withShow
Methods inherited from interface org.refcodes.graphical.VisibleAccessor.VisibleMutator
hide, show
Methods inherited from interface org.refcodes.graphical.VisibleAccessor.VisibleProperty
letVisible
-
Field Details
-
_description
-
_exception
-
_isVisible
protected boolean _isVisible
-
-
Constructor Details
-
AllCondition
-
-
Method Details
-
parseArgs
public Operand<?>[] parseArgs(String[] aArgs, String[] aOptions, CliContext aCliCtx) throws ArgsSyntaxException Parses the provided command line arguments and determines the according values by evaluating thisTerm
instance or, in case of being a node in the syntax tree (such as aCondition
, traversing the childTerm
instances'Term.parseArgs(String[], String[], CliContext)
methods. In case of successfully parsing thisTerm
and / or the childTerm
instances, the evaluated command line arguments are returned: Depending on theTerm
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 theTerm
instance being traversed. This method is commonly used by a rootTerm
'sParseArgs.evalArgs(String[])
method, which delegates to theTerm.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'sTerm.parseArgs(String[], String[], CliContext)
method as ignoring superfluous command line arguments will aCause unexpected behavior from the point of view of the invoker.- 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.
-
toSynopsis
Returns the human readable (verbose) syntax of the implementing class ATTENTION: As of different parenthesis settings for some notations regarding the rootTerm
and the childTerm
s, the methodTerm.toSyntax(CliContext)
is called from inside aTerm
hierarchy. In case the syntax is to be retrieved from the rootTerm
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.- Parameters:
aCliCtx
- TheCliContext
for which the syntax is being generated.- Returns:
- The human readable (verbose) command line arguments syntax.
-
toSyntax
This method is to be called from inside theTerm
hierarchy; use the methodSynopsisable.toSynopsis(SyntaxNotation)
in case you invoke syntax retrieval from the rootTerm
. Returns the human readable (verbose) syntax of thisTerm
instance including, in case of being a node in the syntax tree (such as aCondition
, the syntax of the childTerm
instances. ATTENTION: As of different parenthesis settings for some notations regarding the rootTerm
and the childTerm
s, the methodTerm.toSyntax(CliContext)
is called from inside theTerm
hierarchy. In case the syntax is to be retrieved from the rootTerm
, 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 interfaceTerm
- Overrides:
toSyntax
in classAbstractCondition
- Parameters:
aCliCtx
- TheCliContext
for which the syntax is being generated.- Returns:
- The human readable (verbose) command line arguments syntax.
-
withVisible
Visibility in this context means displaying or hiding thisTerm
's existence to the user (defaults totrue
). -
getChild
-
getDescription
- Specified by:
getDescription
in interfaceorg.refcodes.mixin.DescriptionAccessor
-
getException
Retrieves theArgsSyntaxException
exception in case invokingTerm.parseArgs(String[], CliContext)
failed. The exception (and the according suppressed ones alongside the causes) does not necessarily have been thrown by theTerm.parseArgs(String[], CliContext)
method depending on the semantics of theTerm
handing the exception (theAnyCondition
provides any exceptions it caught even though it did not throw them as of its semantics).- Specified by:
getException
in interfaceorg.refcodes.exception.ExceptionAccessor<ArgsSyntaxException>
- Specified by:
getException
in interfaceTerm
- Returns:
- The
ArgsSyntaxException
exception occurring while parsing the arguments.
-
setVisible
public void setVisible(boolean isVisible) Visibility in this context means displaying or hiding thisTerm
's existence to the user (defaults totrue
).- Specified by:
setVisible
in interfaceTerm
- Specified by:
setVisible
in interfaceorg.refcodes.graphical.VisibleAccessor.VisibleMutator
-
toArgsDiff
Creates the difference between the provided set and the providedList
s therein found argument arrays subset (as ofOperand.getParsedArgs()
).- Parameters:
aArgs
- The set to be used for the diff operation.aArgsSubset
- The subset to be used for the diff operation being the lists containing theOperand
instances whose command line arguments are to be diffed.- Returns:
- The difference between the set and the subset.
-
toArgsDiff
Creates the difference between the provided set and the providedList
s therein found argument arrays subset (as ofOperand.getParsedArgs()
).- Parameters:
aArgs
- The set to be used for the diff operation.aArgsSubset
- The subset to be used for the diff operation being the lists containing theOperand
instances whose command line arguments are to be diffed.- Returns:
- The difference between the set and the subset.
-
toArgsDiff
Creates the difference between the provided set and the provided subset.- Parameters:
aArgs
- The set to be used for the diff operation.aArgsSubset
- The subset to be used for the diff operation.- Returns:
- The difference between the set and the subset.
-
toParsedArgs
Takes allOperand
instances found in the providedList
s and adds all therein found argument arrays (as ofOperand.getParsedArgs()
) to the result.
-