net.sf.kdgcommons.util

Interface CommandLineProcessor.OptionHandler

Enclosing class:

CommandLineProcessor

protected static interface CommandLineProcessor.OptionHandler

Subclass-defined argument handlers must implement this interface.

Method Summary

Modifier and Type	Method and Description
String	getArgumentDescription() Returns text describing the option's arguments, for inclusion in the usage output.
String	getOptionDescription() Returns a description of this option, for inclusion in the usage output.
String	getOptionName() Returns the name of the option.
void	process(ListIterator<String> args) Processes the option.

Method Detail

getOptionName

String getOptionName()

Returns the name of the option. Since this is used to match the command-line argument, it must include any leading dashes. For example: "--input".

getOptionDescription

String getOptionDescription()

Returns a description of this option, for inclusion in the usage output. Example: "the file to be processed".

getArgumentDescription

String getArgumentDescription()

Returns text describing the option's arguments, for inclusion in the usage output. For example, "FILENAME [FORMAT]".

process

void process(ListIterator<String> args)

Processes the option. This is called after matching a command- line argument to this handler, and the passed iterator points points at the next argument on the command line.