CmdLine (CodeTaco)

java.lang.Object
- com.codetaco.argument.CmdLine

All Implemented Interfaces:

ICmdLine, ICmdLineArg<ICmdLine>, Cloneable, Comparable<ICmdLine>
```
public class CmdLine
extends Object
implements ICmdLine, Cloneable
```
CmdLine class.

Author:

Chris DeGreef fedupforone@gmail.com

Field Summary

Fields
Modifier and Type	Field and Description
`static ClassLoader`	`ClassLoader` Constant `ClassLoader`
`static String`	`INCLUDE_FILE_PREFIX` Constant `INCLUDE_FILE_PREFIX="@"`
`static String`	`MaxHelpCommandName` Constant `MaxHelpCommandName="help"`
`static char`	`MinHelpCommandName` Constant `MinHelpCommandName='?'`
`static char`	`NegateCommandName` Constant `NegateCommandName='!'`

Constructor Summary

Constructors
Constructor and Description
`CmdLine()` Constructor for CmdLine.
`CmdLine(String _name)` Constructor for CmdLine.
`CmdLine(String _name, char _commandPrefix, char _notPrefix)` Constructor for CmdLine.
`CmdLine(String _name, String _help)` Constructor for CmdLine.
`CmdLine(String _name, String _help, char _commandPrefix, char _notPrefix)` Constructor for CmdLine.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(ICmdLineArg<?> arg)` add.
`void`	`add(int index, ICmdLineArg<?> arg)` add.
`void`	`addDefaultIncludeDirectory(File defaultIncludeDirectory)` addDefaultIncludeDirectory.
`List<ICmdLineArg<?>>`	`allArgs()` allArgs.
`void`	`applyDefaults()` applyDefaults.
`ICmdLineArg<?>`	`arg(String commandToken)` arg.
`ICmdLineArg<?>`	`argForVariableName(String variableName)` argForVariableName.
`void`	`asDefinedType(StringBuilder sb)` asDefinedType.
`Object`	`asEnum(String _name, Object[] _possibleConstants)` asEnum.
`Object[]`	`asEnumArray(String _name, Object[] _possibleConstants)` asEnumArray.
`void`	`assignVariables(Object target)` assignVariables.
`ICmdLine`	`clone()` clone.
`int`	`compareTo(ICmdLine o)`
`ICmdLine`	`convert(String valueStr)` convert.
`ICmdLine`	`convert(String valueStr, boolean caseSensitive, Object target)` convert.
`String`	`defaultInstanceClass()` defaultInstanceClass.
`void`	`dontAllowCamelCaps()` dontAllowCamelCaps.
`boolean`	`equals(Object obj)`
`void`	`exportCommandLine(File file)` exportCommandLine.
`void`	`exportCommandLine(StringBuilder str)` exportCommandLine.
`void`	`exportNamespace(File file)` exportNamespace.
`void`	`exportNamespace(String prefix, StringBuilder out)` exportNamespace.
`void`	`exportXml(StringBuilder out)` exportXml.
`void`	`exportXml(String tag, File file)` exportXml.
`static String`	`format(String format, Object... args)` format.
`String`	`genericClassName()` genericClassName.
`String`	`getCamelCaps()` getCamelCaps.
`char`	`getCommandPrefix()` getCommandPrefix.
`ICmdLineArgCriteria<?>`	`getCriteria()` getCriteria.
`List<File>`	`getDefaultIncludeDirectories()` Getter for the field `defaultIncludeDirectories`.
`List<ICmdLine>`	`getDefaultValues()` getDefaultValues.
`Object`	`getDelegateOrValue()` getDelegateOrValue.
`Object`	`getDelegateOrValue(int occurrence)` getDelegateOrValue.
`String`	`getEnumClassName()` getEnumClassName.
`String`	`getFactoryArgName()` getFactoryArgName.
`String`	`getFactoryMethodName()` getFactoryMethodName.
`String`	`getFormat()` getFormat.
`String`	`getHelp()` getHelp.
`String`	`getInstanceClass()` getInstanceClass.
`Character`	`getKeychar()` getKeychar.
`String`	`getKeyword()` getKeyword.
`String`	`getMetaphone()` getMetaphone.
`int`	`getMultipleMax()` getMultipleMax.
`int`	`getMultipleMin()` getMultipleMin.
`String`	`getName()` getName.
`List<ParseException>`	`getParseExceptions()` getParseExceptions.
`int`	`getUniqueId()` getUniqueId.
`ICmdLine`	`getValue()` getValue.
`ICmdLine`	`getValue(int index)` getValue.
`byte[]`	`getValueAsbyteArray()` getValueAsbyteArray.
`Byte[]`	`getValueAsByteArray()` getValueAsByteArray.
`Calendar[]`	`getValueAsCalendarArray()` getValueAsCalendarArray.
`Character[]`	`getValueAsCharacterArray()` getValueAsCharacterArray.
`char[]`	`getValueAscharArray()` getValueAscharArray.
`Date[]`	`getValueAsDateArray()` getValueAsDateArray.
`DateTimeFormatter`	`getValueAsDateTimeFormatter()` getValueAsDateTimeFormatter.
`DateTimeFormatter[]`	`getValueAsDateTimeFormatterArray()` getValueAsDateTimeFormatterArray.
`double[]`	`getValueAsdoubleArray()` getValueAsdoubleArray.
`Double[]`	`getValueAsDoubleArray()` getValueAsDoubleArray.
`com.codetaco.algebrain.Equ`	`getValueAsEquation()` getValueAsEquation.
`com.codetaco.algebrain.Equ[]`	`getValueAsEquationArray()` getValueAsEquationArray.
`File[]`	`getValueAsFileArray()` getValueAsFileArray.
`float[]`	`getValueAsfloatArray()` getValueAsfloatArray.
`Float[]`	`getValueAsFloatArray()` getValueAsFloatArray.
`int[]`	`getValueAsintArray()` getValueAsintArray.
`Integer[]`	`getValueAsIntegerArray()` getValueAsIntegerArray.
`LocalDate[]`	`getValueAsLocalDateArray()` getValueAsLocalDateArray.
`LocalDateTime[]`	`getValueAsLocalDateTimeArray()` getValueAsLocalDateTimeArray.
`LocalTime[]`	`getValueAsLocalTimeArray()` getValueAsLocalTimeArray.
`long[]`	`getValueAslongArray()` getValueAslongArray.
`Long[]`	`getValueAsLongArray()` getValueAsLongArray.
`Pattern`	`getValueAsPattern()` getValueAsPattern.
`Pattern[]`	`getValueAsPatternArray()` getValueAsPatternArray.
`SimpleDateFormat`	`getValueAsSimpleDateFormat()` getValueAsSimpleDateFormat.
`SimpleDateFormat[]`	`getValueAsSimpleDateFormatArray()` getValueAsSimpleDateFormatArray.
`String[]`	`getValueAsStringArray()` getValueAsStringArray.
`String`	`getVariable()` getVariable.
`int`	`hashCode()`
`boolean`	`hasValue()` hasValue.
`int`	`indexOf(ICmdLineArg<?> arg)` indexOf.
`boolean`	`isCamelCapsAllowed()` isCamelCapsAllowed.
`boolean`	`isCaseSensitive()` isCaseSensitive.
`boolean`	`isCompiled()` isCompiled.
`boolean`	`isMetaphoneAllowed()` isMetaphoneAllowed.
`boolean`	`isMultiple()` isMultiple.
`boolean`	`isParsed()` isParsed.
`boolean`	`isPositional()` isPositional.
`boolean`	`isRequired()` isRequired.
`boolean`	`isRequiredValue()` isRequiredValue.
`boolean`	`isSystemGenerated()` isSystemGenerated.
`boolean`	`isUsageRun()` isUsageRun.
`static ICmdLine`	`load(ICmdLine cmdLine, Object target, String... args)` load.
`static ICmdLine`	`load(Object target, String... args)` load.
`static ICmdLine`	`loadProperties(Object target, File propertyFile)` loadProperties.
`static ICmdLine`	`loadProperties(Object target, String... args)` loadProperties.
`static void`	`loadWin(Object target, String... args)` loadWin.
`static ICmdLine`	`loadXml(Object target, File propertyFile)` loadXml.
`static ICmdLine`	`loadXml(Object target, String... args)` loadXml.
`static int`	`matchingArgs(List<ICmdLineArg<?>> bestArgs, List<ICmdLineArg<?>> possibleArgs, Token token, boolean includeAlreadyParsed)` matchingArgs.
`Object`	`parse(IParserInput data)` parse.
`Object`	`parse(IParserInput data, Object target)` parse.
`Object`	`parse(Object target, String... args)` parse.
`Object`	`parse(String... args)` parse.
`void`	`pull(Object variableSource)` pull.
`void`	`remove(ICmdLineArg<?> arg)` remove.
`void`	`remove(int argIndex)` remove.
`void`	`reset()` reset.
`ICmdLineArg<ICmdLine>`	`resetCriteria()` resetCriteria.
`int`	`salience(Token word)` salience.
`ICmdLineArg<ICmdLine>`	`setCamelCapsAllowed(boolean bool)` setCamelCapsAllowed.
`ICmdLineArg<ICmdLine>`	`setCaseSensitive(boolean bool)` setCaseSensitive.
`ICmdLineArg<ICmdLine>`	`setDefaultValue(String defaultValue)` setDefaultValue.
`ICmdLineArg<ICmdLine>`	`setEnumCriteria(String enumClassName)` setEnumCriteria.
`ICmdLineArg<ICmdLine>`	`setEnumCriteriaAllowError(String enumClassName)` setEnumCriteriaAllowError.
`ICmdLineArg<ICmdLine>`	`setFactoryArgName(String argName)` setFactoryArgName.
`ICmdLineArg<ICmdLine>`	`setFactoryMethodName(String methodName)` setFactoryMethodName.
`ICmdLineArg<ICmdLine>`	`setFormat(String format)` setFormat.
`ICmdLineArg<ICmdLine>`	`setHelp(String _help)` setHelp.
`ICmdLineArg<ICmdLine>`	`setInstanceClass(String classString)` setInstanceClass.
`ICmdLineArg<ICmdLine>`	`setKeychar(Character _keychar)` setKeychar.
`ICmdLineArg<ICmdLine>`	`setKeyword(String _keyword)` setKeyword.
`ICmdLineArg<ICmdLine>`	`setListCriteria(String[] values)` setListCriteria.
`ICmdLineArg<ICmdLine>`	`setMetaphoneAllowed(boolean bool)` setMetaphoneAllowed.
`ICmdLineArg<ICmdLine>`	`setMultiple(boolean bool)` setMultiple.
`ICmdLineArg<ICmdLine>`	`setMultiple(int min)` setMultiple.
`ICmdLineArg<ICmdLine>`	`setMultiple(int min, int max)` setMultiple.
`void`	`setName(String _name)` Setter for the field `name`.
`void`	`setObject(Object value)` setObject.
`ICmdLineArg<ICmdLine>`	`setParsed(boolean bool)` setParsed.
`ICmdLineArg<ICmdLine>`	`setPositional(boolean bool)` setPositional.
`ICmdLineArg<ICmdLine>`	`setRangeCriteria(String min, String max)` setRangeCriteria.
`ICmdLineArg<ICmdLine>`	`setRegxCriteria(String pattern)` setRegxCriteria.
`ICmdLineArg<ICmdLine>`	`setRequired(boolean bool)` setRequired.
`ICmdLineArg<ICmdLine>`	`setRequiredValue(boolean bool)` setRequiredValue.
`ICmdLineArg<ICmdLine>`	`setSystemGenerated(boolean bool)` setSystemGenerated.
`void`	`setType(ClaType claType)` setType.
`void`	`setUniqueId(int uId)` setUniqueId.
`void`	`setValue(ICmdLine value)` setValue.
`void`	`setValue(int index, ICmdLine value)` setValue.
`ICmdLineArg<ICmdLine>`	`setVariable(String string)` setVariable.
`int`	`size()` size.
`boolean`	`supportsCamelCaps()` supportsCamelCaps.
`boolean`	`supportsCaseSensitive()` supportsCaseSensitive.
`boolean`	`supportsDefaultValues()` supportsDefaultValues.
`boolean`	`supportsExcludeArgs()` supportsExcludeArgs.
`boolean`	`supportsFactoryArgName()` supportsFactoryArgName.
`boolean`	`supportsFactoryMethod()` supportsFactoryMethod.
`boolean`	`supportsFormat()` supportsFormat.
`boolean`	`supportsHelp()` supportsHelp.
`boolean`	`supportsInList()` supportsInList.
`boolean`	`supportsInstanceClass()` supportsInstanceClass.
`boolean`	`supportsLongName()` supportsLongName.
`boolean`	`supportsMatches()` supportsMatches.
`boolean`	`supportsMetaphone()` supportsMetaphone.
`boolean`	`supportsMultimax()` supportsMultimax.
`boolean`	`supportsMultimin()` supportsMultimin.
`boolean`	`supportsPositional()` supportsPositional.
`boolean`	`supportsRange()` supportsRange.
`boolean`	`supportsRequired()` supportsRequired.
`boolean`	`supportsShortName()` supportsShortName.
`void`	`useDefaults()` useDefaults.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ClassLoader
```
public static ClassLoader ClassLoader
```
    Constant ClassLoader
  - INCLUDE_FILE_PREFIX
```
public static final String INCLUDE_FILE_PREFIX
```
    Constant INCLUDE_FILE_PREFIX="@"
    
    See Also:
    
    Constant Field Values
  - MaxHelpCommandName
```
public static final String MaxHelpCommandName
```
    Constant MaxHelpCommandName="help"
    
    See Also:
    
    Constant Field Values
  - MinHelpCommandName
```
public static final char MinHelpCommandName
```
    Constant MinHelpCommandName='?'
    
    See Also:
    
    Constant Field Values
  - NegateCommandName
```
public static final char NegateCommandName
```
    Constant NegateCommandName='!'
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CmdLine
```
public CmdLine()
```
    Constructor for CmdLine.
  - CmdLine
```
public CmdLine(String _name)
```
    Constructor for CmdLine.
    
    Parameters:
    
    _name - a String object.
  - CmdLine
```
public CmdLine(String _name,
               char _commandPrefix,
               char _notPrefix)
