T
- the generic typepublic abstract class AbstractOption<T> extends AbstractOperand<T> implements Option<T>
AbstractOption
is an abstract implementation of an Option
providing the boiler plate when implementing the Option
interface.org.refcodes.mixin.ValueAccessor.ValueBuilder<V,B extends org.refcodes.mixin.ValueAccessor.ValueBuilder<V,B>>, org.refcodes.mixin.ValueAccessor.ValueMutator<V>, org.refcodes.mixin.ValueAccessor.ValueProperty<V>
org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<B extends org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<B>>, org.refcodes.mixin.DescriptionAccessor.DescriptionMutator, org.refcodes.mixin.DescriptionAccessor.DescriptionProperty
org.refcodes.mixin.TypeAccessor.TypeMutator<T>, org.refcodes.mixin.TypeAccessor.TypeProperty<T>
ArgsAccessor.ArgsMutator, ArgsAccessor.ArgsProperty
Modifier | Constructor and Description |
---|---|
protected |
AbstractOption(String aShortOption,
String aLongOption,
Class<T> aType,
String aDescription)
Constructs a
Option with the given arguments. |
|
AbstractOption(String aShortOption,
String aLongOption,
Class<T> aType,
String aOptionArgName,
String aDescription)
Constructs a
Option with the given arguments. |
Modifier and Type | Method and Description |
---|---|
String |
getLongOption()
TODO: Make the option to be required without the hyphen-minuses "--"
Returns the long-option representing an
Option instance. |
String |
getShortOption()
Returns the short-option representing an
Option instance. |
List<Operand<T>> |
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. |
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 Syntaxable.toSyntax(SyntaxNotation) . |
protected void |
setArgs(String[] aArgs)
Sets the command line argument(s) representing the
Operand and
its value as parsed by the AbstractOperand.parseArgs(String[]) method. |
protected void |
setValue(T aValue)
Sets the value for the
Operand as parsed by the
AbstractOperand.parseArgs(String[]) method. |
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 |
toSyntax(SyntaxNotation aSyntaxNotation)
This method is to be called from inside the
Syntaxable hierarchy;
use the method Syntaxable.parseSyntax(SyntaxNotation) in case you invoke
syntax retrieval from the root Syntaxable . |
compareTo, getArgs, getDescription, getParameterName, getType, getValue, reset, toString, toValue
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getArgs, getParameterName, getValue, hasValue
parseSyntax
compareTo
public AbstractOption(String aShortOption, String aLongOption, Class<T> aType, String aOptionArgName, String aDescription)
Option
with the given arguments.aShortOption
- The short-option being a single character with the
additional single hyphen-minus "-" prefix.aLongOption
- The long-option being a multi-character sequence with
at least two characters with the additional double hyphen-minus
"--" prefix.aType
- The type of the value returned by the AbstractOperand.getValue()
method.aOptionArgName
- The option argument's name to be used when
constructing the syntax.aDescription
- A description without any line breaks.protected AbstractOption(String aShortOption, String aLongOption, Class<T> aType, String aDescription)
Option
with the given arguments.aShortOption
- The short-option being a single character with the
additional single hyphen-minus "-" prefix.aLongOption
- The long-option being a multi-character sequence with
at least two characters with the additional double hyphen-minus
"--" prefix.aType
- The type of the value returned by the AbstractOperand.getValue()
method.aDescription
- A description without any line breaks.public List<Operand<T>> 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' 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.parseArgs
in interface Syntaxable
parseArgs
in class AbstractOperand<T>
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 getShortOption()
Option
instance. A short
option usually is being prefixed with a single hyphen-minus "-" as
defined in Prefix.SHORT_ARG_OPTION
.getShortOption
in interface Option<T>
String
.public String getLongOption()
Option
instance. A long
option usually is being prefixed with a double hyphen-minus "--" as
defined in Prefix.LONG_ARG_OPTION
.getLongOption
in interface Option<T>
String
.public String toSyntax(SyntaxNotation aSyntaxNotation)
Syntaxable
hierarchy;
use the method Syntaxable.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 Syntaxable.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
Syntaxable.parseSyntax(SyntaxNotation)
, as for some notations it will for
example not create the most outer braces.toSyntax
in interface Syntaxable
toSyntax
in class AbstractOperand<T>
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.toState
in interface Syntaxable
toState
in class AbstractOperand<T>
Syntaxable
instance and (if any) its
children.protected void setValue(T aValue)
Operand
as parsed by the
AbstractOperand.parseArgs(String[])
method.setValue
in class AbstractOperand<T>
aValue
- The value to be set for this Operand
.protected void setArgs(String[] aArgs)
Operand
and
its value as parsed by the AbstractOperand.parseArgs(String[])
method.setArgs
in class AbstractOperand<T>
aArgs
- The command line arguments representing this Operand
with its value.public String parseSyntax(SyntaxNotation aSyntaxNotation)
Syntaxable
Syntaxable
; when
invoking syntax retrieval inside the Syntaxable
hierarchy use the
method Syntaxable.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 Syntaxable.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
Syntaxable.parseSyntax(SyntaxNotation)
, as for some notations it will for
example not create the most outer braces.parseSyntax
in interface Syntaxable
aSyntaxNotation
- The syntax notation used for generating the
command line arguments syntax.Copyright © 2017. All rights reserved.