java.lang.Object
org.refcodes.cli.ArrayOperand<T>
- Type Parameters:
T
- the generic type
- All Implemented Interfaces:
Cloneable
,Comparable<Operand<?>>
,ArgsAccessor
,MatchCountAccessor
,Operand<T[]>
,Synopsisable
,Term
,org.refcodes.exception.ExceptionAccessor<ArgsSyntaxException>
,org.refcodes.mixin.AliasAccessor
,org.refcodes.mixin.Clonable
,org.refcodes.mixin.DescriptionAccessor
,org.refcodes.mixin.Resetable
,org.refcodes.mixin.Schemable
,org.refcodes.mixin.TypeAccessor<T[]>
,org.refcodes.mixin.ValueAccessor<T[]>
- Direct Known Subclasses:
ArrayOption
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.refcodes.mixin.AliasAccessor
org.refcodes.mixin.AliasAccessor.AliasBuilder<B extends org.refcodes.mixin.AliasAccessor.AliasBuilder<B>>, org.refcodes.mixin.AliasAccessor.AliasMutator, org.refcodes.mixin.AliasAccessor.AliasProperty
Nested classes/interfaces inherited from interface org.refcodes.cli.ArgsAccessor
ArgsAccessor.ArgsMutator, ArgsAccessor.ArgsProperty
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.mixin.TypeAccessor
org.refcodes.mixin.TypeAccessor.TypeBuilder<T extends Object,
B extends org.refcodes.mixin.TypeAccessor.TypeBuilder<T, B>>, org.refcodes.mixin.TypeAccessor.TypeMutator<T extends Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends Object> Nested classes/interfaces inherited from interface org.refcodes.mixin.ValueAccessor
org.refcodes.mixin.ValueAccessor.ValueBuilder<V extends Object,
B extends org.refcodes.mixin.ValueAccessor.ValueBuilder<V, B>>, org.refcodes.mixin.ValueAccessor.ValueMutator<V extends Object>, org.refcodes.mixin.ValueAccessor.ValueProperty<V extends Object> -
Field Summary
-
Constructor Summary
ConstructorDescriptionArrayOperand
(Operand<T> aOperand) Constructs theArrayOperand
by encapsulating the givenOperand
and providing its definition as array definition to the CLI.ArrayOperand
(Operand<T> aOperand, int aLength) Constructs theArrayOperand
by encapsulating the givenOperand
and providing its definition as array definition to the CLI.ArrayOperand
(Operand<T> aOperand, int aMinLength, int aMaxLength) Constructs theArrayOperand
by encapsulating the givenOperand
and providing its definition as array definition to the CLI. -
Method Summary
Modifier and TypeMethodDescriptionclone()
int
getAlias()
String[]
getArgs()
Retrieves the (command line) args which represent thisOperand
after being "parsed" (provided with command line args).Retrieves theArgsSyntaxException
exception in case invokingTerm.parseArgs(String[], CliContext)
failed.int
Determines the number of args being matched by theTerm.parseArgs(String[], CliContext)
(and similar) method(s) of the according syntax.int
Retrieves the maximum number of array elements to be present, e.g.int
Retrieves the minimum number of array elements to be present, e.g.Hook for accessing the encapsulatedOperand
.getType()
T[]
getValue()
Operand<?>[]
parseArgs
(String[] aArgs, String[] aOperands, 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
reset()
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.getArgs()
).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.getArgs()
).protected static String[]
toParsedArgs
(Operand<?>[]... aOperands) Takes allOperand
instances found in the providedList
s and adds all therein found argument arrays (as ofOperand.getArgs()
) to the result.toSchema()
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
.Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.refcodes.cli.Synopsisable
toSynopsis, toSynopsis, toSynopsis, toSynopsis
Methods inherited from interface org.refcodes.cli.Term
getException, parseArgs, toSynopsis, toSyntax, toSyntax, toSyntax, toSyntax
Methods inherited from interface org.refcodes.mixin.ValueAccessor
getValueOr
-
Field Details
-
_description
-
_exception
-
-
Constructor Details
-
ArrayOperand
Constructs theArrayOperand
by encapsulating the givenOperand
and providing its definition as array definition to the CLI.- Parameters:
aOperand
- TheOperand
which's array counterpart is to be defined.
-
ArrayOperand
Constructs theArrayOperand
by encapsulating the givenOperand
and providing its definition as array definition to the CLI.- Parameters:
aOperand
- TheOperand
which's array counterpart is to be defined.aLength
- The number of array elements, or -1 if there is no limit.
-
ArrayOperand
Constructs theArrayOperand
by encapsulating the givenOperand
and providing its definition as array definition to the CLI.- Parameters:
aOperand
- TheOperand
which's array counterpart is to be defined.aMinLength
- The minimum number of array elements, or -1 if there is no limit.aMaxLength
- The maximum number of array elements, or -1 if there is no limit.
-
-
Method Details
-
getMatchCount
public int getMatchCount()Determines the number of args being matched by theTerm.parseArgs(String[], CliContext)
(and similar) method(s) of the according syntax. This way we can determine which part of the syntax (tree) had most matches.- Specified by:
getMatchCount
in interfaceMatchCountAccessor
- Specified by:
getMatchCount
in interfaceTerm
- Returns:
- The number of args matching the according syntax (tree).
-
clone
- Specified by:
clone
in interfaceorg.refcodes.mixin.Clonable
- Overrides:
clone
in classObject
- Throws:
CloneNotSupportedException
-
compareTo
- Specified by:
compareTo
in interfaceComparable<T>
-
getAlias
Retrieves the name (alias) of the parameter value which can be the name of the operand (Operand
) or the option argument (Option
), depending on the sub-type inheriting from this interface. The parameter name is merely used for constructing the command line arguments syntaxString
viaTerm.toSyntax(CliContext)
and the command line arguments detail description when creating a command line tool's help output. Attention: The alias can also be used as a key when putting anOperand
's key/value-pair into a dictionary such as is done by theApplicationProperties
type provided by therefcodes-properties-ext-runime
artifact! -
getDescription
- Specified by:
getDescription
in interfaceorg.refcodes.mixin.DescriptionAccessor
-
getMaxLength
public int getMaxLength()Retrieves the maximum number of array elements to be present, e.g. maximum number of options provided in the command line arguments.- Returns:
- The maximum number of array elements, or -1 if there is no limit.
-
getMinLength
public int getMinLength()Retrieves the minimum number of array elements to be present, e.g. minimum number of options provided in the command line arguments.- Returns:
- The minimum number of array elements, or -1 if there is no limit.
-
getType
- Specified by:
getType
in interfaceorg.refcodes.mixin.TypeAccessor<T>
-
getValue
-
parseArgs
public Operand<?>[] parseArgs(String[] aArgs, String[] aOperands, 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.- Specified by:
parseArgs
in interfaceTerm
- Parameters:
aArgs
- The command line arguments to be parsed.aOperands
- 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.
-
reset
public void reset()- Specified by:
reset
in interfaceorg.refcodes.mixin.Resetable
-
getArgs
Retrieves the (command line) args which represent thisOperand
after being "parsed" (provided with command line args).- Specified by:
getArgs
in interfaceArgsAccessor
- Specified by:
getArgs
in interfaceOperand<T>
- Returns:
- The according args from the command line args.
-
toSchema
-
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
- Parameters:
aCliCtx
- TheCliContext
for which the syntax is being generated.- Returns:
- The human readable (verbose) command line arguments syntax.
-
getOperand
Hook for accessing the encapsulatedOperand
.- Returns:
- The according
Operand
.
-
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.
-
toArgsDiff
Creates the difference between the provided set and the providedList
s therein found argument arrays subset (as ofOperand.getArgs()
).- 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.getArgs()
).- 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.getArgs()
) to the result.
-