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, Constituent, Operand<String>, Option<String>, Synopsisable, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.Clonable, org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.Resetable, org.refcodes.mixin.Schemable<CliSchema>, 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 resource (file).

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
protected String	_description
static final String	ALIAS
static final String	LONG_OPTION
static final Character	SHORT_OPTION

Fields inherited from class org.refcodes.cli.AbstractOperand

_value

Constructor Summary

Constructors

Constructor	Description
ConfigOption()	Constructs the predefined config (file) Option.
ConfigOption(boolean hasShortOption)	Constructs the predefined config (file) Option.
ConfigOption(String aDescription)	Instantiates a new config (file) Option.
ConfigOption(String aDescription, boolean hasShortOption)	Constructs the predefined config (file) Option.

Method Summary

Modifier and Type	Method	Description
String	getDescription()

Methods inherited from class org.refcodes.cli.StringOption

toType

Methods inherited from class org.refcodes.cli.AbstractOption

clone, contains, getLongOption, getShortOption, parseArgs, setParsedArgs, setValue, toOptionArgument, toOptionArgument, toSchema, toSyntax

Methods inherited from class org.refcodes.cli.AbstractOperand

compareTo, getAlias, getType, getValue, reset, toParsedArgs, 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.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.mixin.Resetable

reset

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

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 Character SHORT_OPTION

_description

protected String _description

Constructor Details

ConfigOption

public ConfigOption(String aDescription)

Instantiates a new config (file) Option.

Parameters:

aDescription - The description to use.

ConfigOption

public ConfigOption(String aDescription,
 boolean hasShortOption)

Constructs the predefined config (file) Option.

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.

ConfigOption

public ConfigOption()

Constructs the predefined config (file) Option.

ConfigOption

public ConfigOption(boolean hasShortOption)

Constructs the predefined config (file) Option.

Parameters:

hasShortOption - True in case to also enable the short option, else only the long option takes effect.

Method Details

getDescription

public String getDescription()

Specified by:

getDescription in interface org.refcodes.mixin.DescriptionAccessor