com.portal.common

Class Options.IntOptionDef

java.lang.Object

com.portal.common.Options.OptionDef

com.portal.common.Options.IntOptionDef

Enclosing class:

Options

protected class Options.IntOptionDef
extends Options.OptionDef

Definition of a integer option. This is an option that will be followed by a single integer value on the command line.

Field Summary

Fields inherited from class com.portal.common.Options.OptionDef

mDefaultValues, mNumValuesNeeded

Constructor Summary

Constructors

Constructor and Description
IntOptionDef(String name, int defValue, String desc) Construct an integer option.
IntOptionDef(String name, String desc) Construct an integer option.

Method Summary

Modifier and Type	Method and Description
void	validateOption(ArrayList values) Ensure that this option has a single value that is a valid integer.

Methods inherited from class com.portal.common.Options.OptionDef

getBigDecimal, getBoolean, getDate, getDefaultValues, getDesc, getInteger, getIthDefaultAsString, getName, getNumValuesNeeded, getString, getStrings, isRequiredOption, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

IntOptionDef

public IntOptionDef(String name,
                    int defValue,
                    String desc)

Construct an integer option. This is an option that will be followed by a single integer value on the command line. If the option does not appear on the command line then use the specified default value.

Parameters:

name - The name of the option. The name should include the leading "-" (i.e. -threads).

defValue - The default value to use if the option does not appear on the command line.

desc - The description of the option.

IntOptionDef

public IntOptionDef(String name,
                    String desc)

Construct an integer option. This is an option that will be followed by a single integer value on the command line. This is a required option and the parse method will throw an exception if the option does not appear on the command line.

Parameters:

name - The name of the option. The name should include the leading "-" (i.e. -threads).

desc - The description of the option.

Method Detail

validateOption

public void validateOption(ArrayList values)
                    throws CommandLineParser.OptionDataException

Ensure that this option has a single value that is a valid integer.

Overrides:

validateOption in class Options.OptionDef

Parameters:

values - An array that contains the values that were specified on the command line for the option. If no values were specified then the array will be empty.

Throws:

OptionDataException - There was not only one value that is a valid integer.

CommandLineParser.OptionDataException