```
    Constructor for CmdLine.
    
    Parameters:
    
    _name - a String object.
    
    _commandPrefix - a char.
    
    _notPrefix - a char.
  - CmdLine
```
public CmdLine(String _name,
               String _help)
```
    Constructor for CmdLine.
    
    Parameters:
    
    _name - a String object.
    
    _help - a String object.
  - CmdLine
```
public CmdLine(String _name,
               String _help,
               char _commandPrefix,
               char _notPrefix)
```
    Constructor for CmdLine.
    
    Parameters:
    
    _name - a String object.
    
    _help - a String object.
    
    _commandPrefix - a char.
    
    _notPrefix - a char.
- Method Detail
  - format
```
public static String format(String format,
                            Object... args)
```
    format.
    
    Parameters:
    
    format - a String object.
    
    args - a Object object.
    
    Returns:
    
    a String object.
  - load
```
public static ICmdLine load(ICmdLine cmdLine,
                            Object target,
                            String... args)
                     throws IOException,
                            ParseException
```
    load.
    
    Parameters:
    
    cmdLine - a ICmdLine object.
    
    target - a Object object.
    
    args - a String object.
    
    Returns:
    
    a ICmdLine object.
    
    Throws:
    
    IOException - if any.
    
    ParseException - if any.
  - load
```
public static ICmdLine load(Object target,
                            String... args)
                     throws IOException,
                            ParseException
