T
- the generic typeorg.refcodes.mixin.AliasAccessor
, ArgsAccessor
, Comparable<Operand<?>>
, org.refcodes.mixin.DescriptionAccessor
, org.refcodes.component.Resetable
, Syntaxable
, SyntaxUsage
, org.refcodes.mixin.TypeAccessor<T>
, org.refcodes.mixin.ValueAccessor<T>
AbstractOperand
, AbstractOption
, EnumOptionImpl
, ForceSwitchImpl
, HelpSwitchImpl
, IntegerOptionImpl
, QuietSwitchImpl
, StringOperandImpl
, StringOptionImpl
, SwitchImpl
, SysInfoSwitchImpl
, VerboseSwitchImpl
public interface Operand<T> extends org.refcodes.mixin.ValueAccessor<T>, org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.TypeAccessor<T>, Syntaxable, ArgsAccessor, Comparable<Operand<?>>, org.refcodes.mixin.AliasAccessor
Operand
represents a value parsed from command line arguments. In
comparison to an Option
an Operand
just represents a plain
value without an identifier in front of it. An Operand
has a state
which changes with each invocation of the Syntaxable.parseArgs(String[])
method.
It is recommended to put your Operand
instance(s) at the end of your
top Condition
to enforce it to be the last Syntaxable
(s) when
parsing the command line arguments - this makes sure that any Option
s
pick their option arguments so that the Operand
(s) will correctly be
left over for parsing command line argument(s); the Operand
will not
pick by mistake an option argument.
org.refcodes.mixin.AliasAccessor.AliasBuilder<B extends org.refcodes.mixin.AliasAccessor.AliasBuilder<B>>, org.refcodes.mixin.AliasAccessor.AliasMutator, org.refcodes.mixin.AliasAccessor.AliasProperty
ArgsAccessor.ArgsMutator, ArgsAccessor.ArgsProperty
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 extends Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends Object>
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>
Modifier and Type | Method | Description |
---|---|---|
default <V> V |
get(String aAlias) |
Searches for a value being set for the given for given alias in the
syntax tree parsing the command line arguments; if a node in the syntax
tree has a value for the given alias, then this value is returned.
|
String |
getAlias() |
|
String[] |
getArgs() |
Retrieves the command line arguments from the args property.
|
T |
getValue() |
|
default boolean |
hasValue() |
When being parsed via the
Syntaxable.parseArgs(String[]) method, use this
method to determine whether the getValue() method contains
parsed value. |
compareTo
parseArgs, toState, toSyntax
toUsage, toUsage
default boolean hasValue()
Syntaxable.parseArgs(String[])
method, use this
method to determine whether the getValue()
method contains
parsed value.Syntaxable.parseArgs(String[])
method.String[] getArgs()
getArgs
in interface ArgsAccessor
String getAlias()
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.getAlias
in interface org.refcodes.mixin.AliasAccessor
default <V> V get(String aAlias)
get
in interface Syntaxable
V
- The type of the value being expected.aAlias
- The alias for which to seek for a value being set.Copyright © 2018. All rights reserved.