- All Implemented Interfaces:
Cloneable
,Comparable<Operand<?>>
,ArgsAccessor
,Operand<Boolean>
,Synopsisable
,Syntaxable
,org.refcodes.mixin.AliasAccessor
,org.refcodes.mixin.Clonable
,org.refcodes.mixin.DescriptionAccessor
,org.refcodes.mixin.EnabledAccessor
,org.refcodes.mixin.Resetable
,org.refcodes.mixin.Schemable<CliSchema>
,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.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.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.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
_value
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionclone()
Returns the operation's name.boolean
Returns true if the switch has been set (enabled).Parses the provided command line arguments and determines the according values by evaluating thisSyntaxable
instance or, in case of being a node in the syntax tree (such as aArgsSyntax
, traversing the childSyntaxable
instances'Syntaxable.parseArgs(String[], String[])
methods.void
reset()
toSynopsis
(SyntaxNotation aSyntaxNotation, String aOptEscCode, String aParamEscCode, String aResetEscCode) Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the rootSyntaxable
and the childSyntaxable
s, the methodSyntaxable.toSyntax(SyntaxNotation, String, String, String)
is called from inside aSyntaxable
hierarchy.toSyntax
(SyntaxNotation aSyntaxNotation, String aOptEscCode, String aParamEscCode, String aResetEscCode) This method is to be called from inside theSyntaxable
hierarchy; use the methodSynopsisable.toSynopsis(SyntaxNotation)
in case you invoke syntax retrieval from the rootSyntaxable
.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
compareTo, getAlias, getArgs, getDescription, getType, getValue, setArgs, setValue, toSchema, toState, toString
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.refcodes.cli.Synopsisable
toSynopsis, toSynopsis, toSynopsis, toSynopsis
Methods inherited from interface org.refcodes.cli.Syntaxable
parseArgs, toSyntax, toSyntax, toSyntax
Methods inherited from interface org.refcodes.mixin.ValueAccessor
getValueOr
-
Constructor Details
-
Operation
Constructs aOperation
with the given arguments.- Parameters:
aOperation
- The operation to declare.aDescription
- A description without any line breaks.
-
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
- A description without any line breaks.
-
-
Method Details
-
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 List<Operand<Boolean>> parseArgs(String[] aArgs, String[] aOptions) throws ArgsSyntaxException Parses the provided command line arguments and determines the according values by evaluating thisSyntaxable
instance or, in case of being a node in the syntax tree (such as aArgsSyntax
, traversing the childSyntaxable
instances'Syntaxable.parseArgs(String[], String[])
methods. In case of successfully parsing thisSyntaxable
and / or the childSyntaxable
instances, the evaluated command line arguments are returned: Depending on theSyntaxable
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 theSyntaxable
instance being traversed. This method is commonly used by a rootSyntaxable
'sArgsParser.evalArgs(String[])
method, which delegates to theSyntaxable.parseArgs(String[], String[])
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'sSyntaxable.parseArgs(String[], String[])
method as ignoring superfluous command line arguments will cause unexpected behavior from the point of view of the invoker.- Specified by:
parseArgs
in interfaceSyntaxable
- 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.- 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.
-
getOperation
Returns the operation's name.- Returns:
- The according operation's name.
-
clone
- Specified by:
clone
in interfaceorg.refcodes.mixin.Clonable
- Overrides:
clone
in classAbstractOperand<Boolean>
- Throws:
CloneNotSupportedException
-
toSyntax
public String toSyntax(SyntaxNotation aSyntaxNotation, String aOptEscCode, String aParamEscCode, String aResetEscCode) This method is to be called from inside theSyntaxable
hierarchy; use the methodSynopsisable.toSynopsis(SyntaxNotation)
in case you invoke syntax retrieval from the rootSyntaxable
. Returns the human readable (verbose) syntax of thisSyntaxable
instance including, in case of being a node in the syntax tree (such as aArgsSyntax
, the syntax of the childSyntaxable
instances. ATTENTION: As of different parenthesis settings for some notations regarding the rootSyntaxable
and the childSyntaxable
s, the methodSyntaxable.toSyntax(SyntaxNotation, String, String, String)
is called from inside theSyntaxable
hierarchy. In case the syntax is to be retrieved from the rootSyntaxable
, 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 interfaceSyntaxable
- Overrides:
toSyntax
in classAbstractOperand<Boolean>
- Parameters:
aSyntaxNotation
- The syntax notation used for generating the command line arguments syntax.aOptEscCode
- The escape code to be used when processing an option, e.g. this can be an ANSI Escape-Code to highlight the option.aParamEscCode
- The escape code to be used when processing a keyword, e.g. this can be an ANSI Escape-Code to highlight the option and/or parameters.aResetEscCode
- The escape code to close (reset) any Escape-Code being set before.- Returns:
- The human readable (verbose) command line arguments syntax.
-
reset
public void reset()- Specified by:
reset
in interfaceorg.refcodes.mixin.Resetable
- Overrides:
reset
in classAbstractOperand<Boolean>
-
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.
-
toSynopsis
public String toSynopsis(SyntaxNotation aSyntaxNotation, String aOptEscCode, String aParamEscCode, String aResetEscCode) Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the rootSyntaxable
and the childSyntaxable
s, the methodSyntaxable.toSyntax(SyntaxNotation, String, String, String)
is called from inside aSyntaxable
hierarchy. In case the syntax is to be retrieved from the rootSyntaxable
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 interfaceSynopsisable
- Parameters:
aSyntaxNotation
- The syntax notation used for generating the command line arguments syntax.aOptEscCode
- The escape code to be used when processing an option, e.g. this can be an ANSI Escape-Code to highlight the option.aParamEscCode
- The escape code to be used when processing am argument, e.g. this can be an ANSI Escape-Code to highlight the option.aResetEscCode
- The escape code to close (reset) any Escape-Code being set before.- Returns:
- The human readable (verbose) command line arguments syntax.
-