org.jargp

Class FloatDef

java.lang.Object

org.jargp.ParameterDef

org.jargp.FloatDef

public class FloatDef
extends ParameterDef

Command line float parameter definition. This defines a command line flag with an associated float value. The optionally signed value must immediately follow the flag character within the same argument string.

Constructor Summary

Constructors

Constructor and Description
FloatDef(char chr, java.lang.String name) Constructor with no range or description.
FloatDef(char chr, java.lang.String name, float min, float max) Constructor with range but no description.
FloatDef(char chr, java.lang.String name, java.lang.String desc) Constructor with no range defined.
FloatDef(char chr, java.lang.String name, java.lang.String desc, float min, float max) Constructor with range and description.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAbbreviation() Get text abbreviation for parameter.
void	handle(ArgumentProcessor proc) Handle argument.

Methods inherited from class org.jargp.ParameterDef

getDescription, getFlag

Methods inherited from class java.lang.Object

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

Constructor Detail

FloatDef

public FloatDef(char chr,
                java.lang.String name,
                java.lang.String desc,
                float min,
                float max)

Constructor with range and description.

Parameters:

chr - parameter flag character

name - field name for parameter

desc - discription text for parameter

min - minimum allowed value

max - maximum allowed value

FloatDef

public FloatDef(char chr,
                java.lang.String name,
                float min,
                float max)

Constructor with range but no description.

Parameters:

chr - parameter flag character

name - field name for parameter

min - minimum allowed value

max - maximum allowed value

FloatDef

public FloatDef(char chr,
                java.lang.String name,
                java.lang.String desc)

Constructor with no range defined.

Parameters:

chr - parameter flag character

name - field name for parameter

desc - discription text for parameter

FloatDef

public FloatDef(char chr,
                java.lang.String name)

Constructor with no range or description.

Parameters:

chr - parameter flag character

name - field name for parameter

Method Detail

getAbbreviation

public java.lang.String getAbbreviation()

Get text abbreviation for parameter. This override of the base class method returns "-cNN", where 'c' is the flag character for the parameter.

Overrides:

getAbbreviation in class ParameterDef

Returns:

text abbreviation for showing parameter

handle

public void handle(ArgumentProcessor proc)

Handle argument. This implementation of the abstract base class method interprets the characters following the flag character as an optionally signed decimal value. If the value is within the allowed range the parameter is set to that value. Other flag characters may follow the numeric value within the argument.

Specified by:

handle in class ParameterDef

Parameters:

proc - argument processor making call to handler

Throws:

ArgumentErrorException - if decimal value missing or out of range

java.lang.IllegalArgumentException - on error in processing