public class SwitchImpl extends AbstractOption<Boolean> implements Switch
SwitchImpl
class implements the Switch
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
_value
Constructor and Description |
---|
SwitchImpl(String aAlias,
boolean aValue)
Constructs a
Switch . |
SwitchImpl(String aShortOption,
String aLongOption,
String aDescription)
Constructs a
Switch . |
SwitchImpl(String aShortOption,
String aLongOption,
String aAlias,
String aDescription)
Constructs a
Switch . |
Modifier and Type | Method and Description |
---|---|
List<Operand<Boolean>> |
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. |
void |
reset() |
String |
toUsage(SyntaxNotation aSyntaxNotation)
Returns the human readable (verbose) syntax of implementing class
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 a Syntaxable hierarchy. |
protected Boolean |
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. |
getLongOption, getShortOption, setArgs, setValue, toState, toSyntax
compareTo, getAlias, getArgs, getDescription, getType, getValue, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getLongOption, getShortOption
get, getAlias, getArgs, getValue, hasValue
toState, toSyntax
toUsage, toUsage
compareTo
public SwitchImpl(String aShortOption, String aLongOption, String aDescription)
Switch
.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.aDescription
- A description without any line breaks.public SwitchImpl(String aShortOption, String aLongOption, String aAlias, String aDescription)
Switch
.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.aAlias
- The alias identifying this Switch
.aDescription
- A description without any line breaks.public List<Operand<Boolean>> 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 AbstractOption<Boolean>
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 void reset()
reset
in interface org.refcodes.component.Resetable
reset
in class AbstractOperand<Boolean>
protected Boolean 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.toValue
in class AbstractOperand<Boolean>
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 toUsage(SyntaxNotation aSyntaxNotation)
SyntaxUsage
Syntaxable
and the child Syntaxable
s,
the method Syntaxable.toSyntax(SyntaxNotation)
is called from
inside a Syntaxable
hierarchy. In case the syntax is to be
retrieved from the root Syntaxable
or an encapsulating and
different type, 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.toUsage
in interface SyntaxUsage
aSyntaxNotation
- The syntax notation used for generating the
command line arguments syntax.Copyright © 2018. All rights reserved.