edu.sc.seis.sod.tools
Class CommandLineTool

java.lang.Object
  extended by edu.sc.seis.sod.tools.CommandLineTool
Direct Known Subclasses:
find_events, find_seismograms, find_stations

public class CommandLineTool
extends java.lang.Object


Field Summary
protected  boolean requiresStdin
           
protected  com.martiansoftware.jsap.JSAPResult result
           
 
Constructor Summary
CommandLineTool(java.lang.String[] args)
           
 
Method Summary
protected  void add(com.martiansoftware.jsap.Parameter param)
           
protected  void addParams()
           
protected  com.martiansoftware.jsap.FlaggedOption createListOption(java.lang.String id, char shortFlag, java.lang.String longFlag, java.lang.String help)
           
protected  com.martiansoftware.jsap.FlaggedOption createListOption(java.lang.String id, char shortFlag, java.lang.String longFlag, java.lang.String help, java.lang.String defaultArg)
           
protected  com.martiansoftware.jsap.FlaggedOption createListOption(java.lang.String id, char shortFlag, java.lang.String longFlag, java.lang.String help, java.lang.String defaultArg, com.martiansoftware.jsap.StringParser parser)
           
 java.lang.String[] getArgs()
           
 org.apache.velocity.VelocityContext getContext()
           
 java.io.InputStream getTemplate()
           
protected  boolean isSpecified(com.martiansoftware.jsap.Parameter p)
           
 boolean isSuccess()
           
protected  boolean requiresAtLeastOneArg()
           
static void run(CommandLineTool ls)
           
 boolean shouldPrintHelp()
           
 boolean shouldPrintRecipe()
           
 boolean shouldPrintVersion()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

requiresStdin

protected boolean requiresStdin

result

protected com.martiansoftware.jsap.JSAPResult result
Constructor Detail

CommandLineTool

public CommandLineTool(java.lang.String[] args)
                throws com.martiansoftware.jsap.JSAPException
Throws:
com.martiansoftware.jsap.JSAPException
Method Detail

requiresAtLeastOneArg

protected boolean requiresAtLeastOneArg()

createListOption

protected com.martiansoftware.jsap.FlaggedOption createListOption(java.lang.String id,
                                                                  char shortFlag,
                                                                  java.lang.String longFlag,
                                                                  java.lang.String help)

createListOption

protected com.martiansoftware.jsap.FlaggedOption createListOption(java.lang.String id,
                                                                  char shortFlag,
                                                                  java.lang.String longFlag,
                                                                  java.lang.String help,
                                                                  java.lang.String defaultArg)

createListOption

protected com.martiansoftware.jsap.FlaggedOption createListOption(java.lang.String id,
                                                                  char shortFlag,
                                                                  java.lang.String longFlag,
                                                                  java.lang.String help,
                                                                  java.lang.String defaultArg,
                                                                  com.martiansoftware.jsap.StringParser parser)

addParams

protected void addParams()
                  throws com.martiansoftware.jsap.JSAPException
Throws:
com.martiansoftware.jsap.JSAPException

add

protected void add(com.martiansoftware.jsap.Parameter param)
            throws com.martiansoftware.jsap.JSAPException
Throws:
com.martiansoftware.jsap.JSAPException

getContext

public org.apache.velocity.VelocityContext getContext()

isSpecified

protected boolean isSpecified(com.martiansoftware.jsap.Parameter p)

getArgs

public java.lang.String[] getArgs()

shouldPrintHelp

public boolean shouldPrintHelp()

shouldPrintRecipe

public boolean shouldPrintRecipe()

shouldPrintVersion

public boolean shouldPrintVersion()

isSuccess

public boolean isSuccess()

getTemplate

public java.io.InputStream getTemplate()
                                throws java.io.IOException
Throws:
java.io.IOException

run

public static void run(CommandLineTool ls)
                throws java.lang.Exception
Throws:
java.lang.Exception