```
    load.
    
    Parameters:
    
    target - a Object object.
    
    args - a String object.
    
    Returns:
    
    a ICmdLine object.
    
    Throws:
    
    IOException - if any.
    
    ParseException - if any.
  - loadProperties
```
public static ICmdLine loadProperties(Object target,
                                      File propertyFile)
                               throws IOException,
                                      ParseException
```
    loadProperties.
    
    Parameters:
    
    target - a Object object.
    
    propertyFile - a File object.
    
    Returns:
    
    a ICmdLine object.
    
    Throws:
    
    IOException - if any.
    
    ParseException - if any.
  - loadProperties
```
public static ICmdLine loadProperties(Object target,
                                      String... args)
                               throws IOException,
                                      ParseException
```
    loadProperties.
    
    Parameters:
    
    target - a Object object.
    
    args - a String object.
    
    Returns:
    
    a ICmdLine object.
    
    Throws:
    
    IOException - if any.
    
    ParseException - if any.
  - loadWin
```
public static void loadWin(Object target,
                           String... args)
                    throws IOException,
                           ParseException
```
    loadWin.
    
    Parameters:
    
    target - a Object object.
    
    args - a String object.
    
    Throws:
    
    IOException - if any.
    
    ParseException - if any.
  - loadXml
```
public static ICmdLine loadXml(Object target,
                               File propertyFile)
                        throws IOException,
                               ParseException
```
    loadXml.
    
    Parameters:
    
    target - a Object object.
    
    propertyFile - a File object.
    
    Returns:
    
    a ICmdLine object.
    
    Throws:
    
    IOException - if any.
    
    ParseException - if any.
  - loadXml
```
public static ICmdLine loadXml(Object target,
                               String... args)
                        throws IOException,
                               ParseException
```
    loadXml.
    
    Parameters:
    
    target - a Object object.
    
    args - a String object.
    
    Returns:
    
    a ICmdLine object.
    
    Throws:
    
    IOException - if any.
    
    ParseException - if any.
  - matchingArgs
```
public static int matchingArgs(List<ICmdLineArg<?>> bestArgs,
                               List<ICmdLineArg<?>> possibleArgs,
                               Token token,
                               boolean includeAlreadyParsed)
```
    matchingArgs.
    
    Parameters:
    
    bestArgs - a List object.
    
    possibleArgs - a List object.
    
    token - a Token object.
    
    includeAlreadyParsed - a boolean.
    
    Returns:
    
    a int.
  - add
```
public void add(ICmdLineArg<?> arg)
```
    add.
    
    Specified by:
    
    add in interface ICmdLine
    
    Parameters:
    
    arg - a ICmdLineArg object.
  - add
```
public void add(int index,
                ICmdLineArg<?> arg)
```
    add.
    
    Specified by:
    
    add in interface ICmdLine
    
    Parameters:
    
    index - a int.
    
    arg - a ICmdLineArg object.
  - addDefaultIncludeDirectory
```
public void addDefaultIncludeDirectory(File defaultIncludeDirectory)
```
    addDefaultIncludeDirectory.
    
    Specified by:
    
    addDefaultIncludeDirectory in interface ICmdLine
    
    Parameters:
    
    defaultIncludeDirectory - a File object.
  - allArgs
```
public List<ICmdLineArg<?>> allArgs()
```
    allArgs.
    
    Specified by:
    
    allArgs in interface ICmdLine
    
    Returns:
    
    a List object.
  - applyDefaults
```
public void applyDefaults()
```
    applyDefaults.
    
    Specified by:
    
    applyDefaults in interface ICmdLineArg<ICmdLine>
  - arg
```
public ICmdLineArg<?> arg(String commandToken)
```
    arg.
    
    Specified by:
    
    arg in interface ICmdLine
    
    Parameters:
    
    commandToken - a String object.
    
    Returns:
    
    a ICmdLineArg object.
  - argForVariableName
```
public ICmdLineArg<?> argForVariableName(String variableName)
                                  throws ParseException
```
    argForVariableName.
    
    Specified by:
    
    argForVariableName in interface ICmdLine
    
    Parameters:
    
    variableName - a String object.
    
    Returns:
    
    a ICmdLineArg object.
    
    Throws:
    
    ParseException - if any.
  - asDefinedType
```
public void asDefinedType(StringBuilder sb)
```
    asDefinedType.
    
    Specified by:
    
    asDefinedType in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    sb - a StringBuilder object.
  - asEnum
```
public Object asEnum(String _name,
                     Object[] _possibleConstants)
              throws ParseException
