Module net.snaq.jclap

Package snaq.util.jclap

Class EnumeratedIntegerOption

java.lang.Object

snaq.util.jclap.Option<E>

snaq.util.jclap.EnumeratedOption<Integer>

snaq.util.jclap.EnumeratedIntegerOption

public final class EnumeratedIntegerOption
extends EnumeratedOption<Integer>

Implementation of an Option with value restricted to a specified enumeration of type Integer.

Author:

Giles Winstanley

Field Summary

Fields inherited from class snaq.util.jclap.Option

BUNDLE, LOCALE, MAX_COUNT_LIMIT, MIN_COUNT_LIMIT

Constructor Summary

Constructors

Constructor	Description
EnumeratedIntegerOption(String shortName, String longName, String description, boolean mandatory, boolean allowMany, Collection<Integer> allowedValues)	Creates a new EnumeratedIntegerOption instance.
EnumeratedIntegerOption(String shortName, String longName, String description, int minCount, int maxCount, Collection<Integer> allowedValues)	Creates a new EnumeratedIntegerOption instance.

Method Summary

Modifier and Type	Method	Description
Class<Integer>	getType()	Returns the class type of value this option can take.
protected Integer	parseValue(String arg, Locale locale)	Parses the argument string for an option value, optionally using the specified locale for reference (e.g.

Methods inherited from class snaq.util.jclap.EnumeratedOption

getAllowedValues, getAllowedValuesString, getAllowedValuesString, isValueValid, toString

Methods inherited from class snaq.util.jclap.Option

addValue, equals, getDescription, getLongName, getMaxCount, getMinCount, getShortName, getValues, hashCode, isAllowMany, isHidden, isMandatory, requiresValue, setHidden, setMinMaxCounts

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EnumeratedIntegerOption

public EnumeratedIntegerOption(String shortName,
                               String longName,
                               String description,
                               int minCount,
                               int maxCount,
                               Collection<Integer> allowedValues)

Creates a new EnumeratedIntegerOption instance.

Parameters:

shortName - short name of the option (e.g. -t)

longName - long name of the option (e.g. --type)

description - helpful description of the option (printed for usage message)

minCount - minimum number of occurrences required for this option

maxCount - maximum number of occurrences required for this option

allowedValues - collection of possible values this option can take

EnumeratedIntegerOption

public EnumeratedIntegerOption(String shortName,
                               String longName,
                               String description,
                               boolean mandatory,
                               boolean allowMany,
                               Collection<Integer> allowedValues)

Creates a new EnumeratedIntegerOption instance.

Parameters:

shortName - short name of the option (e.g. -t)

longName - long name of the option (e.g. --type)

description - helpful description of the option (printed for usage message)

mandatory - whether this option must be specified

allowMany - whether this option can take more than one value (i.e. be specified more than once)

allowedValues - collection of possible values this option can take

Method Detail

parseValue

protected Integer parseValue(String arg,
                             Locale locale)
                      throws OptionException

Parses the argument string for an option value, optionally using the specified locale for reference (e.g. for date parsing).

Specified by:

parseValue in class Option<Integer>

Parameters:

arg - string argument from which a value is to be parsed

locale - locale as specified when initializing the CLAParser instance

Returns:

Value of the parsed argument string

Throws:

OptionException - if a problem occurs while parsing the argument string

getType

public Class<Integer> getType()

Returns the class type of value this option can take.

Specified by:

getType in class Option<Integer>

Returns:

Class instance