Package org.refcodes.console
Class HelpFlagImpl
- java.lang.Object
-
- org.refcodes.console.AbstractOperand<T>
-
- org.refcodes.console.AbstractOption<java.lang.Boolean>
-
- org.refcodes.console.FlagImpl
-
- org.refcodes.console.HelpFlagImpl
-
- All Implemented Interfaces:
java.lang.Comparable<Operand<?>>
,org.refcodes.component.Resetable
,ArgsAccessor
,Flag
,Operand<java.lang.Boolean>
,Option<java.lang.Boolean>
,Syntaxable
,SyntaxUsage
,org.refcodes.mixin.AliasAccessor
,org.refcodes.mixin.DescriptionAccessor
,org.refcodes.mixin.TypeAccessor<java.lang.Boolean>
,org.refcodes.mixin.ValueAccessor<java.lang.Boolean>
public class HelpFlagImpl extends FlagImpl
A predefined help switch.
-
-
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.console.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.TypeMutator<T extends java.lang.Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends java.lang.Object>
-
Nested classes/interfaces inherited from interface org.refcodes.mixin.ValueAccessor
org.refcodes.mixin.ValueAccessor.ValueBuilder<V extends java.lang.Object,B extends org.refcodes.mixin.ValueAccessor.ValueBuilder<V,B>>, org.refcodes.mixin.ValueAccessor.ValueMutator<V extends java.lang.Object>, org.refcodes.mixin.ValueAccessor.ValueProperty<V extends java.lang.Object>
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ALIAS
static java.lang.String
LONG_OPTION
static java.lang.String
SHORT_OPTION
-
Fields inherited from class org.refcodes.console.AbstractOperand
_value
-
-
Constructor Summary
Constructors Constructor Description HelpFlagImpl()
Constructs the predefined help switch.HelpFlagImpl(java.lang.String aDescription)
Constructs the predefined help switch.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
toUsage(SyntaxNotation aSyntaxNotation)
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)
is called from inside aSyntaxable
hierarchy.-
Methods inherited from class org.refcodes.console.AbstractOperand
compareTo, getAlias, getArgs, getDescription, getType, getValue, toString
-
Methods inherited from class org.refcodes.console.AbstractOption
getLongOption, getShortOption, setArgs, setValue, toState, toSyntax
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.refcodes.console.Operand
get, getAlias, getArgs, getValue, hasValue
-
Methods inherited from interface org.refcodes.console.Option
getLongOption, getShortOption
-
Methods inherited from interface org.refcodes.console.Syntaxable
toState, toSyntax
-
Methods inherited from interface org.refcodes.console.SyntaxUsage
toUsage, toUsage
-
-
-
-
Field Detail
-
ALIAS
public static final java.lang.String ALIAS
- See Also:
- Constant Field Values
-
LONG_OPTION
public static final java.lang.String LONG_OPTION
- See Also:
- Constant Field Values
-
SHORT_OPTION
public static final java.lang.String SHORT_OPTION
- See Also:
- Constant Field Values
-
-
Method Detail
-
toUsage
public java.lang.String toUsage(SyntaxNotation aSyntaxNotation)
Description copied from interface:SyntaxUsage
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)
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 isSyntaxUsage.toUsage(SyntaxNotation)
, as for some notations it will for example not create the most outer braces.- Specified by:
toUsage
in interfaceSyntaxUsage
- Parameters:
aSyntaxNotation
- The syntax notation used for generating the command line arguments syntax.- Returns:
- The human readable (verbose) command line arguments syntax.
-
-