```
    asEnum.
    
    Specified by:
    
    asEnum in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    _name - a String object.
    
    _possibleConstants - an array of Object objects.
    
    Returns:
    
    a Object object.
    
    Throws:
    
    ParseException - if any.
  - asEnumArray
```
public Object[] asEnumArray(String _name,
                            Object[] _possibleConstants)
                     throws ParseException
```
    asEnumArray.
    
    Specified by:
    
    asEnumArray in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    _name - a String object.
    
    _possibleConstants - an array of Object objects.
    
    Returns:
    
    an array of Object objects.
    
    Throws:
    
    ParseException - if any.
  - assignVariables
```
public void assignVariables(Object target)
                     throws ParseException
```
    assignVariables.
    
    Specified by:
    
    assignVariables in interface ICmdLine
    
    Parameters:
    
    target - a Object object.
    
    Throws:
    
    ParseException - if any.
  - clone
```
public ICmdLine clone()
               throws CloneNotSupportedException
```
    clone.
    
    Specified by:
    
    clone in interface ICmdLine
    
    Specified by:
    
    clone in interface ICmdLineArg<ICmdLine>
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    a ICmdLineArg object.
    
    Throws:
    
    CloneNotSupportedException - if any.
  - compareTo
```
public int compareTo(ICmdLine o)
```
    Specified by:
    
    compareTo in interface Comparable<ICmdLine>
  - convert
```
public ICmdLine convert(String valueStr)
                 throws ParseException,
                        IOException
```
    convert.
    
    Specified by:
    
    convert in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    valueStr - a String object.
    
    Returns:
    
    a E object.
    
    Throws:
    
    ParseException - if any.
    
    IOException - if any.
  - convert
```
public ICmdLine convert(String valueStr,
                        boolean caseSensitive,
                        Object target)
                 throws ParseException,
                        IOException
```
    convert.
    
    Specified by:
    
    convert in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    valueStr - a String object.
    
    caseSensitive - a boolean.
    
    target - a Object object.
    
    Returns:
    
    a E object.
    
    Throws:
    
    ParseException - if any.
    
    IOException - if any.
  - defaultInstanceClass
```
public String defaultInstanceClass()
```
    defaultInstanceClass.
    
    Specified by:
    
    defaultInstanceClass in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a String object.
  - dontAllowCamelCaps
```
public void dontAllowCamelCaps()
```
    dontAllowCamelCaps.
    
    Specified by:
    
    dontAllowCamelCaps in interface ICmdLineArg<ICmdLine>
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - exportCommandLine
```
public void exportCommandLine(File file)
                       throws IOException
```
    exportCommandLine.
    
    Specified by:
    
    exportCommandLine in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    file - a File object.
    
    Throws:
    
    IOException - if any.
  - exportCommandLine
```
public void exportCommandLine(StringBuilder str)
```
    exportCommandLine.
    
    Specified by:
    
    exportCommandLine in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    str - a StringBuilder object.
  - exportNamespace
```
public void exportNamespace(File file)
                     throws IOException
```
    exportNamespace.
    
    Specified by:
    
    exportNamespace in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    file - a File object.
    
    Throws:
    
    IOException - if any.
  - exportNamespace
```
public void exportNamespace(String prefix,
                            StringBuilder out)
```
    exportNamespace.
    
    Specified by:
    
    exportNamespace in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    prefix - a String object.
    
    out - a StringBuilder object.
  - exportXml
```
public void exportXml(String tag,
                      File file)
               throws IOException
```
    exportXml.
    
    Specified by:
    
    exportXml in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    tag - a String object.
    
    file - a File object.
    
    Throws:
    
    IOException - if any.
  - exportXml
```
public void exportXml(StringBuilder out)
```
    exportXml.
    
    Specified by:
    
    exportXml in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    out - a StringBuilder object.
  - genericClassName
```
public String genericClassName()
```
    genericClassName.
    
    Specified by:
    
    genericClassName in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a String object.
  - getCamelCaps
```
public String getCamelCaps()
```
    getCamelCaps.
    
    Specified by:
    
    getCamelCaps in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a String object.
  - getCommandPrefix
```
public char getCommandPrefix()
```
    getCommandPrefix.
    
    Specified by:
    
    getCommandPrefix in interface ICmdLine
    
    Returns:
    
    a char.
  - getCriteria
```
public ICmdLineArgCriteria<?> getCriteria()
```
    getCriteria.
    
    Specified by:
    
    getCriteria in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a ICmdLineArgCriteria object.
  - getDefaultIncludeDirectories
```
public List<File> getDefaultIncludeDirectories()
```
    Getter for the field defaultIncludeDirectories.
    
    Returns:
    
    a List object.
  - getDefaultValues
```
public List<ICmdLine> getDefaultValues()
```
    getDefaultValues.
    
    Specified by:
    
    getDefaultValues in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a List object.
  - getDelegateOrValue
```
public Object getDelegateOrValue()
```
    getDelegateOrValue.
    
    Specified by:
    
    getDelegateOrValue in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a Object object.
  - getDelegateOrValue
```
public Object getDelegateOrValue(int occurrence)
```
    getDelegateOrValue.
    
    Specified by:
    
    getDelegateOrValue in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    occurrence - a int.
    
    Returns:
    
    a Object object.
  - getEnumClassName
```
public String getEnumClassName()
```
    getEnumClassName.
    
    Specified by:
    
    getEnumClassName in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a String object.
  - getFactoryArgName
```
public String getFactoryArgName()
```
    getFactoryArgName.
    
    Specified by:
    
    getFactoryArgName in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a String object.
  - getFactoryMethodName
```
public String getFactoryMethodName()
```
    getFactoryMethodName.
    
    Specified by:
    
    getFactoryMethodName in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a String object.
  - getFormat
```
public String getFormat()
```
    getFormat.
    
    Specified by:
    
    getFormat in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a String object.
  - getHelp
```
public String getHelp()
```
    getHelp.
    
    Specified by:
    
    getHelp in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a String object.
  - getInstanceClass
```
public String getInstanceClass()
```
    getInstanceClass.
    
    Specified by:
    
    getInstanceClass in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a String object.
  - getKeychar
```
public Character getKeychar()
```
    getKeychar.
    
    Specified by:
    
    getKeychar in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a Character object.
  - getKeyword
```
public String getKeyword()
```
    getKeyword.
    
    Specified by:
    
    getKeyword in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a String object.
  - getMetaphone
```
public String getMetaphone()
```
    getMetaphone.
    
    Specified by:
    
    getMetaphone in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a Object object.
  - getMultipleMax
```
public int getMultipleMax()
```
    getMultipleMax.
    
    Specified by:
    
    getMultipleMax in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a int.
  - getMultipleMin
```
public int getMultipleMin()
```
    getMultipleMin.
    
    Specified by:
    
    getMultipleMin in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a int.
  - getName
```
public String getName()
```
    getName.
    
    Specified by:
    
    getName in interface ICmdLine
    
    Returns:
    
    a String object.
  - getParseExceptions
```
public List<ParseException> getParseExceptions()
```
    getParseExceptions.
    
    Specified by:
    
    getParseExceptions in interface ICmdLine
    
    Returns:
    
    a List object.
  - getUniqueId
```
public int getUniqueId()
```
    getUniqueId.
    
    Specified by:
    
    getUniqueId in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a int.
  - getValue
```
public ICmdLine getValue()
```
    getValue.
    
    Specified by:
    
    getValue in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a E object.
  - getValue
```
public ICmdLine getValue(int index)
```
    getValue.
    
    Specified by:
    
    getValue in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    index - a int.
    
    Returns:
    
    a E object.
  - getValueAsbyteArray
```
public byte[] getValueAsbyteArray()
                           throws ParseException
