org.refcodes.console

Interface Option<T>

All Superinterfaces:

ArgsAccessor, Comparable<Operand<?>>, org.refcodes.mixin.mixins.DescriptionAccessor, Operand<T>, org.refcodes.component.mixins.Resetable, Syntaxable, org.refcodes.mixin.mixins.TypeAccessor, org.refcodes.mixin.mixins.ValueAccessor<T>

All Known Subinterfaces:

Switch

All Known Implementing Classes:

AbstractOption, ForceSwitchImpl, HelpSwitchImpl, QuietSwitchImpl, StringOptionImpl, SwitchImpl, VerboseSwitchImpl

public interface Option<T>
extends Operand<T>

An Option represents a command line option with the according option's value. An Option can be seen as a key / value(s) pair defined in the command line arguments parsed via the Syntaxable.parseArgs(String[]) method.

An Option has a state which changes with each invocation of the Syntaxable.parseArgs(String[]) method.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.mixins.ValueAccessor

org.refcodes.mixin.mixins.ValueAccessor.ValueMutator<V>, org.refcodes.mixin.mixins.ValueAccessor.ValueProperty<V>

Nested classes/interfaces inherited from interface org.refcodes.mixin.mixins.DescriptionAccessor

org.refcodes.mixin.mixins.DescriptionAccessor.DescriptionBuilder<B>, org.refcodes.mixin.mixins.DescriptionAccessor.DescriptionMutator, org.refcodes.mixin.mixins.DescriptionAccessor.DescriptionProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.mixins.TypeAccessor

org.refcodes.mixin.mixins.TypeAccessor.TypeMutator, org.refcodes.mixin.mixins.TypeAccessor.TypeProperty

Nested classes/interfaces inherited from interface org.refcodes.console.mixins.ArgsAccessor

ArgsAccessor.ArgsMutator, ArgsAccessor.ArgsProperty

Method Summary

Modifier and Type	Method and Description
String	getLongOption() TODO: Make the option to be required without the hyphen-minuses "--" Returns the long-option representing an Option instance.
String	getShortOption() Returns the short-option representing an Option instance.

Methods inherited from interface org.refcodes.console.Operand

getArgs, getParameterName, getValue

Methods inherited from interface org.refcodes.mixin.mixins.DescriptionAccessor

getDescription

Methods inherited from interface org.refcodes.mixin.mixins.TypeAccessor

getType

Methods inherited from interface org.refcodes.console.Syntaxable

parseArgs, parseSyntax, toState, toSyntax

Methods inherited from interface org.refcodes.component.mixins.Resetable

reset

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getShortOption

String getShortOption()

Returns the short-option representing an Option instance. A short option usually is being prefixed with a single hyphen-minus "-" as defined in ConsoleConsts.SHORT_OPTION_PREFIX.

Returns:

The short-option String.

getLongOption

String getLongOption()

TODO: Make the option to be required without the hyphen-minuses "--" Returns the long-option representing an Option instance. A long option usually is being prefixed with a double hyphen-minus "--" as defined in ConsoleConsts.LONG_OPTION_PREFIX.

Returns:

The long-option String.