org.refcodes.console

Class EnumOptionImpl<T extends Enum<T>>

java.lang.Object

org.refcodes.console.AbstractOperand<T>

org.refcodes.console.AbstractOption<T>

org.refcodes.console.EnumOptionImpl<T>

Type Parameters:

T - the generic type

All Implemented Interfaces:

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

public class EnumOptionImpl<T extends Enum<T>>
extends AbstractOption<T>

The Class EnumOptionImpl.

Author:

steiner

Nested Class Summary

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

org.refcodes.mixin.ValueAccessor.ValueBuilder<V,B extends org.refcodes.mixin.ValueAccessor.ValueBuilder<V,B>>, org.refcodes.mixin.ValueAccessor.ValueMutator<V>, org.refcodes.mixin.ValueAccessor.ValueProperty<V>

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>, org.refcodes.mixin.TypeAccessor.TypeProperty<T>

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

ArgsAccessor.ArgsMutator, ArgsAccessor.ArgsProperty

Constructor Summary

Constructors

Constructor and Description
EnumOptionImpl(String aShortOption, String aLongOption, Class<T> aType, String aOptionArgName, String aDescription) Instantiates a new enum option impl.

Method Summary

Modifier and Type	Method and Description
String	parseSyntax(SyntaxNotation aSyntaxNotation) This method is to be called from from the root Syntaxable; when invoking syntax retrieval inside the Syntaxable hierarchy use the method Syntaxable.toSyntax(SyntaxNotation) .
protected T	toValue(String aArg) Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.

Methods inherited from class org.refcodes.console.AbstractOption

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

Methods inherited from class org.refcodes.console.AbstractOperand

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

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

getArgs, getParameterName, getValue, hasValue

Methods inherited from interface org.refcodes.mixin.DescriptionAccessor

getDescription

Methods inherited from interface org.refcodes.mixin.TypeAccessor

getType

Methods inherited from interface org.refcodes.console.Syntaxable

parseSyntax

Methods inherited from interface org.refcodes.component.Resetable

reset

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

EnumOptionImpl

public EnumOptionImpl(String aShortOption,
                      String aLongOption,
                      Class<T> aType,
                      String aOptionArgName,
                      String aDescription)

Instantiates a new enum option impl.

Parameters:

aShortOption - the a short option

aLongOption - the a long option

aType - the a type

aOptionArgName - the a option arg name

aDescription - the a description

Method Detail

toValue

protected T toValue(String aArg)
             throws ParseArgsException

Description copied from class: AbstractOperand

Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type. In case conversion failed, then an according exception is to be thrown.

Specified by:

toValue in class AbstractOperand<T extends Enum<T>>

Parameters:

aArg - The command line argument to be converted to an instance of the given type T.

Returns:

An instance of type T from the provided command line argument.

Throws:

ParseArgsException - Thrown in case the provided command line arguments do not respect the required syntax or cannot be converted to the required type.

parseSyntax

public String parseSyntax(SyntaxNotation aSyntaxNotation)

Description copied from interface: Syntaxable

This method is to be called from from the root Syntaxable; when invoking syntax retrieval inside the Syntaxable hierarchy use the method Syntaxable.toSyntax(SyntaxNotation) . Returns the human readable (verbose) syntax of this Syntaxable instance including, in case of being a node in the syntax tree (such as a Condition, the syntax of the child Syntaxable instances. ATTENTION: As of different parenthesis settings for some notations regarding the root Syntaxable and the child Syntaxables, the method Syntaxable.toSyntax(SyntaxNotation) is called from inside the Syntaxable hierarchy. In case the syntax is to be retrieved from the root Syntaxable, then the applicable method to be called is Syntaxable.parseSyntax(SyntaxNotation), as for some notations it will for example not create the most outer braces.

Specified by:

parseSyntax in interface Syntaxable

Parameters:

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

Returns:

The human readable (verbose) command line arguments syntax.