-
- All Superinterfaces:
org.refcodes.component.Resetable
,Synopsis
- All Known Subinterfaces:
ArgsSyntax
,Condition
,Operand<T>
,Option<T>
- All Known Implementing Classes:
AbstractCondition
,AbstractOperand
,AbstractOption
,AllCondition
,AndCondition
,AnyCondition
,ArrayOperand
,ArrayOption
,CasesCondition
,CharOption
,CleanFlag
,ConfigOption
,DaemonFlag
,DebugFlag
,DoubleOption
,EnumOption
,FileOption
,Flag
,FloatOption
,ForceFlag
,HelpFlag
,InitFlag
,IntOption
,LongOption
,NoneOperand
,Operation
,OptionCondition
,OrCondition
,QuietFlag
,StringOperand
,StringOption
,SysInfoFlag
,VerboseFlag
,XorCondition
public interface Syntaxable extends org.refcodes.component.Resetable, Synopsis
ASyntaxable
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 theSyntaxable
's subclasses such asOperand
,Option
orArgsSyntax
, 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 theOperand
s', theFlag
es' or theOption
s' values.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default List<? extends Operand<?>>
parseArgs(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 aArgsSyntax
, traversing the childSyntaxable
instances'parseArgs(String[], String[])
methods.List<? extends Operand<?>>
parseArgs(String[] aArgs, String[] aOptions)
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 aArgsSyntax
, traversing the childSyntaxable
instances'parseArgs(String[], String[])
methods.String
toState()
ThetoState()
method might be used by theObject.toString()
method and prints out the state of the syntaxable and (if any) its children.default String
toSyntax()
This method is to be called from inside theSyntaxable
hierarchy; use the methodSynopsis.toSynopsis(SyntaxNotation)
in case you invoke syntax retrieval from the rootSyntaxable
.default String
toSyntax(String aOptEscCode, String aParamEscCode, String aResetEscCode)
This method is to be called from inside theSyntaxable
hierarchy; use the methodSynopsis.toSynopsis(SyntaxNotation)
in case you invoke syntax retrieval from the rootSyntaxable
.default String
toSyntax(SyntaxNotation aSyntaxNotation)
This method is to be called from inside theSyntaxable
hierarchy; use the methodSynopsis.toSynopsis(SyntaxNotation)
in case you invoke syntax retrieval from the rootSyntaxable
.String
toSyntax(SyntaxNotation aSyntaxNotation, String aOptEscCode, String aParamEscCode, String aResetEscCode)
This method is to be called from inside theSyntaxable
hierarchy; use the methodSynopsis.toSynopsis(SyntaxNotation)
in case you invoke syntax retrieval from the rootSyntaxable
.<V> V
toValue(String aAlias)
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.-
Methods inherited from interface org.refcodes.cli.Synopsis
toSynopsis, toSynopsis, toSynopsis, toSynopsis
-
-
-
-
Method Detail
-
toSyntax
default String toSyntax(SyntaxNotation aSyntaxNotation)
This method is to be called from inside theSyntaxable
hierarchy; use the methodSynopsis.toSynopsis(SyntaxNotation)
in case you invoke syntax retrieval from the rootSyntaxable
. Returns the human readable (verbose) syntax of thisSyntaxable
instance including, in case of being a node in the syntax tree (such as aArgsSyntax
, the syntax of the childSyntaxable
instances. ATTENTION: As of different parenthesis settings for some notations regarding the rootSyntaxable
and the childSyntaxable
s, the methodtoSyntax(SyntaxNotation, String, String, String)
is called from inside theSyntaxable
hierarchy. In case the syntax is to be retrieved from the rootSyntaxable
, then the applicable method to be called isSynopsis.toSynopsis(SyntaxNotation)
, as for some notations it will for example not create the most outer braces.- Parameters:
aSyntaxNotation
- The syntax notation used for generating the command line arguments syntax.- Returns:
- The human readable (verbose) command line arguments syntax.
-
toSyntax
default String toSyntax()
This method is to be called from inside theSyntaxable
hierarchy; use the methodSynopsis.toSynopsis(SyntaxNotation)
in case you invoke syntax retrieval from the rootSyntaxable
. Returns the human readable (verbose) syntax of thisSyntaxable
instance including, in case of being a node in the syntax tree (such as aArgsSyntax
, the syntax of the childSyntaxable
instances. ATTENTION: As of different parenthesis settings for some notations regarding the rootSyntaxable
and the childSyntaxable
s, the methodtoSyntax(SyntaxNotation, String, String, String)
is called from inside theSyntaxable
hierarchy. In case the syntax is to be retrieved from the rootSyntaxable
, then the applicable method to be called isSynopsis.toSynopsis(SyntaxNotation)
, as for some notations it will for example not create the most outer braces. This method uses theSyntaxNotation.REFCODES
be default!- Returns:
- The human readable (verbose) command line arguments syntax.
-
toSyntax
default String toSyntax(String aOptEscCode, String aParamEscCode, String aResetEscCode)
This method is to be called from inside theSyntaxable
hierarchy; use the methodSynopsis.toSynopsis(SyntaxNotation)
in case you invoke syntax retrieval from the rootSyntaxable
. Returns the human readable (verbose) syntax of thisSyntaxable
instance including, in case of being a node in the syntax tree (such as aArgsSyntax
, the syntax of the childSyntaxable
instances. ATTENTION: As of different parenthesis settings for some notations regarding the rootSyntaxable
and the childSyntaxable
s, the methodtoSyntax(SyntaxNotation, String, String, String)
is called from inside theSyntaxable
hierarchy. In case the syntax is to be retrieved from the rootSyntaxable
, then the applicable method to be called isSynopsis.toSynopsis(SyntaxNotation)
, as for some notations it will for example not create the most outer braces. This method uses theSyntaxNotation.REFCODES
be default!- Parameters:
aOptEscCode
- The escape code to be used when processing an option, e.g. this can be an ANSI Escape-Code to highlight the option.aParamEscCode
- The escape code to be used when processing a keyword, e.g. this can be an ANSI Escape-Code to highlight the option and/or parameters.aResetEscCode
- The escape code to close (reset) any Escape-Code being set before.- Returns:
- The human readable (verbose) command line arguments syntax.
-
toSyntax
String toSyntax(SyntaxNotation aSyntaxNotation, String aOptEscCode, String aParamEscCode, String aResetEscCode)
This method is to be called from inside theSyntaxable
hierarchy; use the methodSynopsis.toSynopsis(SyntaxNotation)
in case you invoke syntax retrieval from the rootSyntaxable
. Returns the human readable (verbose) syntax of thisSyntaxable
instance including, in case of being a node in the syntax tree (such as aArgsSyntax
, the syntax of the childSyntaxable
instances. ATTENTION: As of different parenthesis settings for some notations regarding the rootSyntaxable
and the childSyntaxable
s, the methodtoSyntax(SyntaxNotation, String, String, String)
is called from inside theSyntaxable
hierarchy. In case the syntax is to be retrieved from the rootSyntaxable
, then the applicable method to be called isSynopsis.toSynopsis(SyntaxNotation)
, as for some notations it will for example not create the most outer braces.- Parameters:
aSyntaxNotation
- The syntax notation used for generating the command line arguments syntax.aOptEscCode
- The escape code to be used when processing an option, e.g. this can be an ANSI Escape-Code to highlight the option.aParamEscCode
- The escape code to be used when processing a keyword, e.g. this can be an ANSI Escape-Code to highlight the option and/or parameters.aResetEscCode
- The escape code to close (reset) any Escape-Code being set before.- Returns:
- The human readable (verbose) command line arguments syntax.
-
parseArgs
default List<? extends Operand<?>> parseArgs(String[] aArgs) throws UnknownArgsException, AmbiguousArgsException, ParseArgsException, SuperfluousArgsException
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 aArgsSyntax
, traversing the childSyntaxable
instances'parseArgs(String[], 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 theparseArgs(String[], 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'sparseArgs(String[], 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 typeSuperfluousArgsException
- in case there were arguments found not being used (superfluous arguments), thrown only in very specific cases (throw with care!).
-
parseArgs
List<? extends Operand<?>> parseArgs(String[] aArgs, String[] aOptions) throws UnknownArgsException, AmbiguousArgsException, ParseArgsException, SuperfluousArgsException
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 aArgsSyntax
, traversing the childSyntaxable
instances'parseArgs(String[], 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 theparseArgs(String[], 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'sparseArgs(String[], 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.aOptions
- The list of options (short and as well as long) which are reserved and cannot be used as value.- 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 typeSuperfluousArgsException
- in case there were arguments found not being used (superfluous arguments), thrown only in very specific cases (throw with care!).
-
toValue
<V> V toValue(String aAlias)
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.- Type Parameters:
V
- The type of the value being expected.- Parameters:
aAlias
- The alias for which to seek for a value being set.- Returns:
- The according value or null if none has been set for the given alias.
-
toState
String toState()
ThetoState()
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.
-
-