org.dishevelled.commandline.argument

Class FloatArgument

java.lang.Object

org.dishevelled.commandline.argument.AbstractArgument<Float>

org.dishevelled.commandline.argument.FloatArgument

All Implemented Interfaces:

Argument<Float>

public final class FloatArgument
extends AbstractArgument<Float>

A float argument.

Author:

Michael Heuer

Constructor Summary

Constructors

Constructor and Description
FloatArgument(String shortName, String longName, String description, boolean required) Create a new float argument.

Method Summary

Modifier and Type	Method and Description
protected Float	convert(String s) Convert the specified string value into an instance of class E.

Methods inherited from class org.dishevelled.commandline.argument.AbstractArgument

equals, getDescription, getLongName, getShortName, getValue, getValue, hashCode, isArgumentString, isRequired, isValueString, visit, wasFound

Methods inherited from class java.lang.Object

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

Constructor Detail

FloatArgument

public FloatArgument(String shortName,
                     String longName,
                     String description,
                     boolean required)

Create a new float argument.

Parameters:

shortName - short argument name

longName - long argument name

description - argument description

required - true if this argument is required

Method Detail

convert

protected Float convert(String s)
                 throws Exception

Convert the specified string value into an instance of class E.

Specified by:

convert in class AbstractArgument<Float>

Parameters:

s - string value

Returns:

an instance of class E converted from the specified string value

Throws:

Exception - if an error occurs