- java.lang.Object
-
- org.refcodes.cli.AbstractCondition
-
- org.refcodes.cli.OptionCondition
-
- All Implemented Interfaces:
ArgsSyntax
,Condition
,Synopsis
,Syntaxable
,org.refcodes.component.Resetable
public class OptionCondition extends AbstractCondition implements Condition
-
-
Constructor Summary
Constructors Constructor Description OptionCondition(Option<?> aArg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<? extends Operand<?>>
parseArgs(String[] aArgs, String[] aOptions)
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.String
toState()
TheSyntaxable.toState()
method might be used by theObject.toString()
method and prints out the state of the syntaxable and (if any) its children.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.String
toSyntax(SyntaxNotation aSyntaxNotation, String aOptEscCode, String aParamEscCode, String aResetEscCode)
This method is to be called from inside theSyntaxable
hierarchy; use the methodSynopsis.toSynopsis(SyntaxNotation)
in case you invoke syntax retrieval from the rootSyntaxable
.-
Methods inherited from class org.refcodes.cli.AbstractCondition
addChild, getChildren, getFirst, reset, toOperand, toOperands, 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.ArgsSyntax
toOperand, toOperand, toOperand, toOperands
-
Methods inherited from interface org.refcodes.cli.Synopsis
toSynopsis, toSynopsis, toSynopsis, toSynopsis
-
-
-
-
Constructor Detail
-
OptionCondition
public OptionCondition(Option<?> aArg)
- Parameters:
aArg
- TheOption
(Syntaxable
) instance to be wrapped
-
-
Method Detail
-
parseArgs
public List<? extends Operand<?>> parseArgs(String[] aArgs, String[] aOptions) throws UnknownArgsException, AmbiguousArgsException, ParseArgsException, SuperfluousArgsException
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
- 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:
UnknownArgsException
- Thrown in case not one command line argument matched regarding the provided args vs. the expected args.AmbiguousArgsException
- Thrown in case at least one command line argument is ambiguous regarding expected args vs. provided args.ParseArgsException
- Thrown in case the provided command line arguments do not respect the required syntax or cannot be converted to the required typeSuperfluousArgsException
- in case there were arguments found not being used (superfluous arguments), thrown only in very specific cases (throw with care!).
-
toSyntax
public String toSyntax(SyntaxNotation aSyntaxNotation, String aOptEscCode, String aParamEscCode, String aResetEscCode)
This method is to be called from inside theSyntaxable
hierarchy; use the methodSynopsis.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 isSynopsis.toSynopsis(SyntaxNotation)
, as for some notations it will for example not create the most outer braces.- Specified by:
toSyntax
in interfaceSyntaxable
- Overrides:
toSyntax
in classAbstractCondition
- 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.
-
toState
public String toState()
TheSyntaxable.toState()
method might be used by theObject.toString()
method and prints out the state of the syntaxable and (if any) its children. Even in case parsing command line arguments failed, the state till failure can be inspected with this method.- Specified by:
toState
in interfaceSyntaxable
- Returns:
- The state of this
Syntaxable
instance and (if any) its children.
-
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 isSynopsis.toSynopsis(SyntaxNotation)
, as for some notations it will for example not create the most outer braces.- Specified by:
toSynopsis
in interfaceSynopsis
- 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.
-
-