Package org.rwtodd.args

Class ClampedIntParam

java.lang.Object

org.rwtodd.args.BasicOneArgParam<Integer>

org.rwtodd.args.IntParam

org.rwtodd.args.ClampedIntParam

All Implemented Interfaces:

OneArgParam, Param

public class ClampedIntParam
extends IntParam

Field Summary

Fields inherited from class org.rwtodd.args.BasicOneArgParam

arg, helpText, paramNames

Constructor Summary

Constructors

Constructor	Description
ClampedIntParam(Collection<String> names, Integer dflt, int min, int max, String help)

Method Summary

Modifier and Type	Method	Description
protected Integer	validate(String param, Integer arg)	A validation method which subclasses can override to restrict the valid values of the argument.

Methods inherited from class org.rwtodd.args.IntParam

convertArg

Methods inherited from class org.rwtodd.args.BasicOneArgParam

addHelp, addToMap, getValue, process

Methods inherited from class java.lang.Object

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

Constructor Details

ClampedIntParam

public ClampedIntParam(Collection<String> names,
 Integer dflt,
 int min,
 int max,
 String help)

Method Details

validate

protected Integer validate(String param,
 Integer arg)
                    throws Exception

Description copied from class: BasicOneArgParam

A validation method which subclasses can override to restrict the valid values of the argument.

Overrides:

validate in class BasicOneArgParam<Integer>

Parameters:

param - the name of the given parameter.

arg - the argument to the parameter, as coverted by BasicOneArgParam.convertArg(String, String).

Returns:

the validated arg, which doesn't have to mach the provided arg.

Throws:

Exception - if the provided arg was invalid.