Module org.refcodes.cli

Package org.refcodes.cli

Class ConfigOption

java.lang.Object

org.refcodes.cli.AbstractOperand<T>

org.refcodes.cli.AbstractOption<String>

org.refcodes.cli.StringOption

org.refcodes.cli.ConfigOption

All Implemented Interfaces:

Cloneable, Comparable<Operand<?>>, ArgsAccessor, Operand<String>, Option<String>, Syntaxable, SyntaxUsage, org.refcodes.component.Resetable, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.Clonable, org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.TypeAccessor<String>, org.refcodes.mixin.ValueAccessor<String>

public class ConfigOption
extends StringOption

The ConfigOption represents an Option holding a value specifying a configuration file or identifying a configuration in general.

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.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

Fields

Modifier and Type	Field	Description
static String	ALIAS
static String	LONG_OPTION
static String	SHORT_OPTION

Fields inherited from class org.refcodes.cli.AbstractOperand

_value

Constructor Summary

Constructors

Constructor	Description
ConfigOption()	Instantiates a new configuration option (e.g. a file name for a configuration file or some other identifier for a configuration).
ConfigOption(String aDescription)	Instantiates a new configuration option (e.g. a file name for a configuration file or some other identifier for a configuration).

Method Summary

Modifier and Type	Method	Description
String	toUsage(SyntaxNotation aSyntaxNotation, String aOptionEscCode, 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.cli.StringOption

toType

Methods inherited from class org.refcodes.cli.AbstractOption

clone, getLongOption, getOptionPrefixes, getShortOption, parseArgs, setArgs, setValue, toState, toSyntax

Methods inherited from class org.refcodes.cli.AbstractOperand

compareTo, getAlias, getArgs, getDescription, getType, getValue, reset, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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, getArgs, getValue, hasValue, toValue

Methods inherited from interface org.refcodes.cli.Option

getOptions

Methods inherited from interface org.refcodes.component.Resetable

reset

Methods inherited from interface org.refcodes.cli.Syntaxable

parseArgs, toSyntax, toSyntax, toSyntax

Methods inherited from interface org.refcodes.cli.SyntaxUsage

toUsage, 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 String ALIAS

See Also:

Constant Field Values

LONG_OPTION

public static final String LONG_OPTION

See Also:

Constant Field Values

SHORT_OPTION

public static final String SHORT_OPTION

Constructor Detail

ConfigOption

public ConfigOption(String aDescription)

Instantiates a new configuration option (e.g. a file name for a configuration file or some other identifier for a configuration).

Parameters:

aDescription - The description to use.

ConfigOption

public ConfigOption()

Instantiates a new configuration option (e.g. a file name for a configuration file or some other identifier for a configuration).

Method Detail

toUsage

public String toUsage(SyntaxNotation aSyntaxNotation,
                      String aOptionEscCode,
                      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.