Package org.refcodes.console
Class OptionalConditionImpl
- java.lang.Object
-
- org.refcodes.console.AbstractCondition
-
- org.refcodes.console.OptionalConditionImpl
-
- All Implemented Interfaces:
org.refcodes.component.Resetable
,Condition
,Syntaxable
,SyntaxUsage
public class OptionalConditionImpl extends AbstractCondition
The Class OptionalConditionImpl.- Author:
- steiner
-
-
Constructor Summary
Constructors Constructor Description OptionalConditionImpl(Syntaxable... aSyntaxable)
Instantiates a new optional condition impl.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<? extends Operand<?>>
parseArgs(java.lang.String[] aArgs)
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 aCondition
, traversing the childSyntaxable
instances'Syntaxable.parseArgs(String[])
methods.void
reset()
java.lang.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.java.lang.String
toString()
java.lang.String
toUsage(SyntaxNotation aSyntaxNotation)
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)
is called from inside aSyntaxable
hierarchy.-
Methods inherited from class org.refcodes.console.AbstractCondition
addChild, get, getChildren, toOperands, toSyntax
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.refcodes.console.SyntaxUsage
toUsage
-
-
-
-
Constructor Detail
-
OptionalConditionImpl
public OptionalConditionImpl(Syntaxable... aSyntaxable)
Instantiates a new optional condition impl.- Parameters:
aSyntaxable
- the syntaxable
-
-
Method Detail
-
parseArgs
public java.util.List<? extends Operand<?>> parseArgs(java.lang.String[] aArgs) throws UnknownArgsException, AmbiguousArgsException, ParseArgsException
Description copied from interface:Syntaxable
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 aCondition
, traversing the childSyntaxable
instances'Syntaxable.parseArgs(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[])
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[])
method as ignoring superfluous command line arguments will cause unexpected behavior from the point of view of the invoker.- Parameters:
aArgs
- The command line arguments to be parsed.- 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 type
-
toUsage
public java.lang.String toUsage(SyntaxNotation aSyntaxNotation)
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)
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 isSyntaxUsage.toUsage(SyntaxNotation)
, as for some notations it will for example not create the most outer braces.- Specified by:
toUsage
in interfaceSyntaxUsage
- Parameters:
aSyntaxNotation
- The syntax notation used for generating the command line arguments syntax.- Returns:
- The human readable (verbose) command line arguments syntax.
-
toState
public java.lang.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.- Returns:
- The state of this
Syntaxable
instance and (if any) its children.
-
reset
public void reset()
- Specified by:
reset
in interfaceorg.refcodes.component.Resetable
- Overrides:
reset
in classAbstractCondition
-
toString
public java.lang.String toString()
- Overrides:
toString
in classAbstractCondition
-
-