Option (org.refcodes:refcodes-console 2.0.3 API)

Type Parameters:

T - the generic type

All Superinterfaces:

org.refcodes.mixin.AliasAccessor, ArgsAccessor, java.lang.Comparable<T>, org.refcodes.mixin.DescriptionAccessor, Operand<T>, org.refcodes.component.Resetable, Syntaxable, SyntaxUsage, org.refcodes.mixin.TypeAccessor<T>, org.refcodes.mixin.ValueAccessor<T>

All Known Implementing Classes:

AbstractOption, DebugFlag, EnumOption, FileOption, Flag, ForceFlag, HelpFlag, IntegerOption, LongOption, QuietFlag, StringOption, SysInfoFlag, VerboseFlag
```
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[], String[]) method.
An Option has a state which changes with each invocation of the Syntaxable.parseArgs(String[], String[]) method.

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>

Method Summary

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

Methods inherited from interface java.lang.Comparable
compareTo

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

Methods inherited from interface org.refcodes.console.Operand
get, getAlias, getArgs, getValue, hasValue

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

Methods inherited from interface org.refcodes.console.Syntaxable
parseArgs, 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

- Method Detail
  - getShortOption
```
java.lang.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 CommandArgPrefix.POSIX_SHORT_OPTION.
    
    Returns:
    
    The short-option String.
  - getLongOption
```
java.lang.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 CommandArgPrefix.POSIX_LONG_OPTION.
    
    Returns:
    
    The long-option String.