jargs.gnu.option
Class FloatOption

java.lang.Object
  jargs.gnu.option.AbstractOption<java.lang.Float>
      jargs.gnu.option.FloatOption

public class FloatOption
extends AbstractOption<java.lang.Float>

An option that expects a floating-point value.

Author:

Philipp Eichhorn

Constructor Summary

FloatOption(char shortForm, java.lang.String longForm, java.lang.String description)

FloatOption(java.lang.String longForm, java.lang.String description)

Method Summary

java.lang.Float

parseValue(java.lang.String arg, java.util.Locale locale) Override to extract and convert an option value passed on the command-line.

Methods inherited from class jargs.gnu.option.AbstractOption

addValidator, description, getValue, longForm, shortForm, toString, wantsValue

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FloatOption

public FloatOption(java.lang.String longForm,
                   java.lang.String description)

FloatOption

public FloatOption(char shortForm,
                   java.lang.String longForm,
                   java.lang.String description)

Method Detail

parseValue

public java.lang.Float parseValue(java.lang.String arg,
                                  java.util.Locale locale)
                           throws IllegalOptionValueException

Description copied from class: AbstractOption

Override to extract and convert an option value passed on the command-line.

Specified by:

parseValue in class AbstractOption<java.lang.Float>

Parameters:

arg - A command-line argument.

locale - The specified Locale.

Returns:

The parsed option value.

Throws:

IllegalOptionValueException