|Constructor and Description|
Instantiates a new optional condition impl.
|Modifier and Type||Method and Description|
addChild, getChildren, toOperands, toSyntax
public OptionalConditionImpl(Syntaxable... aSyntaxable)
aSyntaxable- the a syntaxable
public List<? extends Operand<?>> parseArgs(String aArgs) throws UnknownArgsException, AmbiguousArgsException, ParseArgsException
Syntaxableinstance or, in case of being a node in the syntax tree (such as a
Condition, traversing the child
Syntaxable.parseArgs(String)methods. In case of successfully parsing this
Syntaxableand / or the child
Syntaxableinstances, the evaluated command line arguments are returned: Depending on the
Syntaxablesubclasses representing the evaluated command line arguments, instances of
Operandclasses 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 the
Syntaxableinstance being traversed. This method is commonly used by a root
ArgsParser.evalArgs(String)method, which delegates to the
Syntaxable.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's
Syntaxable.parseArgs(String)method as ignoring superfluous command line arguments will cause unexpected behavior from the point of view of the invoker.
aArgs- The command line arguments to be parsed.
Operandinterfaces or its sub-types.
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
public String parseSyntax(SyntaxNotation aSyntaxNotation)
Syntaxable; when invoking syntax retrieval inside the
Syntaxablehierarchy use the method
Syntaxable.toSyntax(SyntaxNotation). Returns the human readable (verbose) syntax of this
Syntaxableinstance including, in case of being a node in the syntax tree (such as a
Condition, the syntax of the child
Syntaxableinstances. ATTENTION: As of different parenthesis settings for some notations regarding the root
Syntaxableand the child
Syntaxables, the method
Syntaxable.toSyntax(SyntaxNotation)is called from inside the
Syntaxablehierarchy. In case the syntax is to be retrieved from the root
Syntaxable, then the applicable method to be called is
Syntaxable.parseSyntax(SyntaxNotation), as for some notations it will for example not create the most outer braces.
public String toState()
Syntaxable.toState()method might be used by the
Object.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.
Syntaxableinstance and (if any) its children.
public void reset()
Copyright © 2017. All rights reserved.