```
    getValueAsbyteArray.
    
    Specified by:
    
    getValueAsbyteArray in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    an array of byte.
    
    Throws:
    
    ParseException - if any.
  - getValueAsByteArray
```
public Byte[] getValueAsByteArray()
                           throws ParseException
```
    getValueAsByteArray.
    
    Specified by:
    
    getValueAsByteArray in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    an array of Byte objects.
    
    Throws:
    
    ParseException - if any.
  - getValueAsCalendarArray
```
public Calendar[] getValueAsCalendarArray()
                                   throws ParseException
```
    getValueAsCalendarArray.
    
    Specified by:
    
    getValueAsCalendarArray in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    an array of Calendar objects.
    
    Throws:
    
    ParseException - if any.
  - getValueAsCharacterArray
```
public Character[] getValueAsCharacterArray()
                                     throws ParseException
```
    getValueAsCharacterArray.
    
    Specified by:
    
    getValueAsCharacterArray in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    an array of Character objects.
    
    Throws:
    
    ParseException - if any.
  - getValueAscharArray
```
public char[] getValueAscharArray()
                           throws ParseException
```
    getValueAscharArray.
    
    Specified by:
    
    getValueAscharArray in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    an array of char.
    
    Throws:
    
    ParseException - if any.
  - getValueAsDateArray
```
public Date[] getValueAsDateArray()
                           throws ParseException
```
    getValueAsDateArray.
    
    Specified by:
    
    getValueAsDateArray in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    an array of Date objects.
    
    Throws:
    
    ParseException - if any.
  - getValueAsDateTimeFormatter
```
public DateTimeFormatter getValueAsDateTimeFormatter()
                                              throws ParseException
```
    getValueAsDateTimeFormatter.
    
    Specified by:
    
    getValueAsDateTimeFormatter in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a DateTimeFormatter object.
    
    Throws:
    
    ParseException - if any.
  - getValueAsDateTimeFormatterArray
```
public DateTimeFormatter[] getValueAsDateTimeFormatterArray()
                                                     throws ParseException
```
    getValueAsDateTimeFormatterArray.
    
    Specified by:
    
    getValueAsDateTimeFormatterArray in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    an array of DateTimeFormatter objects.
    
    Throws:
    
    ParseException - if any.
  - getValueAsdoubleArray
```
public double[] getValueAsdoubleArray()
                               throws ParseException
```
    getValueAsdoubleArray.
    
    Specified by:
    
    getValueAsdoubleArray in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    an array of double.
    
    Throws:
    
    ParseException - if any.
  - getValueAsDoubleArray
```
public Double[] getValueAsDoubleArray()
                               throws ParseException
```
    getValueAsDoubleArray.
    
    Specified by:
    
    getValueAsDoubleArray in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    an array of Double objects.
    
    Throws:
    
    ParseException - if any.
  - getValueAsEquation
```
public com.codetaco.algebrain.Equ getValueAsEquation()
                                              throws ParseException
```
    getValueAsEquation.
    
    Specified by:
    
    getValueAsEquation in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a Equ object.
    
    Throws:
    
    ParseException - if any.
  - getValueAsEquationArray
```
public com.codetaco.algebrain.Equ[] getValueAsEquationArray()
                                                     throws ParseException
```
    getValueAsEquationArray.
    
    Specified by:
    
    getValueAsEquationArray in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    an array of Equ objects.
    
    Throws:
    
    ParseException - if any.
  - getValueAsFileArray
```
public File[] getValueAsFileArray()
                           throws ParseException
```
    getValueAsFileArray.
    
    Specified by:
    
    getValueAsFileArray in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    an array of File objects.
    
    Throws:
    
    ParseException - if any.
  - getValueAsfloatArray
```
public float[] getValueAsfloatArray()
                             throws ParseException
```
    getValueAsfloatArray.
    
    Specified by:
    
    getValueAsfloatArray in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    an array of float.
    
    Throws:
    
    ParseException - if any.
  - getValueAsFloatArray
```
public Float[] getValueAsFloatArray()
                             throws ParseException
```
    getValueAsFloatArray.
    
    Specified by:
    
    getValueAsFloatArray in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    an array of Float objects.
    
    Throws:
    
    ParseException - if any.
  - getValueAsintArray
```
public int[] getValueAsintArray()
                         throws ParseException
```
    getValueAsintArray.
    
    Specified by:
    
    getValueAsintArray in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    an array of int.
    
    Throws:
    
    ParseException - if any.
  - getValueAsIntegerArray
```
public Integer[] getValueAsIntegerArray()
                                 throws ParseException
```
    getValueAsIntegerArray.
    
    Specified by:
    
    getValueAsIntegerArray in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    an array of Integer objects.
    
    Throws:
    
    ParseException - if any.
  - getValueAsLocalDateArray
```
public LocalDate[] getValueAsLocalDateArray()
                                     throws ParseException
```
    getValueAsLocalDateArray.
    
    Specified by:
    
    getValueAsLocalDateArray in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    an array of LocalDate objects.
    
    Throws:
    
    ParseException - if any.
  - getValueAsLocalDateTimeArray
```
public LocalDateTime[] getValueAsLocalDateTimeArray()
                                             throws ParseException
```
    getValueAsLocalDateTimeArray.
    
    Specified by:
    
    getValueAsLocalDateTimeArray in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    an array of LocalDateTime objects.
    
    Throws:
    
    ParseException - if any.
  - getValueAsLocalTimeArray
```
public LocalTime[] getValueAsLocalTimeArray()
                                     throws ParseException
