org.globus.cog.util
Class ArgumentParser

java.lang.Object
  extended byorg.globus.cog.util.ArgumentParser

public class ArgumentParser
extends Object


Field Summary
static String DEFAULT
           
static int FLAG
           
static int NORMAL
           
static int OPTIONAL
           
 
Constructor Summary
ArgumentParser()
           
 
Method Summary
 void addAlias(String name, String alias)
           
 void addFlag(String name)
           
 void addFlag(String name, String detail)
           
 void addFlag(String name, String detail, String argName)
           
 void addOption(String name, int type)
           
 void addOption(String name, String detail, int type)
           
 void addOption(String name, String detail, String argName, int type)
           
 void checkMandatory()
           
protected  String getArgumentName(String name)
           
 int getIntValue(String name)
           
 int getIntValue(String name, int defaultValue)
           
 String getStringValue(String name)
           
 String getStringValue(String name, String defaultValue)
           
protected  boolean hasAliases(String name)
           
protected  boolean hasOption(String name, int option)
           
 boolean hasValue(String name)
           
protected  boolean isFlag(String name)
           
protected  boolean isOptional(String name)
           
 boolean isPresent(String name)
           
 void parse(String[] args)
           
 void setArgumentName(String name, String arg)
           
 void setDetail(String name, String detail)
           
 void setExecutableName(String executableName)
           
 void usage()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NORMAL

public static final int NORMAL
See Also:
Constant Field Values

FLAG

public static final int FLAG
See Also:
Constant Field Values

OPTIONAL

public static final int OPTIONAL
See Also:
Constant Field Values

DEFAULT

public static final String DEFAULT
Constructor Detail

ArgumentParser

public ArgumentParser()
Method Detail

setExecutableName

public void setExecutableName(String executableName)

addFlag

public void addFlag(String name,
                    String detail,
                    String argName)

addFlag

public void addFlag(String name,
                    String detail)

addFlag

public void addFlag(String name)

addOption

public void addOption(String name,
                      String detail,
                      String argName,
                      int type)

addOption

public void addOption(String name,
                      String detail,
                      int type)

addOption

public void addOption(String name,
                      int type)

setDetail

public void setDetail(String name,
                      String detail)

setArgumentName

public void setArgumentName(String name,
                            String arg)

addAlias

public void addAlias(String name,
                     String alias)

getStringValue

public String getStringValue(String name)

getStringValue

public String getStringValue(String name,
                             String defaultValue)

getIntValue

public int getIntValue(String name)
                throws NumberFormatException
Throws:
NumberFormatException

getIntValue

public int getIntValue(String name,
                       int defaultValue)
                throws NumberFormatException
Throws:
NumberFormatException

isPresent

public boolean isPresent(String name)

hasValue

public boolean hasValue(String name)

hasOption

protected boolean hasOption(String name,
                            int option)

isOptional

protected boolean isOptional(String name)

isFlag

protected boolean isFlag(String name)

getArgumentName

protected String getArgumentName(String name)

parse

public void parse(String[] args)
           throws ArgumentParserException
Throws:
ArgumentParserException

checkMandatory

public void checkMandatory()
                    throws ArgumentParserException
Throws:
ArgumentParserException

hasAliases

protected boolean hasAliases(String name)

usage

public void usage()