Package org.rwtodd.args

Class CharParam

java.lang.Object

org.rwtodd.args.BasicOneArgParam<Character>

org.rwtodd.args.CharParam

All Implemented Interfaces:

OneArgParam<Character>, Param

public class CharParam
extends BasicOneArgParam<Character>

CharParam is a Param that accepts single-character arguments. It defaults to ' ' if another default is not selected.

Field Summary

Fields inherited from class org.rwtodd.args.BasicOneArgParam

arg, helpText, paramNames

Constructor Summary

Constructors

Constructor	Description
CharParam(Iterable<String> names, Character dflt, String help)
CharParam(Iterable<String> names, String help)

Method Summary

Modifier and Type	Method	Description
protected Character	convertArg(String param, String arg)	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

CharParam

public CharParam(Iterable<String> names,
 Character dflt,
 String help)

CharParam

public CharParam(Iterable<String> names,
 String help)

Method Details

convertArg

protected Character convertArg(String param,
 String arg)
                        throws ArgParserException

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<Character>

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.

arg - the argument to convert to a type T.

Returns:

the converted argument.

Throws:

ArgParserException