- All Implemented Interfaces:
Cloneable
,Comparable<Operand<?>>
,MatchCountAccessor
,Operand<Boolean>
,ParsedArgsAccessor
,Synopsisable
,Term
,org.refcodes.exception.ExceptionAccessor<ArgsSyntaxException>
,org.refcodes.mixin.AliasAccessor
,org.refcodes.mixin.Clonable
,org.refcodes.mixin.DescriptionAccessor
,org.refcodes.mixin.EnabledAccessor
,org.refcodes.mixin.Resetable
,org.refcodes.mixin.Schemable
,org.refcodes.mixin.TypeAccessor<Boolean>
,org.refcodes.mixin.ValueAccessor<Boolean>
public class Operation
extends AbstractOperand<Boolean>
implements org.refcodes.mixin.EnabledAccessor
The
Operation
is an argument representing a function or a method
("command") and is either provided or not provided as of
isEnabled()
. It must neither be prefixed with "-" nor with "--" in
contrast to the Option
or the Flag
type.-
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.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.EnabledAccessor
org.refcodes.mixin.EnabledAccessor.EnabledBuilder<B extends org.refcodes.mixin.EnabledAccessor.EnabledBuilder<B>>, org.refcodes.mixin.EnabledAccessor.EnabledMutator, org.refcodes.mixin.EnabledAccessor.EnabledProperty
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.cli.ParsedArgsAccessor
ParsedArgsAccessor.ParsedArgsMutator, ParsedArgsAccessor.ParsedArgsProperty
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
Fields inherited from class org.refcodes.cli.AbstractOperand
_matchCount
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionclone()
Retrieves theArgsSyntaxException
exception in case invokingTerm.parseArgs(String[], CliContext)
failed.Returns the operation's name.boolean
Returns true if the switch has been set (enabled).parseArgs
(String[] aArgs, String[] aOptions, CliContext aCliContext) 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.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.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
.protected Boolean
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 org.refcodes.cli.AbstractOperand
approve, compareTo, getAlias, getMatchCount, getParsedArgs, getType, getValue, setParsedArgs, setValue, toSchema, toString
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
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, toSynopsis, toSyntax, toSyntax, toSyntax, toSyntax
Methods inherited from interface org.refcodes.mixin.ValueAccessor
getValueOr
-
Field Details
-
_description
-
_exception
-
-
Constructor Details
-
Operation
Constructs aOperation
with the given arguments.- Parameters:
aOperation
- The operation to declare.aDescription
- The description to be used (without any line breaks).
-
Operation
Constructs aOperation
with the given arguments. -
Operation
Constructs aOperation
with the given arguments.- Parameters:
aOperation
- The operation to declare.aAlias
- The operation's name to be used when constructing the syntax.aDescription
- The description to be used (without any line breaks).
-
Operation
public Operation(String aOperation, String aAlias, String aDescription, Consumer<Operation> aConsumer) Constructs aOperation
with the given arguments.- Parameters:
aOperation
- The operation to declare.aAlias
- The operation's name to be used when constructing the syntax.aDescription
- The description to be used (without any line breaks).aConsumer
- TheConsumer
being invoked in case thisOperation
participated in successfully parsing the command line arguments.
-
-
Method Details
-
clone
- Specified by:
clone
in interfaceorg.refcodes.mixin.Clonable
- Overrides:
clone
in classAbstractOperand<Boolean>
- Throws:
CloneNotSupportedException
-
getOperation
Returns the operation's name.- Returns:
- The according operation's name.
-
isEnabled
public boolean isEnabled()Returns true if the switch has been set (enabled).- Specified by:
isEnabled
in interfaceorg.refcodes.mixin.EnabledAccessor
- Returns:
- True in case the
Flag
has been provided (set), else false.
-
parseArgs
public Operand<Boolean>[] parseArgs(String[] aArgs, String[] aOptions, CliContext aCliContext) 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
- Overrides:
parseArgs
in classAbstractOperand<Boolean>
- 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.
-
reset
public void reset()- Specified by:
reset
in interfaceorg.refcodes.mixin.Resetable
- Overrides:
reset
in classAbstractOperand<Boolean>
-
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 classAbstractOperand<Boolean>
- Parameters:
aCliCtx
- TheCliContext
for which the syntax is being generated.- Returns:
- The human readable (verbose) command line arguments syntax.
-
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.- Specified by:
toType
in classAbstractOperand<Boolean>
- 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
-
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.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.
-