public class StringOptionImpl extends AbstractOption<String>
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 |
---|
StringOptionImpl(org.refcodes.structure.Relation<String,String> aProperty)
Instantiates a new integer string impl.
|
StringOptionImpl(String aShortOption,
String aLongOption,
String aAlias,
String aDescription)
Instantiates a new string option impl.
|
Modifier and Type | Method and Description |
---|---|
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 String |
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, parseArgs, setArgs, setValue, toState, toSyntax
compareTo, getAlias, getArgs, getDescription, getType, getValue, reset, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
get, getAlias, getArgs, getValue, hasValue
toUsage, toUsage
compareTo
public StringOptionImpl(String aShortOption, String aLongOption, String aAlias, String aDescription)
aShortOption
- the short optionaLongOption
- the long optionaAlias
- the option arg nameaDescription
- the descriptionprotected String 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<String>
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.