```
    getValueAsLocalTimeArray.
    
    Specified by:
    
    getValueAsLocalTimeArray in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    an array of LocalTime objects.
    
    Throws:
    
    ParseException - if any.
  - getValueAslongArray
```
public long[] getValueAslongArray()
                           throws ParseException
```
    getValueAslongArray.
    
    Specified by:
    
    getValueAslongArray in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    an array of long.
    
    Throws:
    
    ParseException - if any.
  - getValueAsLongArray
```
public Long[] getValueAsLongArray()
                           throws ParseException
```
    getValueAsLongArray.
    
    Specified by:
    
    getValueAsLongArray in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    an array of Long objects.
    
    Throws:
    
    ParseException - if any.
  - getValueAsPattern
```
public Pattern getValueAsPattern()
                          throws ParseException
```
    getValueAsPattern.
    
    Specified by:
    
    getValueAsPattern in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a Pattern object.
    
    Throws:
    
    ParseException - if any.
  - getValueAsPatternArray
```
public Pattern[] getValueAsPatternArray()
                                 throws ParseException
```
    getValueAsPatternArray.
    
    Specified by:
    
    getValueAsPatternArray in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    an array of Pattern objects.
    
    Throws:
    
    ParseException - if any.
  - getValueAsSimpleDateFormat
```
public SimpleDateFormat getValueAsSimpleDateFormat()
                                            throws ParseException
```
    getValueAsSimpleDateFormat.
    
    Specified by:
    
    getValueAsSimpleDateFormat in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a SimpleDateFormat object.
    
    Throws:
    
    ParseException - if any.
  - getValueAsSimpleDateFormatArray
```
public SimpleDateFormat[] getValueAsSimpleDateFormatArray()
                                                   throws ParseException
```
    getValueAsSimpleDateFormatArray.
    
    Specified by:
    
    getValueAsSimpleDateFormatArray in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    an array of SimpleDateFormat objects.
    
    Throws:
    
    ParseException - if any.
  - getValueAsStringArray
```
public String[] getValueAsStringArray()
                               throws ParseException
```
    getValueAsStringArray.
    
    Specified by:
    
    getValueAsStringArray in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    an array of String objects.
    
    Throws:
    
    ParseException - if any.
  - getVariable
```
public String getVariable()
```
    getVariable.
    
    Specified by:
    
    getVariable in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a String object.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - hasValue
```
public boolean hasValue()
```
    hasValue.
    
    Specified by:
    
    hasValue in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - indexOf
```
public int indexOf(ICmdLineArg<?> arg)
```
    indexOf.
    
    Specified by:
    
    indexOf in interface ICmdLine
    
    Parameters:
    
    arg - a ICmdLineArg object.
    
    Returns:
    
    a int.
  - isCamelCapsAllowed
```
public boolean isCamelCapsAllowed()
```
    isCamelCapsAllowed.
    
    Specified by:
    
    isCamelCapsAllowed in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - isCaseSensitive
```
public boolean isCaseSensitive()
```
    isCaseSensitive.
    
    Specified by:
    
    isCaseSensitive in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - isCompiled
```
public boolean isCompiled()
```
    isCompiled.
    
    Returns:
    
    a boolean.
  - isMetaphoneAllowed
```
public boolean isMetaphoneAllowed()
```
    isMetaphoneAllowed.
    
    Specified by:
    
    isMetaphoneAllowed in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - isMultiple
```
public boolean isMultiple()
```
    isMultiple.
    
    Specified by:
    
    isMultiple in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - isParsed
```
public boolean isParsed()
```
    isParsed.
    
    Specified by:
    
    isParsed in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - isPositional
```
public boolean isPositional()
```
    isPositional.
    
    Specified by:
    
    isPositional in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - isRequired
```
public boolean isRequired()
```
    isRequired.
    
    Specified by:
    
    isRequired in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - isRequiredValue
```
public boolean isRequiredValue()
```
    isRequiredValue.
    
    Specified by:
    
    isRequiredValue in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - isSystemGenerated
```
public boolean isSystemGenerated()
```
    isSystemGenerated.
    
    Specified by:
    
    isSystemGenerated in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - isUsageRun
```
public boolean isUsageRun()
```
    isUsageRun.
    
    Returns:
    
    a boolean.
  - parse
```
public Object parse(IParserInput data)
             throws IOException,
                    ParseException
```
    parse.
    
    Specified by:
    
    parse in interface ICmdLine
    
    Parameters:
    
    data - a IParserInput object.
    
    Returns:
    
    a Object object.
    
    Throws:
    
    IOException - if any.
    
    ParseException - if any.
  - parse
```
public Object parse(IParserInput data,
                    Object target)
             throws IOException,
                    ParseException
```
    parse.
    
    Specified by:
    
    parse in interface ICmdLine
    
    Parameters:
    
    data - a IParserInput object.
    
    target - a Object object.
    
    Returns:
    
    a Object object.
    
    Throws:
    
    IOException - if any.
    
    ParseException - if any.
  - parse
```
public Object parse(Object target,
                    String... args)
             throws IOException,
                    ParseException
```
    parse.
    
    Specified by:
    
    parse in interface ICmdLine
    
    Parameters:
    
    target - a Object object.
    
    args - a String object.
    
    Returns:
    
    a Object object.
    
    Throws:
    
    IOException - if any.
    
    ParseException - if any.
  - parse
```
public Object parse(String... args)
             throws IOException,
                    ParseException
```
    parse.
    
    Specified by:
    
    parse in interface ICmdLine
    
    Parameters:
    
    args - a String object.
    
    Returns:
    
    a Object object.
    
    Throws:
    
    IOException - if any.
    
    ParseException - if any.
  - pull
```
public void pull(Object variableSource)
          throws ParseException
