net.sf.kdgcommons.util

Class CommandLineProcessor

java.lang.Object

net.sf.kdgcommons.util.CommandLineProcessor

Deprecated.

SimpleCLIParser is my current preferred implementation. It's a lot simpler: there's no need for handler objects, and the options are processed by the constructor. However, I still have code that depends on this class, so it will stick around until the (never expected) 2.0 release.

@Deprecated
public abstract class CommandLineProcessor
extends Object

A base class for handling invocation arguments, including automated generation of a "usage" message. Subclasses define handlers for each of the options they process, and add those handlers to a handler map. Handlers are responsible for consuming arguments and storing them as appropriate.

The program's main() will instantiate the subclass and then call process(java.lang.String[]).

At the present time, this class does not support combined arguments. However, since they will be passed to the subclass' default method, it can handle them if needed.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	CommandLineProcessor.OptionHandler Deprecated. Subclass-defined argument handlers must implement this interface.

Constructor Summary

Constructors

Constructor and Description
CommandLineProcessor() Deprecated.

Method Summary

Modifier and Type	Method and Description
protected void	addHandler(CommandLineProcessor.OptionHandler handler) Deprecated. Adds an option handler to the list.
protected void	handleUnprocessedArguments(List<String> args) Deprecated. This method is called after all options have been handled.
void	process(String[] argv) Deprecated. Processes the command-line options.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLineProcessor

public CommandLineProcessor()

Deprecated.

Method Detail

process

public void process(String[] argv)

Deprecated.

Processes the command-line options. This will iterator through the passed option array, and call handlers for each recognized option. After all recognized options have been processed, it will call the method handleUnprocessedArguments(java.util.List<java.lang.String>).

addHandler

protected void addHandler(CommandLineProcessor.OptionHandler handler)

Deprecated.

Adds an option handler to the list. This is typically called by the subclass constructor.

handleUnprocessedArguments

protected void handleUnprocessedArguments(List<String> args)

Deprecated.

This method is called after all options have been handled. It allows the subclass to process arguments that are not specified as belonging to a particular option.

Note: the "unprocessed" arguments may appear anywhere in the command line. It is essentially the full list of arguments, minus any that represent options or their consumed arguments.

Default behavior is to ignore unprocessed arguments. This exists primarily to simplify test classes, although I suppose some weird program might not have any command-line arguments that aren't tied to an option.