com.vladium.emma
Class Command

java.lang.Object
  extended by com.vladium.emma.Command
Direct Known Subclasses:
instrCommand, mergeCommand, reportCommand, runCommand

public abstract class Command
extends java.lang.Object

Author:
Vlad Roubtsov, (C) 2003

Field Summary
protected static java.lang.String COMMA_DELIMITERS
           
protected  java.lang.String[] m_args
           
protected  boolean m_exit
           
protected  java.io.PrintWriter m_out
           
protected  java.io.File m_propertyFile
           
protected  java.util.Properties m_propertyOverrides
           
protected  java.lang.String m_usageToolName
           
protected static java.lang.String PATH_DELIMITERS
           
protected static int RC_OK
           
protected static int RC_UNEXPECTED
           
protected static int RC_USAGE
           
protected static int STDOUT_WIDTH
           
protected static java.lang.String[] USAGE_OPT_NAMES
           
 
Constructor Summary
protected Command(java.lang.String usageToolName, java.lang.String[] args)
           
 
Method Summary
static Command create(java.lang.String name, java.lang.String usageName, java.lang.String[] args)
           
protected  void exit(boolean showBuildID, java.lang.String msg, java.lang.Throwable t, int rc)
           
protected static java.lang.String[] getListOptValue(IOptsParser.IOpt opt, java.lang.String delimiters, boolean processAtFiles)
           
protected static boolean getOptionalBooleanOptValue(IOptsParser.IOpt opt)
           
protected  IOptsParser getOptParser(java.lang.ClassLoader loader)
           
protected  java.lang.String getToolName()
           
protected  void initialize()
           
protected  void processCmdPropertyOverrides(IOptsParser.IOpts parsedopts)
           
protected  boolean processFilePropertyOverrides()
           
protected  boolean processOpt(IOptsParser.IOpt opt)
           
abstract  void run()
           
private  void setPropertyOverride(java.lang.String key, java.lang.String value)
           
protected static java.lang.String toolNameToCommandName(java.lang.String toolName)
           
protected abstract  java.lang.String usageArgsMsg()
           
protected  void usageexit(IOptsParser parser, int level, java.lang.String msg)
           
protected static java.lang.String usageMsgPrefix(java.lang.String toolName)
           
protected static java.lang.String usageResName(java.lang.String toolName)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_usageToolName

protected final java.lang.String m_usageToolName

m_args

protected final java.lang.String[] m_args

m_propertyFile

protected java.io.File m_propertyFile

m_propertyOverrides

protected java.util.Properties m_propertyOverrides

m_exit

protected boolean m_exit

m_out

protected java.io.PrintWriter m_out

COMMA_DELIMITERS

protected static final java.lang.String COMMA_DELIMITERS
See Also:
Constant Field Values

PATH_DELIMITERS

protected static final java.lang.String PATH_DELIMITERS

USAGE_OPT_NAMES

protected static final java.lang.String[] USAGE_OPT_NAMES

STDOUT_WIDTH

protected static final int STDOUT_WIDTH
See Also:
Constant Field Values

RC_OK

protected static final int RC_OK
See Also:
Constant Field Values

RC_USAGE

protected static final int RC_USAGE
See Also:
Constant Field Values

RC_UNEXPECTED

protected static final int RC_UNEXPECTED
See Also:
Constant Field Values
Constructor Detail

Command

protected Command(java.lang.String usageToolName,
                  java.lang.String[] args)
Method Detail

create

public static Command create(java.lang.String name,
                             java.lang.String usageName,
                             java.lang.String[] args)

run

public abstract void run()

usageArgsMsg

protected abstract java.lang.String usageArgsMsg()

initialize

protected void initialize()

getToolName

protected final java.lang.String getToolName()

getOptParser

protected final IOptsParser getOptParser(java.lang.ClassLoader loader)

processOpt

protected final boolean processOpt(IOptsParser.IOpt opt)

processCmdPropertyOverrides

protected final void processCmdPropertyOverrides(IOptsParser.IOpts parsedopts)

processFilePropertyOverrides

protected final boolean processFilePropertyOverrides()

usageexit

protected final void usageexit(IOptsParser parser,
                               int level,
                               java.lang.String msg)

exit

protected final void exit(boolean showBuildID,
                          java.lang.String msg,
                          java.lang.Throwable t,
                          int rc)
                   throws EMMARuntimeException
Throws:
EMMARuntimeException

getOptionalBooleanOptValue

protected static boolean getOptionalBooleanOptValue(IOptsParser.IOpt opt)

getListOptValue

protected static java.lang.String[] getListOptValue(IOptsParser.IOpt opt,
                                                    java.lang.String delimiters,
                                                    boolean processAtFiles)
                                             throws java.io.IOException
Throws:
java.io.IOException

usageMsgPrefix

protected static java.lang.String usageMsgPrefix(java.lang.String toolName)

usageResName

protected static java.lang.String usageResName(java.lang.String toolName)

toolNameToCommandName

protected static java.lang.String toolNameToCommandName(java.lang.String toolName)

setPropertyOverride

private void setPropertyOverride(java.lang.String key,
                                 java.lang.String value)