```
    pull.
    Pulls the values of the variables back into the arguments. This is usually in preparation for an export. When used in conjunction with a properties file, for instance, this allows the program to periodically update the properties and then pull them back into the properties file on disk.
    
    Specified by:
    
    pull in interface ICmdLine
    
    Parameters:
    
    variableSource - a Object object.
    
    Throws:
    
    ParseException - if any.
  - remove
```
public void remove(ICmdLineArg<?> arg)
```
    remove.
    
    Specified by:
    
    remove in interface ICmdLine
    
    Parameters:
    
    arg - a ICmdLineArg object.
  - remove
```
public void remove(int argIndex)
```
    remove.
    
    Specified by:
    
    remove in interface ICmdLine
    
    Parameters:
    
    argIndex - a int.
  - reset
```
public void reset()
```
    reset.
    
    Specified by:
    
    reset in interface ICmdLineArg<ICmdLine>
  - resetCriteria
```
public ICmdLineArg<ICmdLine> resetCriteria()
```
    resetCriteria.
    
    Specified by:
    
    resetCriteria in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a ICmdLineArg object.
  - salience
```
public int salience(Token word)
```
    salience.
    
    Specified by:
    
    salience in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    word - a Token object.
    
    Returns:
    
    a int.
  - setCamelCapsAllowed
```
public ICmdLineArg<ICmdLine> setCamelCapsAllowed(boolean bool)
```
    setCamelCapsAllowed.
    
    Specified by:
    
    setCamelCapsAllowed in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    bool - a boolean.
    
    Returns:
    
    a ICmdLineArg object.
  - setCaseSensitive
```
public ICmdLineArg<ICmdLine> setCaseSensitive(boolean bool)
```
    setCaseSensitive.
    
    Specified by:
    
    setCaseSensitive in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    bool - a boolean.
    
    Returns:
    
    a ICmdLineArg object.
  - setDefaultValue
```
public ICmdLineArg<ICmdLine> setDefaultValue(String defaultValue)
                                      throws ParseException,
                                             IOException
```
    setDefaultValue.
    
    Specified by:
    
    setDefaultValue in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    defaultValue - a String object.
    
    Returns:
    
    a ICmdLineArg object.
    
    Throws:
    
    ParseException - if any.
    
    IOException - if any.
  - setEnumCriteria
```
public ICmdLineArg<ICmdLine> setEnumCriteria(String enumClassName)
                                      throws ParseException,
                                             IOException
```
    setEnumCriteria.
    
    Specified by:
    
    setEnumCriteria in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    enumClassName - a String object.
    
    Returns:
    
    a ICmdLineArg object.
    
    Throws:
    
    ParseException - if any.
    
    IOException - if any.
  - setEnumCriteriaAllowError
```
public ICmdLineArg<ICmdLine> setEnumCriteriaAllowError(String enumClassName)
```
    setEnumCriteriaAllowError.
    
    Specified by:
    
    setEnumCriteriaAllowError in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    enumClassName - a String object.
    
    Returns:
    
    a ICmdLineArg object.
  - setFactoryArgName
```
public ICmdLineArg<ICmdLine> setFactoryArgName(String argName)
```
    setFactoryArgName.
    
    Specified by:
    
    setFactoryArgName in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    argName - a String object.
    
    Returns:
    
    a ICmdLineArg object.
  - setFactoryMethodName
```
public ICmdLineArg<ICmdLine> setFactoryMethodName(String methodName)
```
    setFactoryMethodName.
    
    Specified by:
    
    setFactoryMethodName in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    methodName - a String object.
    
    Returns:
    
    a ICmdLineArg object.
  - setFormat
```
public ICmdLineArg<ICmdLine> setFormat(String format)
                                throws ParseException
```
    setFormat.
    
    Specified by:
    
    setFormat in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    format - a String object.
    
    Returns:
    
    a ICmdLineArg object.
    
    Throws:
    
    ParseException - if any.
  - setHelp
```
public ICmdLineArg<ICmdLine> setHelp(String _help)
```
    setHelp.
    
    Specified by:
    
    setHelp in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    _help - a String object.
    
    Returns:
    
    a ICmdLineArg object.
  - setInstanceClass
```
public ICmdLineArg<ICmdLine> setInstanceClass(String classString)
```
    setInstanceClass.
    
    Specified by:
    
    setInstanceClass in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    classString - a String object.
    
    Returns:
    
    a ICmdLineArg object.
  - setKeychar
```
public ICmdLineArg<ICmdLine> setKeychar(Character _keychar)
```
    setKeychar.
    
    Specified by:
    
    setKeychar in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    _keychar - a Character object.
    
    Returns:
    
    a ICmdLineArg object.
  - setKeyword
```
public ICmdLineArg<ICmdLine> setKeyword(String _keyword)
```
    setKeyword.
    
    Specified by:
    
    setKeyword in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    _keyword - a String object.
    
    Returns:
    
    a ICmdLineArg object.
  - setListCriteria
```
public ICmdLineArg<ICmdLine> setListCriteria(String[] values)
                                      throws ParseException,
                                             IOException
```
    setListCriteria.
    
    Specified by:
    
    setListCriteria in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    values - an array of String objects.
    
    Returns:
    
    a ICmdLineArg object.
    
    Throws:
    
    ParseException - if any.
    
    IOException - if any.
  - setMetaphoneAllowed
```
public ICmdLineArg<ICmdLine> setMetaphoneAllowed(boolean bool)
```
    setMetaphoneAllowed.
    
    Specified by:
    
    setMetaphoneAllowed in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    bool - a boolean.
    
    Returns:
    
    a ICmdLineArg object.
  - setMultiple
```
public ICmdLineArg<ICmdLine> setMultiple(boolean bool)
```
    setMultiple.
    
    Specified by:
    
    setMultiple in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    bool - a boolean.
    
    Returns:
    
    a ICmdLineArg object.
  - setMultiple
```
public ICmdLineArg<ICmdLine> setMultiple(int min)
```
    setMultiple.
    
    Specified by:
    
    setMultiple in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    min - a int.
    
    Returns:
    
    a ICmdLineArg object.
  - setMultiple
```
public ICmdLineArg<ICmdLine> setMultiple(int min,
                                         int max)
```
    setMultiple.
    
    Specified by:
    
    setMultiple in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    min - a int.
    
    max - a int.
    
    Returns:
    
    a ICmdLineArg object.
  - setName
```
public void setName(String _name)
```
    Setter for the field name.
    
    Parameters:
    
    _name - a String object.
  - setObject
```
public void setObject(Object value)
```
    setObject.
    
    Specified by:
    
    setObject in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    value - a Object object.
  - setParsed
```
public ICmdLineArg<ICmdLine> setParsed(boolean bool)
```
    setParsed.
    
    Specified by:
    
    setParsed in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    bool - a boolean.
    
    Returns:
    
    a ICmdLineArg object.
  - setPositional
```
public ICmdLineArg<ICmdLine> setPositional(boolean bool)
```
    setPositional.
    
    Specified by:
    
    setPositional in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    bool - a boolean.
    
    Returns:
    
    a ICmdLineArg object.
  - setRangeCriteria
```
public ICmdLineArg<ICmdLine> setRangeCriteria(String min,
                                              String max)
                                       throws ParseException,
                                              IOException
```
    setRangeCriteria.
    
    Specified by:
    
    setRangeCriteria in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    min - a String object.
    
    max - a String object.
    
    Returns:
    
    a ICmdLineArg object.
    
    Throws:
    
    ParseException - if any.
    
    IOException - if any.
  - setRegxCriteria
```
public ICmdLineArg<ICmdLine> setRegxCriteria(String pattern)
                                      throws ParseException
