ariba.util.core
Interface CommandLine

All Known Subinterfaces:

ContextCommandLine

All Known Implementing Classes:

QuickTableDiff

public interface CommandLine

This interface provides a general mechanism for its clients to set up the command line arguments that it is expecteing, to process the arguments, and finally to run with the input arguments. Normally, a class implementing this interface implements its main method which calls the create method of the ArgumentParser class, passing in its class name and its command line arguments. Then the setupArguments method is called to allow the client to register the command line arguments. Then the processArguments method is called to allow the client to process its arguments. Finally, the startup method is invoked to allow the client to be executed.

See Also:

ArgumentParser

Method Summary

void	processArguments(ArgumentParser arguments) processes the arguments previously registered during setupArguments.
void	setupArguments(ArgumentParser arguments) registers the arguments this class expects.
void	startup() Called to allow client to begin running

Method Detail

setupArguments

void setupArguments(ArgumentParser arguments)

registers the arguments this class expects. This can include the name of the command line option, the type of input arguments, and whether the option is optional or not.

Parameters:

arguments - the ArgumentParser object that stores the registered information. The implementation of this method can expect this ArgumnentParser object to be non null.

See Also:

ArgumentParser

processArguments

void processArguments(ArgumentParser arguments)

processes the arguments previously registered during setupArguments.

Parameters:

arguments - the ArgumentParser object that provides the registered information to be processed.

See Also:

ArgumentParser

startup

void startup()

Called to allow client to begin running