- All Implemented Interfaces:
Cloneable
,Comparable<Operand<?>>
,ArgsAccessor
,Constituent
,Operand<Boolean>
,Option<Boolean>
,Synopsisable
,org.refcodes.mixin.AliasAccessor
,org.refcodes.mixin.Clonable
,org.refcodes.mixin.DescriptionAccessor
,org.refcodes.mixin.EnabledAccessor
,org.refcodes.mixin.Resetable
,org.refcodes.mixin.Schemable<CliSchema>
,org.refcodes.mixin.TypeAccessor<Boolean>
,org.refcodes.mixin.ValueAccessor<Boolean>
A predefined help
Flag
: A predefined Flag
gives its
SHORT_OPTION
, its LONG_OPTION
as well as its ALIAS
an according semantics regarded by other subsystems.-
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.EnabledAccessor
org.refcodes.mixin.EnabledAccessor.EnabledBuilder<B extends org.refcodes.mixin.EnabledAccessor.EnabledBuilder<B>>, org.refcodes.mixin.EnabledAccessor.EnabledMutator, org.refcodes.mixin.EnabledAccessor.EnabledProperty
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
Modifier and TypeFieldDescriptionprotected String
static final String
static final String
static final Character
Fields inherited from class org.refcodes.cli.AbstractOperand
_value
-
Constructor Summary
-
Method Summary
Methods inherited from class org.refcodes.cli.AbstractOption
clone, contains, getLongOption, getShortOption, setParsedArgs, setValue, toOptionArgument, toOptionArgument, toSchema
Methods inherited from class org.refcodes.cli.AbstractOperand
compareTo, getAlias, getType, getValue, toParsedArgs, toString
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.cli.Constituent
parseArgs, toSynopsis, toSyntax, toSyntax, toSyntax, toSyntax
Methods inherited from interface org.refcodes.mixin.DescriptionAccessor
getDescription
Methods inherited from interface org.refcodes.cli.Operand
getAlias, getValue, hasValue, toParsedArgs, toSpec, toValue
Methods inherited from interface org.refcodes.cli.Option
getLongOption, getShortOption
Methods inherited from interface org.refcodes.mixin.Schemable
toSchema
Methods inherited from interface org.refcodes.cli.Synopsisable
toSynopsis, toSynopsis, toSynopsis, toSynopsis
Methods inherited from interface org.refcodes.mixin.TypeAccessor
getType
Methods inherited from interface org.refcodes.mixin.ValueAccessor
getValueOr
-
Field Details
-
ALIAS
- See Also:
-
LONG_OPTION
- See Also:
-
SHORT_OPTION
-
_description
-
-
Constructor Details
-
HelpFlag
Constructs the predefined helpFlag
.- Parameters:
aDescription
- The description to be used (without any line breaks).
-
HelpFlag
Constructs the predefined helpFlag
.- Parameters:
aDescription
- The description to be used (without any line breaks).hasShortOption
- True in case to also enable the short option, else only the long option takes effect.
-
HelpFlag
public HelpFlag()Constructs the predefined helpFlag
. -
HelpFlag
public HelpFlag(boolean hasShortOption) Constructs the predefined helpFlag
.- Parameters:
hasShortOption
- True in case to also enable the short option, else only the long option takes effect.
-
-
Method Details
-
getDescription
- Specified by:
getDescription
in interfaceorg.refcodes.mixin.DescriptionAccessor
-