```
    setRegxCriteria.
    
    Specified by:
    
    setRegxCriteria in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    pattern - a String object.
    
    Returns:
    
    a ICmdLineArg object.
    
    Throws:
    
    ParseException - if any.
  - setRequired
```
public ICmdLineArg<ICmdLine> setRequired(boolean bool)
```
    setRequired.
    
    Specified by:
    
    setRequired in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    bool - a boolean.
    
    Returns:
    
    a ICmdLineArg object.
  - setRequiredValue
```
public ICmdLineArg<ICmdLine> setRequiredValue(boolean bool)
                                       throws ParseException
```
    setRequiredValue.
    
    Specified by:
    
    setRequiredValue in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    bool - a boolean.
    
    Returns:
    
    a ICmdLineArg object.
    
    Throws:
    
    ParseException - if any.
  - setSystemGenerated
```
public ICmdLineArg<ICmdLine> setSystemGenerated(boolean bool)
                                         throws ParseException
```
    setSystemGenerated.
    
    Specified by:
    
    setSystemGenerated in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    bool - a boolean.
    
    Returns:
    
    a ICmdLineArg object.
    
    Throws:
    
    ParseException - if any.
  - setType
```
public void setType(ClaType claType)
```
    setType.
    
    Specified by:
    
    setType in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    claType - a ClaType object.
  - setUniqueId
```
public void setUniqueId(int uId)
```
    setUniqueId.
    
    Specified by:
    
    setUniqueId in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    uId - a int.
  - setValue
```
public void setValue(ICmdLine value)
```
    setValue.
    
    Specified by:
    
    setValue in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    value - a E object.
  - setValue
```
public void setValue(int index,
                     ICmdLine value)
```
    setValue.
    
    Specified by:
    
    setValue in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    index - a int.
    
    value - a E object.
  - setVariable
```
public ICmdLineArg<ICmdLine> setVariable(String string)
```
    setVariable.
    
    Specified by:
    
    setVariable in interface ICmdLineArg<ICmdLine>
    
    Parameters:
    
    string - a String object.
    
    Returns:
    
    a ICmdLineArg object.
  - size
```
public int size()
```
    size.
    
    Specified by:
    
    size in interface ICmdLine
    
    Specified by:
    
    size in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a int.
  - supportsCamelCaps
```
public boolean supportsCamelCaps()
```
    supportsCamelCaps.
    
    Specified by:
    
    supportsCamelCaps in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - supportsCaseSensitive
```
public boolean supportsCaseSensitive()
```
    supportsCaseSensitive.
    
    Specified by:
    
    supportsCaseSensitive in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - supportsDefaultValues
```
public boolean supportsDefaultValues()
```
    supportsDefaultValues.
    
    Specified by:
    
    supportsDefaultValues in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - supportsExcludeArgs
```
public boolean supportsExcludeArgs()
```
    supportsExcludeArgs.
    
    Specified by:
    
    supportsExcludeArgs in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - supportsFactoryArgName
```
public boolean supportsFactoryArgName()
```
    supportsFactoryArgName.
    
    Specified by:
    
    supportsFactoryArgName in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - supportsFactoryMethod
```
public boolean supportsFactoryMethod()
```
    supportsFactoryMethod.
    
    Specified by:
    
    supportsFactoryMethod in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - supportsFormat
```
public boolean supportsFormat()
```
    supportsFormat.
    
    Specified by:
    
    supportsFormat in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - supportsHelp
```
public boolean supportsHelp()
```
    supportsHelp.
    
    Specified by:
    
    supportsHelp in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - supportsInList
```
public boolean supportsInList()
```
    supportsInList.
    
    Specified by:
    
    supportsInList in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - supportsInstanceClass
```
public boolean supportsInstanceClass()
```
    supportsInstanceClass.
    
    Specified by:
    
    supportsInstanceClass in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - supportsLongName
```
public boolean supportsLongName()
```
    supportsLongName.
    
    Specified by:
    
    supportsLongName in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - supportsMatches
```
public boolean supportsMatches()
```
    supportsMatches.
    
    Specified by:
    
    supportsMatches in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - supportsMetaphone
```
public boolean supportsMetaphone()
```
    supportsMetaphone.
    
    Specified by:
    
    supportsMetaphone in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - supportsMultimax
```
public boolean supportsMultimax()
```
    supportsMultimax.
    
    Specified by:
    
    supportsMultimax in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - supportsMultimin
```
public boolean supportsMultimin()
```
    supportsMultimin.
    
    Specified by:
    
    supportsMultimin in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - supportsPositional
```
public boolean supportsPositional()
```
    supportsPositional.
    
    Specified by:
    
    supportsPositional in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - supportsRange
```
public boolean supportsRange()
```
    supportsRange.
    
    Specified by:
    
    supportsRange in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - supportsRequired
```
public boolean supportsRequired()
```
    supportsRequired.
    
    Specified by:
    
    supportsRequired in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - supportsShortName
```
public boolean supportsShortName()
```
    supportsShortName.
    
    Specified by:
    
    supportsShortName in interface ICmdLineArg<ICmdLine>
    
    Returns:
    
    a boolean.
  - useDefaults
```
public void useDefaults()
```
    useDefaults.
    
    Specified by:
    
    useDefaults in interface ICmdLineArg<ICmdLine>

Class CmdLine

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ClassLoader

INCLUDE_FILE_PREFIX

MaxHelpCommandName

MinHelpCommandName

NegateCommandName

Constructor Detail

CmdLine

CmdLine

CmdLine

CmdLine

CmdLine

Method Detail

format

load

load

loadProperties

loadProperties

loadWin

loadXml

loadXml

matchingArgs

add

add

addDefaultIncludeDirectory

allArgs

applyDefaults

arg

argForVariableName

asDefinedType

asEnum

asEnumArray

assignVariables

clone

compareTo

convert

convert

defaultInstanceClass

dontAllowCamelCaps

equals

exportCommandLine

exportCommandLine

exportNamespace

exportNamespace

exportXml

exportXml

genericClassName

getCamelCaps

getCommandPrefix

getCriteria

getDefaultIncludeDirectories

getDefaultValues

getDelegateOrValue

getDelegateOrValue

getEnumClassName

getFactoryArgName

getFactoryMethodName

getFormat

getHelp

getInstanceClass

getKeychar

getKeyword

getMetaphone

getMultipleMax

getMultipleMin

getName

getParseExceptions

getUniqueId

getValue

getValue

getValueAsbyteArray

getValueAsByteArray

getValueAsCalendarArray

getValueAsCharacterArray

getValueAscharArray