snaq.util.jclap

Class FloatOption

java.lang.Object

snaq.util.jclap.Option<Float>

snaq.util.jclap.FloatOption

public class FloatOption
extends Option<Float>

Implementation of an Option with value of type Float.

Author:

Giles Winstanley

Field Summary

Fields inherited from class snaq.util.jclap.Option

bundle, ILLEGAL_SN_CHARS, locale, MAX_COUNT_LIMIT, MIN_COUNT_LIMIT, values

Constructor Summary

Constructors

Constructor and Description
FloatOption(String shortName, String longName, String description, boolean mandatory, boolean allowMany) Creates a new FloatOption instance.
FloatOption(String shortName, String longName, String description, int minCount, int maxCount) Creates a new FloatOption instance.

Method Summary

Methods

Modifier and Type	Method and Description
Class<Float>	getType() Returns the class type of value this option can take.
protected String	getUsageTypeString() Returns the option type, for display in the usage message.
protected Float	parseValue(String arg) Parses the argument string for an option value.

Methods inherited from class snaq.util.jclap.Option

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

Methods inherited from class java.lang.Object

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

Constructor Detail

FloatOption

public FloatOption(String shortName,
           String longName,
           String description,
           int minCount,
           int maxCount)

Creates a new FloatOption instance.

Parameters:

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

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

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

FloatOption

public FloatOption(String shortName,
           String longName,
           String description,
           boolean mandatory,
           boolean allowMany)

Creates a new FloatOption instance.

Parameters:

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

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

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)

Method Detail

parseValue

protected Float parseValue(String arg)
                    throws OptionException

Parses the argument string for an option value.

Specified by:

parseValue in class Option<Float>

Parameters:

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

Returns:

Value of the parsed argument string

Throws:

OptionException - if a problem occurs while parsing the argument string

getType

public Class<Float> getType()

Description copied from class: Option

Returns the class type of value this option can take.

Specified by:

getType in class Option<Float>

getUsageTypeString

protected String getUsageTypeString()

Description copied from class: Option

Returns the option type, for display in the usage message. This may be overridden by sub-classes to provide a more meaningful type. By default this returns an appropriate type for the primitives, and string type for all others.

Overrides:

getUsageTypeString in class Option<Float>