java.lang.Object
org.refcodes.cli.AbstractOperand<T>
- Type Parameters:
T
- the generic type
- All Implemented Interfaces:
Cloneable
,Comparable<Operand<?>>
,ArgsAccessor
,Constituent
,Operand<T>
,Synopsisable
,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:
AbstractOption
,NoneOperand
,Operation
,StringOperand
The
AbstractOperand
is an abstract implementation of an
Operand
providing the boiler plate when implementing the
Operand
interface.-
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.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
-
Method Summary
Modifier and TypeMethodDescriptionclone()
int
getAlias()
getType()
getValue()
parseArgs
(String[] aArgs, String[] aOptions, CliContext aCliContext) 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.void
reset()
protected void
setParsedArgs
(String[] aArgs) Sets the command line argument(s) representing theOperand
and its value as parsed by theparseArgs(String[], String[], CliContext)
method.protected void
Sets the value for theOperand
as parsed by theparseArgs(String[], String[], CliContext)
method.String[]
Retrieves the (command line) args which represent thisOperand
after being "parsed" (provided with command line args).toSchema()
toString()
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
.protected abstract T
Double dispatch hook to be implemented by subclasses of theAbstractOperand
for converting a command line argument to the requiredOperand
's type.Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.refcodes.cli.Constituent
parseArgs, toSynopsis, toSyntax, toSyntax, toSyntax, toSyntax
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.mixin.ValueAccessor
getValueOr
-
Field Details
-
_value
-
_description
-
-
Constructor Details
-
AbstractOperand
Constructs aOperand
with the given arguments.- Parameters:
aType
- The type of the value returned by thegetValue()
method.aAlias
- TheOperand
's name, used for syntax creation.aDescription
- The description to be used (without any line breaks).
-
AbstractOperand
Instantiates a new operand.- Parameters:
aProperty
- The key (= alias) and the value for the operand.aType
- the type
-
-
Method Details
-
parseArgs
public List<Operand<T>> parseArgs(String[] aArgs, String[] aOptions, CliContext aCliContext) 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 aCause 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.aCliContext
- 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
- Parameters:
aCliCtx
- TheCliContext
for which the syntax is being generated.- Returns:
- The human readable (verbose) command line arguments syntax.
-
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
viaConstituent.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! -
getType
- Specified by:
getType
in interfaceorg.refcodes.mixin.TypeAccessor<T>
-
getValue
-
toParsedArgs
Retrieves the (command line) args which represent thisOperand
after being "parsed" (provided with command line args).- Specified by:
toParsedArgs
in interfaceArgsAccessor
- Specified by:
toParsedArgs
in interfaceOperand<T>
- Returns:
- The according args from the command line args.
-
reset
public void reset()- Specified by:
reset
in interfaceorg.refcodes.mixin.Resetable
-
toString
-
compareTo
- Specified by:
compareTo
in interfaceComparable<T>
-
clone
- Specified by:
clone
in interfaceorg.refcodes.mixin.Clonable
- Overrides:
clone
in classObject
- Throws:
CloneNotSupportedException
-
toSchema
- Specified by:
toSchema
in interfaceConstituent
- Specified by:
toSchema
in interfaceorg.refcodes.mixin.Schemable
-
setValue
Sets the value for theOperand
as parsed by theparseArgs(String[], String[], CliContext)
method.- Parameters:
aValue
- The value to be set for thisOperand
.
-
setParsedArgs
Sets the command line argument(s) representing theOperand
and its value as parsed by theparseArgs(String[], String[], CliContext)
method.- Parameters:
aArgs
- The command line arguments representing thisOperand
with its value.
-
toType
Double dispatch hook to be implemented by subclasses of theAbstractOperand
for converting a command line argument to the requiredOperand
's type. In case conversion failed, then an according exception is to be thrown.- Parameters:
aArg
- The command line argument to be converted to an instance of the given type T.- Returns:
- An instance of type T from the provided command line argument.
- Throws:
ParseArgsException
- Thrown in case the provided command line arguments do not respect the required syntax or cannot be converted to the required type.
-
getDescription
- Specified by:
getDescription
in interfaceorg.refcodes.mixin.DescriptionAccessor
-