public class OptionalConditionImpl extends AbstractCondition
Constructor and Description |
---|
OptionalConditionImpl(Syntaxable... aSyntaxable)
Instantiates a new optional condition impl.
|
Modifier and Type | Method and Description |
---|---|
List<? extends Operand<?>> |
parseArgs(String[] aArgs)
Parses the provided command line arguments and determines the according
values by evaluating this
Syntaxable instance or, in case of
being a node in the syntax tree (such as a Condition , traversing
the child Syntaxable instances' Syntaxable.parseArgs(String[])
methods. |
void |
reset() |
String |
toState()
The
Syntaxable.toState() method might be used by the
Object.toString() method and prints out the state of the
syntaxable and (if any) its children. |
String |
toString() |
String |
toUsage(SyntaxNotation aSyntaxNotation)
Returns the human readable (verbose) syntax of implementing class
ATTENTION: As of different parenthesis settings for some notations
regarding the root
Syntaxable and the child Syntaxable s,
the method Syntaxable.toSyntax(SyntaxNotation) is called from
inside a Syntaxable hierarchy. |
addChild, get, getChildren, toOperands, toSyntax
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
toUsage
public OptionalConditionImpl(Syntaxable... aSyntaxable)
aSyntaxable
- the syntaxablepublic List<? extends Operand<?>> parseArgs(String[] aArgs) throws UnknownArgsException, AmbiguousArgsException, ParseArgsException
Syntaxable
Syntaxable
instance or, in case of
being a node in the syntax tree (such as a Condition
, traversing
the child Syntaxable
instances' Syntaxable.parseArgs(String[])
methods.
In case of successfully parsing this Syntaxable
and / or the
child Syntaxable
instances, the evaluated command line arguments
are returned: Depending on the Syntaxable
subclasses representing
the evaluated command line arguments, instances of Switch
classes, Option
classes or Operand
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 the Syntaxable
instance being traversed. This method is
commonly used by a root Syntaxable
's
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.Operand
interfaces 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 typepublic String toUsage(SyntaxNotation aSyntaxNotation)
Syntaxable
and the child Syntaxable
s,
the method Syntaxable.toSyntax(SyntaxNotation)
is called from
inside a Syntaxable
hierarchy. In case the syntax is to be
retrieved from the root Syntaxable
or an encapsulating and
different type, then the applicable method to be called is
SyntaxUsage.toUsage(SyntaxNotation)
, as for some notations it will for
example not create the most outer braces.toUsage
in interface SyntaxUsage
aSyntaxNotation
- The syntax notation used for generating the
command line arguments syntax.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.Syntaxable
instance and (if any) its
children.public void reset()
reset
in interface org.refcodes.component.Resetable
reset
in class AbstractCondition
public String toString()
toString
in class AbstractCondition
Copyright © 2018. All rights reserved.