Package org.rwtodd.args

Class StringParam

java.lang.Object

org.rwtodd.args.BasicOneArgParam<String>

org.rwtodd.args.StringParam

All Implemented Interfaces:

OneArgParam, Param

public class StringParam
extends BasicOneArgParam<String>

Field Summary

Fields inherited from class org.rwtodd.args.BasicOneArgParam

arg, helpText, paramNames

Constructor Summary

Constructors

Constructor	Description
StringParam(Collection<String> names, String help)
StringParam(Collection<String> names, String dflt, String help)

Method Summary

Modifier and Type	Method	Description
protected String	convertArg(String param, String argument)	A conversion method to get a T from a string.

Methods inherited from class org.rwtodd.args.BasicOneArgParam

addHelp, addToMap, getValue, process, validate

Methods inherited from class java.lang.Object

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

Constructor Details

StringParam

public StringParam(Collection<String> names,
 String dflt,
 String help)

StringParam

public StringParam(Collection<String> names,
 String help)

Method Details

convertArg

protected String convertArg(String param,
 String argument)
                     throws Exception

Description copied from class: BasicOneArgParam

A conversion method to get a T from a string. All subclasses must define this for the type they handle.

Specified by:

convertArg in class BasicOneArgParam<String>

Parameters:

param - the name of the parameter found on the command line. In some cases it might affect conversion, but it is also good for error messages.

argument - the argument to convert to a type T.

Returns:

the converted argument.

Throws:

Exception - if there is a problem with the conversion.