Package org.refcodes.console

Class HelpFlag

java.lang.Object

org.refcodes.console.AbstractOperand<T>

org.refcodes.console.AbstractOption<java.lang.Boolean>

org.refcodes.console.Flag

org.refcodes.console.HelpFlag

All Implemented Interfaces:

java.lang.Comparable<java.lang.Boolean>, org.refcodes.component.Resetable, ArgsAccessor, 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 HelpFlag
extends Flag

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
HelpFlag()	Constructs the predefined help switch.
HelpFlag(java.lang.String aDescription)	Constructs the predefined help switch.

Method Summary

Modifier and Type	Method	Description
java.lang.String	toUsage(SyntaxNotation aSyntaxNotation, java.lang.String aOptionEscCode, java.lang.String aResetEscCode)	Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Syntaxable and the child Syntaxables, the method Syntaxable.toSyntax(SyntaxNotation, String, String) is called from inside a Syntaxable 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, getOptionPrefixes, getShortOption, setArgs, setValue, toState, toSyntax

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.refcodes.mixin.DescriptionAccessor

getDescription

Methods inherited from class org.refcodes.console.Flag

isEnabled, parseArgs, reset, toValue

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

parseArgs, toState, toSyntax, toSyntax

Methods inherited from interface org.refcodes.console.SyntaxUsage

toUsage, toUsage, toUsage

Methods inherited from interface org.refcodes.mixin.TypeAccessor

getType

Methods inherited from interface org.refcodes.mixin.ValueAccessor

getValueOr

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

Constructor Detail

HelpFlag

public HelpFlag(java.lang.String aDescription)

Constructs the predefined help switch.

Parameters:

aDescription - A description without any line breaks.

HelpFlag

public HelpFlag()

Constructs the predefined help switch.

Method Detail

toUsage

public java.lang.String toUsage(SyntaxNotation aSyntaxNotation,
                                java.lang.String aOptionEscCode,
                                java.lang.String aResetEscCode)

Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Syntaxable and the child Syntaxables, the method Syntaxable.toSyntax(SyntaxNotation, String, String) is called from inside a Syntaxable hierarchy. In case the syntax is to be retrieved from the root Syntaxable or an encapsulating and different type, then the applicable method to be called is SyntaxUsage.toUsage(SyntaxNotation), as for some notations it will for example not create the most outer braces.

Specified by:

toUsage in interface SyntaxUsage

Parameters:

aSyntaxNotation - The syntax notation used for generating the command line arguments syntax.

aOptionEscCode - The escape code to be used when processing an option, e.g. this can be an ANSI Escape-Code to highlight the option parameters (for example "--help", "-q" and so on).

aResetEscCode - The escape code to close (reset) any Escape-Code being set before.

Returns:

The human readable (verbose) command line arguments syntax.