org.refcodes.console.impls

Class EnumOptionImpl<T extends Enum<T>>

java.lang.Object

org.refcodes.console.impls.AbstractSyntaxable

org.refcodes.console.impls.AbstractOperand<T>

org.refcodes.console.impls.AbstractOption<T>

org.refcodes.console.impls.EnumOptionImpl<T>

All Implemented Interfaces:

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

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

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

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)

Method Summary

Modifier and Type	Method and Description
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.impls.AbstractOption

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

Methods inherited from class org.refcodes.console.impls.AbstractOperand

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

Methods inherited from class org.refcodes.console.impls.AbstractSyntaxable

parseSyntax

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

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)

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.