public interface Syntaxable
extends org.refcodes.component.Resetable
Syntaxable
defines the methods at least required when building a
command line arguments syntax tree for traversing the syntax tree; either for
parsing command line arguments or for constructing the command line arguments
syntax.
By providing various implementations of the Syntaxable
's subclasses
such as Operand
, Option
or Condition
, a command line
arguments syntax tree can be constructed. This syntax tree can be use to
create a human readable (verbose) command line arguments syntax and to parse
an array of command line arguments for determining the Operand
s', the
Switch
es' or the Option
s' values.
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' parseArgs(String[])
methods. |
String |
parseSyntax(SyntaxNotation aSyntaxNotation)
This method is to be called from from the root
Syntaxable ; when
invoking syntax retrieval inside the Syntaxable hierarchy use the
method toSyntax(SyntaxNotation) . |
String |
toState()
The
toState() method might be used by the #toString()
method and prints out the state of the syntaxable and (if any) its
children. |
String |
toSyntax(SyntaxNotation aSyntaxNotation)
This method is to be called from inside the
Syntaxable hierarchy;
use the method parseSyntax(SyntaxNotation) in case you invoke
syntax retrieval from the root Syntaxable . |
String toSyntax(SyntaxNotation aSyntaxNotation)
Syntaxable
hierarchy;
use the method parseSyntax(SyntaxNotation)
in case you invoke
syntax retrieval from the root Syntaxable
.
Returns the human readable (verbose) syntax of this Syntaxable
instance including, in case of being a node in the syntax tree (such as a
Condition
, the syntax of the child Syntaxable
instances.
ATTENTION: As of different parenthesis settings for some notations
regarding the root Syntaxable
and the child Syntaxable
s,
the method toSyntax(SyntaxNotation)
is called from inside the
Syntaxable
hierarchy. In case the syntax is to be retrieved from
the root Syntaxable
, then the applicable method to be called is
parseSyntax(SyntaxNotation)
, as for some notations it will for
example not create the most outer braces.aSyntaxNotation
- The syntax notation used for generating the
command line arguments syntax.String parseSyntax(SyntaxNotation aSyntaxNotation)
Syntaxable
; when
invoking syntax retrieval inside the Syntaxable
hierarchy use the
method toSyntax(SyntaxNotation)
.
Returns the human readable (verbose) syntax of this Syntaxable
instance including, in case of being a node in the syntax tree (such as a
Condition
, the syntax of the child Syntaxable
instances.
ATTENTION: As of different parenthesis settings for some notations
regarding the root Syntaxable
and the child Syntaxable
s,
the method toSyntax(SyntaxNotation)
is called from inside the
Syntaxable
hierarchy. In case the syntax is to be retrieved from
the root Syntaxable
, then the applicable method to be called is
parseSyntax(SyntaxNotation)
, as for some notations it will for
example not create the most outer braces.aSyntaxNotation
- The syntax notation used for generating the
command line arguments syntax.List<? extends Operand<?>> parseArgs(String[] aArgs) throws UnknownArgsException, AmbiguousArgsException, ParseArgsException
Syntaxable
instance or, in case of
being a node in the syntax tree (such as a Condition
, traversing
the child Syntaxable
instances' 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
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 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 typeString toState()
toState()
method might be used by the #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.Copyright © 2016. All rights reserved.