- java.lang.Object
-
- org.refcodes.cli.AbstractOperand<T>
-
- org.refcodes.cli.AbstractOption<Float>
-
- org.refcodes.cli.FloatOption
-
- All Implemented Interfaces:
Cloneable
,Comparable<Operand<?>>
,ArgsAccessor
,Operand<Float>
,Option<Float>
,Synopsis
,Syntaxable
,org.refcodes.component.Resetable
,org.refcodes.mixin.AliasAccessor
,org.refcodes.mixin.Clonable
,org.refcodes.mixin.DescriptionAccessor
,org.refcodes.mixin.TypeAccessor<Float>
,org.refcodes.mixin.ValueAccessor<Float>
public class FloatOption extends AbstractOption<Float>
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.refcodes.mixin.AliasAccessor
org.refcodes.mixin.AliasAccessor.AliasBuilder<B extends org.refcodes.mixin.AliasAccessor.AliasBuilder<B>>, org.refcodes.mixin.AliasAccessor.AliasMutator, org.refcodes.mixin.AliasAccessor.AliasProperty
-
Nested classes/interfaces inherited from interface org.refcodes.cli.ArgsAccessor
ArgsAccessor.ArgsMutator, ArgsAccessor.ArgsProperty
-
Nested classes/interfaces inherited from interface org.refcodes.mixin.DescriptionAccessor
org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<B extends org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<B>>, org.refcodes.mixin.DescriptionAccessor.DescriptionMutator, org.refcodes.mixin.DescriptionAccessor.DescriptionProperty
-
Nested classes/interfaces inherited from interface org.refcodes.mixin.TypeAccessor
org.refcodes.mixin.TypeAccessor.TypeBuilder<T extends Object,B extends org.refcodes.mixin.TypeAccessor.TypeBuilder<T,B>>, org.refcodes.mixin.TypeAccessor.TypeMutator<T extends Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends Object>
-
Nested classes/interfaces inherited from interface org.refcodes.mixin.ValueAccessor
org.refcodes.mixin.ValueAccessor.ValueBuilder<V extends Object,B extends org.refcodes.mixin.ValueAccessor.ValueBuilder<V,B>>, org.refcodes.mixin.ValueAccessor.ValueMutator<V extends Object>, org.refcodes.mixin.ValueAccessor.ValueProperty<V extends Object>
-
-
Field Summary
-
Fields inherited from class org.refcodes.cli.AbstractOperand
_value
-
-
Constructor Summary
Constructors Constructor Description FloatOption(String aLongOption, String aAlias, String aDescription)
Instantiates a new long option impl.FloatOption(String aShortOption, String aLongOption, String aAlias, String aDescription)
Instantiates a new long option impl.FloatOption(org.refcodes.struct.Relation<String,Float> aProperty)
Instantiates a new long option impl.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
toSynopsis(SyntaxNotation aSyntaxNotation, String aOptEscCode, String aParamEscCode, String aResetEscCode)
Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the rootSyntaxable
and the childSyntaxable
s, the methodSyntaxable.toSyntax(SyntaxNotation, String, String, String)
is called from inside aSyntaxable
hierarchy.protected Float
toType(String aArg)
Double dispatch hook to be implemented by subclasses of theAbstractOperand
for converting a command line argument to the requiredOperand
's type.-
Methods inherited from class org.refcodes.cli.AbstractOption
clone, getLongOption, getOptionPrefixes, getShortOption, parseArgs, setArgs, setValue, toState, toSyntax
-
Methods inherited from class org.refcodes.cli.AbstractOperand
compareTo, getAlias, getArgs, getDescription, getType, getValue, reset, toString
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.lang.Comparable
compareTo
-
Methods inherited from interface org.refcodes.cli.Operand
getAlias, getArgs, getValue, hasValue, toValue
-
Methods inherited from interface org.refcodes.cli.Option
getOptions
-
Methods inherited from interface org.refcodes.cli.Synopsis
toSynopsis, toSynopsis, toSynopsis, toSynopsis
-
Methods inherited from interface org.refcodes.cli.Syntaxable
parseArgs, toSyntax, toSyntax, toSyntax
-
-
-
-
Constructor Detail
-
FloatOption
public FloatOption(String aLongOption, String aAlias, String aDescription)
Instantiates a new long option impl.- Parameters:
aLongOption
- the long optionaAlias
- the option arg nameaDescription
- the description
-
FloatOption
public FloatOption(String aShortOption, String aLongOption, String aAlias, String aDescription)
Instantiates a new long option impl.- Parameters:
aShortOption
- the short optionaLongOption
- the long optionaAlias
- the option arg nameaDescription
- the description
-
-
Method Detail
-
toType
protected Float toType(String aArg) throws ParseArgsException
Double dispatch hook to be implemented by subclasses of theAbstractOperand
for converting a command line argument to the requiredOperand
's type. In case conversion failed, then an according exception is to be thrown.- Specified by:
toType
in classAbstractOperand<Float>
- Parameters:
aArg
- The command line argument to be converted to an instance of the given type T.- Returns:
- An instance of type T from the provided command line argument.
- Throws:
ParseArgsException
- Thrown in case the provided command line arguments do not respect the required syntax or cannot be converted to the required type.
-
toSynopsis
public String toSynopsis(SyntaxNotation aSyntaxNotation, String aOptEscCode, String aParamEscCode, String aResetEscCode)
Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the rootSyntaxable
and the childSyntaxable
s, the methodSyntaxable.toSyntax(SyntaxNotation, String, String, String)
is called from inside aSyntaxable
hierarchy. In case the syntax is to be retrieved from the rootSyntaxable
or an encapsulating and different type, then the applicable method to be called isSynopsis.toSynopsis(SyntaxNotation)
, as for some notations it will for example not create the most outer braces.- Specified by:
toSynopsis
in interfaceSynopsis
- 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 am argument, e.g. this can be an ANSI Escape-Code to highlight the option.aResetEscCode
- The escape code to close (reset) any Escape-Code being set before.- Returns:
- The human readable (verbose) command line arguments syntax.
-
-