Package org.rwtodd.args

Class ExistingFileParam

java.lang.Object

org.rwtodd.args.BasicOneArgParam<Path>

org.rwtodd.args.ExistingFileParam

All Implemented Interfaces:

OneArgParam, Param

public class ExistingFileParam
extends BasicOneArgParam<Path>

A param that takes expects an existing file on the filesystem.

Field Summary

Fields inherited from class org.rwtodd.args.BasicOneArgParam

arg, helpText, paramNames

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected Path	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

ExistingFileParam

public ExistingFileParam(Collection<String> names,
 Path dflt,
 String help)

ExistingFileParam

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

Method Details

convertArg

protected Path convertArg(String param,
 String argument)
                   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<Path>

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:

ArgParserException