public abstract class AbstractOperand<T> extends Object implements Operand<T>
AbstractOperand
is an abstract implementation of an
Operand
providing the boiler plate when implementing the
Operand
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, org.refcodes.mixin.TypeAccessor.TypeProperty
ArgsAccessor.ArgsMutator, ArgsAccessor.ArgsProperty
Constructor and Description |
---|
AbstractOperand(Class<T> aType,
String aParameterName,
String aDescription)
Constructs a
Operand with the given arguments. |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(Operand<?> obj) |
String[] |
getArgs()
When being parsed via the
Syntaxable.parseArgs(String[]) method, then the
Operand.getArgs() method returns the command line arguments representing
this Operand instance (also including the short or the long
options, see Operand ). |
String |
getDescription() |
String |
getParameterName()
|
Class<?> |
getType() |
T |
getValue()
When being parsed via the
Syntaxable.parseArgs(String[]) method, then the
Operand.getValue() method returns the parsed value. |
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) . |
void |
reset() |
protected void |
setArgs(String[] aArgs)
Sets the command line argument(s) representing the
Operand and
its value as parsed by the parseArgs(String[]) method. |
protected void |
setValue(T aValue)
Sets the value for the
Operand as parsed by the
parseArgs(String[]) method. |
String |
toState()
The
Syntaxable.toState() method might be used by the #toString()
method and prints out the state of the syntaxable and (if any) its
children. |
String |
toString() |
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 . |
protected abstract T |
toValue(String aArg)
Double dispatch hook to be implemented by subclasses of the
AbstractOperand for converting a command line argument to the
required Operand 's type. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
parseSyntax
public AbstractOperand(Class<T> aType, String aParameterName, String aDescription)
Operand
with the given arguments.aType
- The type of the value returned by the getValue()
method.aParameterName
- The Operand
's name, used for syntax
creation.aDescription
- A description without any line breaks.public List<Operand<T>> 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.parseArgs
in interface Syntaxable
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 getDescription()
getDescription
in interface org.refcodes.mixin.DescriptionAccessor
public String toSyntax(SyntaxNotation aSyntaxNotation)
Syntaxable
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
aSyntaxNotation
- The syntax notation used for generating the
command line arguments syntax.public String getParameterName()
Operand
Operand
) or the option argument (Option
),
depending on the sub-type inheriting from this interface. The parameter
name is merely used for constructing the command line arguments syntax
String
via Syntaxable.toSyntax(SyntaxNotation)
and the command line
arguments detail description when creating a command line tool's help
output.getParameterName
in interface Operand<T>
public Class<?> getType()
getType
in interface org.refcodes.mixin.TypeAccessor
public T getValue()
Operand
Syntaxable.parseArgs(String[])
method, then the
Operand.getValue()
method returns the parsed value.getValue
in interface Operand<T>
getValue
in interface org.refcodes.mixin.ValueAccessor<T>
Syntaxable.parseArgs(String[])
method.public String[] getArgs()
Operand
Syntaxable.parseArgs(String[])
method, then the
Operand.getArgs()
method returns the command line arguments representing
this Operand
instance (also including the short or the long
options, see Operand
).public void reset()
reset
in interface org.refcodes.component.Resetable
public String toState()
Syntaxable
Syntaxable.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.toState
in interface Syntaxable
Syntaxable
instance and (if any) its
children.public int compareTo(Operand<?> obj)
compareTo
in interface Comparable<Operand<?>>
protected void setValue(T aValue)
Operand
as parsed by the
parseArgs(String[])
method.aValue
- The value to be set for this Operand
.protected void setArgs(String[] aArgs)
Operand
and
its value as parsed by the parseArgs(String[])
method.aArgs
- The command line arguments representing this Operand
with its value.protected abstract T toValue(String aArg) throws ParseArgsException
AbstractOperand
for converting a command line argument to the
required Operand
's type. In case conversion failed, then an
according exception is to be thrown.aArg
- The command line argument to be converted to an instance of
the given type T.ParseArgsException
- Thrown in case the provided command line
arguments do not respect the required syntax or cannot be
converted to the required type.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 © 2016. All rights reserved.