edu.sc.seis.seisFile.client
Class AbstractClient

java.lang.Object
  extended by edu.sc.seis.seisFile.client.AbstractClient
Direct Known Subclasses:
AbstractFDSNClient, WinstonRTPlayback

public class AbstractClient
extends java.lang.Object


Field Summary
protected  java.lang.String[] args
           
protected  java.lang.String commandName
           
static java.lang.String DEFAULT_USER_AGENT
           
static java.lang.String HELP
           
protected  com.martiansoftware.jsap.JSAP jsap
           
protected  java.util.List<com.martiansoftware.jsap.Parameter> params
           
protected  com.martiansoftware.jsap.JSAPResult result
           
protected  java.lang.String userAgent
           
static java.lang.String VERSION
           
 
Constructor Summary
AbstractClient(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()
           
 java.lang.String getCommandName()
           
 java.lang.String getHelp()
           
 java.util.List<com.martiansoftware.jsap.Parameter> getParams()
           
 com.martiansoftware.jsap.JSAPResult getResult()
           
 java.lang.String getUserAgent()
           
protected  boolean isSpecified(com.martiansoftware.jsap.Parameter p)
           
 boolean isSuccess()
           
protected  boolean requiresAtLeastOneArg()
           
 void setUserAgent(java.lang.String userAgent)
           
 boolean shouldPrintHelp()
           
 boolean shouldPrintVersion()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HELP

public static final java.lang.String HELP
See Also:
Constant Field Values

VERSION

public static final java.lang.String VERSION
See Also:
Constant Field Values

params

protected java.util.List<com.martiansoftware.jsap.Parameter> params

result

protected com.martiansoftware.jsap.JSAPResult result

jsap

protected com.martiansoftware.jsap.JSAP jsap

args

protected java.lang.String[] args

commandName

protected java.lang.String commandName

userAgent

protected java.lang.String userAgent

DEFAULT_USER_AGENT

public static final java.lang.String DEFAULT_USER_AGENT
Constructor Detail

AbstractClient

public AbstractClient(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

isSpecified

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

getArgs

public java.lang.String[] getArgs()

shouldPrintHelp

public boolean shouldPrintHelp()

shouldPrintVersion

public boolean shouldPrintVersion()

getHelp

public java.lang.String getHelp()

isSuccess

public boolean isSuccess()

getParams

public java.util.List<com.martiansoftware.jsap.Parameter> getParams()

getResult

public com.martiansoftware.jsap.JSAPResult getResult()

getCommandName

public java.lang.String getCommandName()

setUserAgent

public void setUserAgent(java.lang.String userAgent)

getUserAgent

public java.lang.String getUserAgent()