Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javatools >> [ util overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

javatools.util
Class ArgumentProcessor  

java.lang.Object
  javatools.util.ArgumentProcessor

---

public class ArgumentProcessor

extends java.lang.Object

It's a class useful to process arguments passed via command line.

Version:

0.0.1

---

Field Summary
private  java.lang.String[]	argumentHelpText
private  java.lang.String[]	argumentNames
private  java.lang.String[]	argumentValues
private  java.lang.String[]	flagHelpText
private  java.lang.String[]	flagNames
private  boolean[]	flagValues

 

Constructor Summary

ArgumentProcessor()           Creates new ArgumentProcessor

 

Method Summary
void	cleanValues()           Turns all flags to FALSE and all values to empty strings
java.lang.String	getArgumentHelpText(int argPos, java.lang.String paramName)           Returns the help text whose position is specified.
java.lang.String	getArgumentHelpText(java.lang.String argName, java.lang.String paramName)           Returns the help text of an argument whose name is specified.
java.lang.String	getArgumentName(int argPos)           Returns the name of an argument.
int	getArgumentPos(java.lang.String argName)           Returns the position of an argument.
java.lang.String	getArgumentValue(int argPos)           Returns the value of an argument whose position is specified.
java.lang.String	getArgumentValue(java.lang.String argName)           Return the value of an argument whose name is specified.
java.lang.String	getFlagHelpText(int numFlag)           Returns help text of a flag whose position is specified.
java.lang.String	getFlagHelpText(java.lang.String flagName)           Returns help text of a flag whose name is specified.
java.lang.String	getFlagName(int numFlag)           Returns the name of the flag.
int	getFlagPos(java.lang.String flagName)           Returns the position of the flag.
boolean	getFlagValue(int flagPos)           The value of a flag whose position is specified.
boolean	getFlagValue(java.lang.String flagName)           Returns the value of a flag whose name is specified.
int	getNumArguments()           Returns the number of arguments.
int	getNumFlags()           Returns the number of flags.
void	processArguments(java.lang.String[] args)           Process the command line parameters.
private  java.lang.String	replaceParams(java.lang.String text, java.lang.String param)
void	setArgumentHelpText(int argPos, java.lang.String helpText)           Sets help text for an argument whose position is specified.
void	setArgumentHelpText(java.lang.String argName, java.lang.String helpText)           Sets help text for an argument whose name is specified.
void	setArgumentName(int argPos, java.lang.String argName)           Sets the name of an argument.
void	setArgumentValue(int argPos, java.lang.String argValue)           Sets the value of an argument whose position is specified.
void	setArgumentValue(java.lang.String argName, java.lang.String argValue)           Sets the value of an argument, whose name is specified.
void	setFlagHelpText(int numFlag, java.lang.String helpText)           Sets help text for a flag whose position is specified.
void	setFlagHelpText(java.lang.String flagName, java.lang.String helpText)           Sets help text for a flag whose name is specified.
void	setFlagName(int numFlag, java.lang.String flagName)           Sets the name of a flag.
void	setFlagValue(int flagPos, boolean flagValue)           Sets the value of a flag whose position is specified.
void	setFlagValue(java.lang.String flagName, boolean flagValue)           Sets the value of a flag whose name is specified.
void	setNumArguments(int numArgs)           Sets the number of arguments (parameters with different values, used with to strings in command lines).
void	setNumFlags(int numArgs)           Sets the number of flags (parameters with with TRUE-FALSE values, used alone in command lines).

 

Methods inherited from class java.lang.Object

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

 

Field Detail

flagNames

private java.lang.String[] flagNames

---

flagValues

private boolean[] flagValues

---

argumentValues

private java.lang.String[] argumentValues

---

argumentNames

private java.lang.String[] argumentNames

---

flagHelpText

private java.lang.String[] flagHelpText

---

argumentHelpText

private java.lang.String[] argumentHelpText

Constructor Detail

ArgumentProcessor

public ArgumentProcessor()

Creates new ArgumentProcessor

Method Detail

setNumFlags

public void setNumFlags(int numArgs)
                 throws java.lang.IndexOutOfBoundsException

Sets the number of flags (parameters with with TRUE-FALSE values, used alone in command lines).

---

getNumFlags

public int getNumFlags()

Returns the number of flags.

---

setNumArguments

public void setNumArguments(int numArgs)
                     throws java.lang.IndexOutOfBoundsException

Sets the number of arguments (parameters with different values, used with to strings in command lines).

---

getNumArguments

public int getNumArguments()

Returns the number of arguments.

---

setFlagName

public void setFlagName(int numFlag,
                        java.lang.String flagName)
                 throws java.lang.IndexOutOfBoundsException

Sets the name of a flag.

---

getFlagName

public java.lang.String getFlagName(int numFlag)
                             throws java.lang.IndexOutOfBoundsException

Returns the name of the flag.

---

getFlagPos

public int getFlagPos(java.lang.String flagName)

Returns the position of the flag.

---

setFlagValue

public void setFlagValue(java.lang.String flagName,
                         boolean flagValue)

Sets the value of a flag whose name is specified.

---

setFlagValue

public void setFlagValue(int flagPos,
                         boolean flagValue)
                  throws java.lang.IndexOutOfBoundsException

Sets the value of a flag whose position is specified.

---

getFlagValue

public boolean getFlagValue(java.lang.String flagName)

Returns the value of a flag whose name is specified.

---

getFlagValue

public boolean getFlagValue(int flagPos)
                     throws java.lang.IndexOutOfBoundsException

The value of a flag whose position is specified.

---

setArgumentName

public void setArgumentName(int argPos,
                            java.lang.String argName)
                     throws java.lang.IndexOutOfBoundsException

Sets the name of an argument.

---

getArgumentName

public java.lang.String getArgumentName(int argPos)
                                 throws java.lang.IndexOutOfBoundsException

Returns the name of an argument.

---

getArgumentPos

public int getArgumentPos(java.lang.String argName)

Returns the position of an argument.

---

setArgumentValue

public void setArgumentValue(java.lang.String argName,
                             java.lang.String argValue)

Sets the value of an argument, whose name is specified.

---

setArgumentValue

public void setArgumentValue(int argPos,
                             java.lang.String argValue)
                      throws java.lang.IndexOutOfBoundsException

Sets the value of an argument whose position is specified.

---

getArgumentValue

public java.lang.String getArgumentValue(java.lang.String argName)

Return the value of an argument whose name is specified.

---

getArgumentValue

public java.lang.String getArgumentValue(int argPos)
                                  throws java.lang.IndexOutOfBoundsException

Returns the value of an argument whose position is specified.

---

cleanValues

public void cleanValues()

Turns all flags to FALSE and all values to empty strings

---

processArguments

public void processArguments(java.lang.String[] args)

Process the command line parameters.

---

setFlagHelpText

public void setFlagHelpText(java.lang.String flagName,
                            java.lang.String helpText)

Sets help text for a flag whose name is specified.

---

setFlagHelpText

public void setFlagHelpText(int numFlag,
                            java.lang.String helpText)

Sets help text for a flag whose position is specified.

---

getFlagHelpText

public java.lang.String getFlagHelpText(java.lang.String flagName)

Returns help text of a flag whose name is specified.

---

getFlagHelpText

public java.lang.String getFlagHelpText(int numFlag)

Returns help text of a flag whose position is specified.

---

setArgumentHelpText

public void setArgumentHelpText(java.lang.String argName,
                                java.lang.String helpText)

Sets help text for an argument whose name is specified.

---

setArgumentHelpText

public void setArgumentHelpText(int argPos,
                                java.lang.String helpText)

Sets help text for an argument whose position is specified.

---

getArgumentHelpText

public java.lang.String getArgumentHelpText(java.lang.String argName,
                                            java.lang.String paramName)

Returns the help text of an argument whose name is specified.

---

getArgumentHelpText

public java.lang.String getArgumentHelpText(int argPos,
                                            java.lang.String paramName)

Returns the help text whose position is specified.

---

replaceParams

private java.lang.String replaceParams(java.lang.String text,
                                       java.lang.String param)

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javatools >> [ util overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---