- All Implemented Interfaces:
Cloneable
,Comparable<Operand<?>>
,MatchCountAccessor
,Operand<Double>
,Option<Double>
,ParsedArgsAccessor
,PropertyOption<Double>
,Synopsisable
,Term
,org.refcodes.exception.ExceptionAccessor<ArgsSyntaxException>
,org.refcodes.graphical.VisibleAccessor
,org.refcodes.graphical.VisibleAccessor.VisibleBuilder<Term>
,org.refcodes.graphical.VisibleAccessor.VisibleMutator
,org.refcodes.graphical.VisibleAccessor.VisibleProperty
,org.refcodes.mixin.AliasAccessor
,org.refcodes.mixin.Clonable
,org.refcodes.mixin.DescriptionAccessor
,org.refcodes.mixin.Resetable
,org.refcodes.mixin.TypeAccessor<Double>
,org.refcodes.mixin.ValueAccessor<Double>
,org.refcodes.schema.Schemable
-
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.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.exception.ExceptionAccessor
org.refcodes.exception.ExceptionAccessor.ExceptionBuilder<EXC extends Throwable,
B extends org.refcodes.exception.ExceptionAccessor.ExceptionBuilder<EXC, B>>, org.refcodes.exception.ExceptionAccessor.ExceptionMutator<EXC extends Throwable>, org.refcodes.exception.ExceptionAccessor.ExceptionProperty<EXC extends Throwable> Nested classes/interfaces inherited from interface org.refcodes.cli.MatchCountAccessor
MatchCountAccessor.MatchCountBuilder<B extends MatchCountAccessor.MatchCountBuilder<B>>, MatchCountAccessor.MatchCountMutator, MatchCountAccessor.MatchCountProperty
Nested classes/interfaces inherited from interface org.refcodes.cli.ParsedArgsAccessor
ParsedArgsAccessor.ParsedArgsMutator, ParsedArgsAccessor.ParsedArgsProperty
Nested classes/interfaces inherited from interface org.refcodes.mixin.TypeAccessor
org.refcodes.mixin.TypeAccessor.TypeBuilder<T,
B extends org.refcodes.mixin.TypeAccessor.TypeBuilder<T, B>>, org.refcodes.mixin.TypeAccessor.TypeMutator<T>, org.refcodes.mixin.TypeAccessor.TypeProperty<T> Nested classes/interfaces inherited from interface org.refcodes.mixin.ValueAccessor
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> Nested classes/interfaces inherited from interface org.refcodes.graphical.VisibleAccessor
org.refcodes.graphical.VisibleAccessor.VisibleBuilder<B extends org.refcodes.graphical.VisibleAccessor.VisibleBuilder<B>>, org.refcodes.graphical.VisibleAccessor.VisibleMutator, org.refcodes.graphical.VisibleAccessor.VisibleProperty
-
Field Summary
Modifier and TypeFieldDescriptionprotected String
protected ArgsSyntaxException
protected boolean
Fields inherited from class org.refcodes.cli.AbstractOperand
_matchCount
-
Constructor Summary
ConstructorDescriptionDoubleProperty
(Character aShortProperty, String aLongProperty, String aDescription) Instantiates a newDoubleProperty
with the given arguments.DoubleProperty
(Character aShortProperty, String aLongProperty, String aAlias, String aDescription) Instantiates a newDoubleProperty
with the given arguments.DoubleProperty
(Character aShortOption, String aLongOption, String aAlias, String aDescription, Consumer<DoubleProperty> aConsumer) Instantiates a newDoubleProperty
with the given arguments.DoubleProperty
(Character aShortOption, String aLongOption, String aDescription, Consumer<DoubleProperty> aConsumer) Instantiates a newDoubleProperty
with the given arguments.DoubleProperty
(String aLongProperty, String aDescription) Instantiates a newDoubleProperty
with the given arguments.DoubleProperty
(String aLongProperty, String aAlias, String aDescription) Instantiates a newDoubleProperty
with the given arguments.DoubleProperty
(String aLongOption, String aAlias, String aDescription, Consumer<DoubleProperty> aConsumer) Instantiates a newDoubleProperty
with the given arguments.DoubleProperty
(String aLongOption, String aDescription, Consumer<DoubleProperty> aConsumer) Instantiates a newDoubleProperty
with the given arguments.DoubleProperty
(org.refcodes.struct.Relation<String, Double> aProperty) Instantiates a newDoubleProperty
with the alias being the proerty's key and the value being the property's value.DoubleProperty
(org.refcodes.struct.Relation<String, Double> aProperty, Consumer<DoubleProperty> aConsumer) Instantiates a newDoubleProperty
with the alias being the proerty's key and the value being the property's value. -
Method Summary
Modifier and TypeMethodDescriptionRetrieves theArgsSyntaxException
exception in case invokingTerm.parseArgs(String[], CliContext)
failed.boolean
Visibility in this context means displaying or hiding thisTerm
's existence to the user (defaults totrue
).void
setVisible
(boolean isVisible) Visibility in this context means displaying or hiding thisTerm
's existence to the user (defaults totrue
).protected static String[]
toArgsDiff
(String[] aArgs, String[] aArgsSubset) Creates the difference between the provided set and the provided subset.protected static String[]
toArgsDiff
(String[] aArgs, List<? extends Operand<?>> aArgsSubset) Creates the difference between the provided set and the providedList
s therein found argument arrays subset (as ofOperand.getParsedArgs()
).protected static String[]
toArgsDiff
(String[] aArgs, Operand<?>[] aArgsSubset) Creates the difference between the provided set and the providedList
s therein found argument arrays subset (as ofOperand.getParsedArgs()
).protected static String[]
toParsedArgs
(Operand<?>[]... aOperands) Takes allOperand
instances found in the providedList
s and adds all therein found argument arrays (as ofOperand.getParsedArgs()
) to the result.protected Double
Double dispatch hook to be implemented by subclasses of theAbstractOperand
for converting a command line argument to the requiredOperand
's type.withVisible
(boolean isVisible) Visibility in this context means displaying or hiding thisTerm
's existence to the user (defaults totrue
).Methods inherited from class org.refcodes.cli.AbstractPropertyOption
parseArgs, toPropertyArgument, toPropertyArgument, toSyntax, toUsage
Methods inherited from class org.refcodes.cli.AbstractOption
clone, contains, getLongOption, getShortOption, setParsedArgs, setValue, toException, toSchema, toString
Methods inherited from class org.refcodes.cli.AbstractOperand
approve, compareTo, getAlias, getMatchCount, getParsedArgs, getType, getValue, reset
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.refcodes.mixin.Clonable
clone
Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface org.refcodes.mixin.DescriptionAccessor
getDescription
Methods inherited from interface org.refcodes.cli.Operand
getAlias, getParsedArgs, getValue, hasValue, toSpec, toSpec, toUsage, toValue
Methods inherited from interface org.refcodes.cli.Option
getLongOption, getShortOption
Methods inherited from interface org.refcodes.mixin.Resetable
reset
Methods inherited from interface org.refcodes.cli.Synopsisable
toSynopsis, toSynopsis, toSynopsis, toSynopsis
Methods inherited from interface org.refcodes.cli.Term
getException, getMatchCount, isVisible, parseArgs, setVisible, toSchema, toSynopsis, toSyntax, toSyntax, toSyntax, toSyntax
Methods inherited from interface org.refcodes.mixin.TypeAccessor
getType
Methods inherited from interface org.refcodes.mixin.ValueAccessor
getValueOr
Methods inherited from interface org.refcodes.graphical.VisibleAccessor.VisibleBuilder
withHide, withShow
Methods inherited from interface org.refcodes.graphical.VisibleAccessor.VisibleMutator
hide, show
Methods inherited from interface org.refcodes.graphical.VisibleAccessor.VisibleProperty
letVisible
-
Field Details
-
_description
-
_exception
-
_isVisible
protected boolean _isVisible
-
-
Constructor Details
-
DoubleProperty
Instantiates a newDoubleProperty
with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.- Parameters:
aShortProperty
- The short option to use.aLongProperty
- The long option to use.aDescription
- The description of theDoubleProperty
-
DoubleProperty
public DoubleProperty(Character aShortOption, String aLongOption, String aDescription, Consumer<DoubleProperty> aConsumer) Instantiates a newDoubleProperty
with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.- Parameters:
aShortOption
- The short option to use.aLongOption
- The long option to use.aDescription
- The description of theDoubleProperty
aConsumer
- TheConsumer
being invoked in case thisDoubleProperty
participated in successfully parsing the command line arguments.
-
DoubleProperty
public DoubleProperty(Character aShortProperty, String aLongProperty, String aAlias, String aDescription) Instantiates a newDoubleProperty
with the given arguments.- Parameters:
aShortProperty
- The short option to use.aLongProperty
- The long option to use.aAlias
- The alias to be used for naming purposes.aDescription
- The description of theDoubleProperty
-
DoubleProperty
public DoubleProperty(Character aShortOption, String aLongOption, String aAlias, String aDescription, Consumer<DoubleProperty> aConsumer) Instantiates a newDoubleProperty
with the given arguments.- Parameters:
aShortOption
- The short option to use.aLongOption
- The long option to use.aAlias
- The alias to be used for naming purposes.aDescription
- The description of theDoubleProperty
aConsumer
- TheConsumer
being invoked in case thisDoubleProperty
participated in successfully parsing the command line arguments.
-
DoubleProperty
Instantiates a newDoubleProperty
with the alias being the proerty's key and the value being the property's value. Depending on the provided property's key, the key is either used for the short option or the long option.- Parameters:
aProperty
- The key (=alias) and the value for the operand.
-
DoubleProperty
public DoubleProperty(org.refcodes.struct.Relation<String, Double> aProperty, Consumer<DoubleProperty> aConsumer) Instantiates a newDoubleProperty
with the alias being the proerty's key and the value being the property's value. Depending on the provided property's key, the key is either used for the short option or the long option.- Parameters:
aProperty
- The key (=alias) and the value for the operand.aConsumer
- TheConsumer
being invoked in case thisDoubleProperty
participated in successfully parsing the command line arguments.
-
DoubleProperty
Instantiates a newDoubleProperty
with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.- Parameters:
aLongProperty
- The long option to use.aDescription
- The description of theDoubleProperty
-
DoubleProperty
Instantiates a newDoubleProperty
with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.- Parameters:
aLongOption
- The long option to use.aDescription
- The description of theDoubleProperty
aConsumer
- TheConsumer
being invoked in case thisDoubleProperty
participated in successfully parsing the command line arguments.
-
DoubleProperty
Instantiates a newDoubleProperty
with the given arguments.- Parameters:
aLongProperty
- The long option to use.aAlias
- The alias to be used for naming purposes.aDescription
- The description of theDoubleProperty
-
DoubleProperty
public DoubleProperty(String aLongOption, String aAlias, String aDescription, Consumer<DoubleProperty> aConsumer) Instantiates a newDoubleProperty
with the given arguments.- Parameters:
aLongOption
- The long option to use.aAlias
- The alias to be used for naming purposes.aDescription
- The description of theDoubleProperty
aConsumer
- TheConsumer
being invoked in case thisDoubleProperty
participated in successfully parsing the command line arguments.
-
-
Method Details
-
withVisible
Visibility in this context means displaying or hiding thisTerm
's existence to the user (defaults totrue
). -
toType
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<Double>
- 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.
-
getDescription
- Specified by:
getDescription
in interfaceorg.refcodes.mixin.DescriptionAccessor
-
getException
Retrieves theArgsSyntaxException
exception in case invokingTerm.parseArgs(String[], CliContext)
failed. The exception (and the according suppressed ones alongside the causes) does not necessarily have been thrown by theTerm.parseArgs(String[], CliContext)
method depending on the semantics of theTerm
handing the exception (theAnyCondition
provides any exceptions it caught even though it did not throw them as of its semantics).- Specified by:
getException
in interfaceorg.refcodes.exception.ExceptionAccessor<ArgsSyntaxException>
- Specified by:
getException
in interfaceTerm
- Returns:
- The
ArgsSyntaxException
exception occurring while parsing the arguments.
-
setVisible
public void setVisible(boolean isVisible) Visibility in this context means displaying or hiding thisTerm
's existence to the user (defaults totrue
).- Specified by:
setVisible
in interfaceTerm
- Specified by:
setVisible
in interfaceorg.refcodes.graphical.VisibleAccessor.VisibleMutator
-
isVisible
-
toArgsDiff
Creates the difference between the provided set and the providedList
s therein found argument arrays subset (as ofOperand.getParsedArgs()
).- Parameters:
aArgs
- The set to be used for the diff operation.aArgsSubset
- The subset to be used for the diff operation being the lists containing theOperand
instances whose command line arguments are to be diffed.- Returns:
- The difference between the set and the subset.
-
toArgsDiff
Creates the difference between the provided set and the providedList
s therein found argument arrays subset (as ofOperand.getParsedArgs()
).- Parameters:
aArgs
- The set to be used for the diff operation.aArgsSubset
- The subset to be used for the diff operation being the lists containing theOperand
instances whose command line arguments are to be diffed.- Returns:
- The difference between the set and the subset.
-
toArgsDiff
Creates the difference between the provided set and the provided subset.- Parameters:
aArgs
- The set to be used for the diff operation.aArgsSubset
- The subset to be used for the diff operation.- Returns:
- The difference between the set and the subset.
-
toParsedArgs
Takes allOperand
instances found in the providedList
s and adds all therein found argument arrays (as ofOperand.getParsedArgs()
) to the result.
-