hep.lcio.util

Class CommandLineTool

java.lang.Object

hep.lcio.util.CommandLineTool

public class CommandLineTool
extends Object

CommandLineTool provides a command-line interface to LCIO utilities, similar to how the cvs command works. lcio [global_options] [command] [command_options]

See Also:

concat -concatenate LCIO files together, merge -overlay events, split -split LCIO file into multiple output files, siodump -dump low-level SIOinfo, compare -compare series of LCIO files, count -print header info -number of LCRunHeader -number of LCEventHeader -number of LCEvent, random -generate X random events, validate -Is an LCIO file? -version check, stdhep -convert from stdhep file to lcio MCParticles, print -dump lcio file (similar to C++ dump cmd), -run a class within the LCIO distribution

Method Summary

Modifier and Type	Method and Description
void	addCommandHandler(CommandHandler handler) Add a @see CommandHandler to the CommandLineTool.
String	getCommand() Get the name of the currently active command.
CommandHandler	getCommandHandler(String command) Get a CommandHandler for the command.
org.apache.commons.cli.CommandLine	getGlobalOptions() Get the global options.
static CommandLineTool	instance() Get an instance of CommandLineTool.
static void	main(String[] argv) The default main method for the CommandLineTool.
void	parse(String[] argv) Parse the argv for global options.
void	printUsage(boolean doExit) Print the lcio command usage.

Methods inherited from class java.lang.Object

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

Method Detail

instance

public static CommandLineTool instance()

Get an instance of CommandLineTool.

Returns:

A global unique instance of CommandLineTool.

getGlobalOptions

public org.apache.commons.cli.CommandLine getGlobalOptions()

Get the global options.

Returns:

A CommandLine object representing the global options, e.g. the options in front of the command.

main

public static void main(String[] argv)
                 throws Exception

The default main method for the CommandLineTool.

Parameters:

argv - The raw input arguments from the CL.

Throws:

Exception

getCommand

public String getCommand()

Get the name of the currently active command.

Returns:

String of the currently active command.

parse

public void parse(String[] argv)
           throws Exception

Parse the argv for global options. Lookup the appropriate CommandHandler. Pass command options to @see CommandHandler.parse method. Execute the CommandHandler's execute method.

Parameters:

argv - The raw input arguments from CL.

Throws:

Exception

addCommandHandler

public void addCommandHandler(CommandHandler handler)

Add a @see CommandHandler to the CommandLineTool. The @see CommandHandler.getName method is the command that will be handled by this @see CommandHandler.

Parameters:

handler - The CommandHandler.

getCommandHandler

public CommandHandler getCommandHandler(String command)
                                 throws Exception

Get a CommandHandler for the command.

Parameters:

command - A String of the command to lookup.

Returns:

A CommandHandler for this command.

Throws:

Exception

printUsage

public void printUsage(boolean doExit)

Print the lcio command usage.

Parameters:

doExit - Boolean that specifies whether to exit or not.