public interface Syntaxable extends org.refcodes.component.Resetable, SyntaxUsage
Syntaxabledefines 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
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
Switches' or the
|Modifier and Type||Method and Description|
Searches for a value being set for the given for given alias in the syntax tree parsing the command line arguments; if a node in the syntax tree has a value for the given alias, then this value is returned.
String toSyntax(SyntaxNotation aSyntaxNotation)
Syntaxablehierarchy; use the method
SyntaxUsage.toUsage(SyntaxNotation)in case you invoke syntax retrieval from the root
Syntaxable. 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
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
SyntaxUsage.toUsage(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
Syntaxableinstance or, in case of being a node in the syntax tree (such as a
Condition, traversing the child
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
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.
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
<V> V get(String aAlias)
V- The type of the value being expected.
aAlias- The alias for which to seek for a value being set.
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.
Copyright © 2018. All rights reserved.