hep.lcio.util

Class CommandHandler

java.lang.Object

hep.lcio.util.CommandHandler

Direct Known Subclasses:

CompareCommandHandler, ConcatenateCommandHandler, HeaderCountCommandHandler, MergeCommandHandler, PrintCommandHandler, RandomEventCommandHandler, RunCommandHandler, SelectCommandHandler, SIODumpCommandHandler, SizeCommandHandler, SplitCommandHandler, StdhepConvertCommandHandler, ValidateCommandHandler

public abstract class CommandHandler
extends Object

A CommandHandler handles the command-line options for a single command in the CommandLineTool.

Constructor Summary

Constructors

Constructor and Description
CommandHandler(String name) Ctor with default description.
CommandHandler(String name, String description) CommandHandler ctor.

Method Summary

Modifier and Type	Method and Description
abstract void	execute() Execute the command from parsed args.
String	getDescription() Get the description of this command.
String	getName() Get the name of this command.
org.apache.commons.cli.Options	getOptions() Options for this command.
abstract void	parse(String[] argv) Parse this command's options from the command line.
void	printUsage(boolean doExit) Print usage and (optionally) exit the program.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandHandler

public CommandHandler(String name,
                      String description)

CommandHandler ctor.

Parameters:

name - The string that invokes this command.

description - The description of this command.

CommandHandler

public CommandHandler(String name)

Ctor with default description.

Parameters:

name - The string that invokes this command.

Method Detail

getName

public String getName()

Get the name of this command.

Returns:

A String of the name of this command.

getDescription

public String getDescription()

Get the description of this command.

Returns:

A String of the description of this command.

getOptions

public org.apache.commons.cli.Options getOptions()

Options for this command.

Returns:

Options object for this command.

printUsage

public void printUsage(boolean doExit)

Print usage and (optionally) exit the program.

Parameters:

doExit - Whether or not to exit after printing usage.

parse

public abstract void parse(String[] argv)
                    throws Exception

Parse this command's options from the command line.

Parameters:

argv - Raw options array following after the command string.

Throws:

Exception

execute

public abstract void execute()
                      throws Exception

Execute the command from parsed args.

Parameters:

Execute - the command with arguments built parse.

Throws:

Exception