com.codetaco.argument

Interface ICmdLine

All Superinterfaces:

Comparable<ICmdLine>, ICmdLineArg<ICmdLine>

All Known Implementing Classes:

CmdLine

public interface ICmdLine
extends Comparable<ICmdLine>, ICmdLineArg<ICmdLine>

ICmdLine interface.

Author:

Chris DeGreef fedupforone@gmail.com

Method Summary

Modifier and Type	Method and Description
void	add(ICmdLineArg<?> arg) add.
void	add(int index, ICmdLineArg<?> arg) add.
void	addDefaultIncludeDirectory(File directory) addDefaultIncludeDirectory.
List<ICmdLineArg<?>>	allArgs() allArgs.
ICmdLineArg<?>	arg(String commandToken) arg.
ICmdLineArg<?>	argForVariableName(String variableName) argForVariableName.
void	assignVariables(Object target) assignVariables.
ICmdLine	clone() clone.
char	getCommandPrefix() getCommandPrefix.
String	getName() getName.
List<ParseException>	getParseExceptions() getParseExceptions.
int	indexOf(ICmdLineArg<?> arg) indexOf.
Object	parse(IParserInput cmd) parse.
Object	parse(IParserInput cmd, 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.
int	size() size.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.codetaco.argument.type.ICmdLineArg

applyDefaults, asDefinedType, asEnum, asEnumArray, convert, convert, defaultInstanceClass, dontAllowCamelCaps, exportCommandLine, exportCommandLine, exportNamespace, exportNamespace, exportXml, exportXml, genericClassName, getCamelCaps, getCriteria, getDefaultValues, getDelegateOrValue, getDelegateOrValue, getEnumClassName, getFactoryArgName, getFactoryMethodName, getFormat, getHelp, getInstanceClass, getKeychar, getKeyword, getMetaphone, getMultipleMax, getMultipleMin, getUniqueId, getValue, getValue, getValueAsbyteArray, getValueAsByteArray, getValueAsCalendarArray, getValueAsCharacterArray, getValueAscharArray, getValueAsDateArray, getValueAsDateTimeFormatter, getValueAsDateTimeFormatterArray, getValueAsdoubleArray, getValueAsDoubleArray, getValueAsEquation, getValueAsEquationArray, getValueAsFileArray, getValueAsfloatArray, getValueAsFloatArray, getValueAsintArray, getValueAsIntegerArray, getValueAsLocalDateArray, getValueAsLocalDateTimeArray, getValueAsLocalTimeArray, getValueAslongArray, getValueAsLongArray, getValueAsPattern, getValueAsPatternArray, getValueAsSimpleDateFormat, getValueAsSimpleDateFormatArray, getValueAsStringArray, getVariable, hasValue, isCamelCapsAllowed, isCaseSensitive, isMetaphoneAllowed, isMultiple, isParsed, isPositional, isRequired, isRequiredValue, isSystemGenerated, reset, resetCriteria, salience, setCamelCapsAllowed, setCaseSensitive, setDefaultValue, setEnumCriteria, setEnumCriteriaAllowError, setFactoryArgName, setFactoryMethodName, setFormat, setHelp, setInstanceClass, setKeychar, setKeyword, setListCriteria, setMetaphoneAllowed, setMultiple, setMultiple, setMultiple, setObject, setParsed, setPositional, setRangeCriteria, setRegxCriteria, setRequired, setRequiredValue, setSystemGenerated, setType, setUniqueId, setValue, setValue, setVariable, supportsCamelCaps, supportsCaseSensitive, supportsDefaultValues, supportsExcludeArgs, supportsFactoryArgName, supportsFactoryMethod, supportsFormat, supportsHelp, supportsInList, supportsInstanceClass, supportsLongName, supportsMatches, supportsMetaphone, supportsMultimax, supportsMultimin, supportsPositional, supportsRange, supportsRequired, supportsShortName, useDefaults

Method Detail

add

void add(ICmdLineArg<?> arg)

add.

Parameters:

arg - a ICmdLineArg object.

add

void add(int index,
         ICmdLineArg<?> arg)

add.

Parameters:

index - a int.

arg - a ICmdLineArg object.

addDefaultIncludeDirectory

void addDefaultIncludeDirectory(File directory)

addDefaultIncludeDirectory.

Parameters:

directory - a File object.

allArgs

List<ICmdLineArg<?>> allArgs()

allArgs.

Returns:

a List object.

arg

ICmdLineArg<?> arg(String commandToken)

arg.

Parameters:

commandToken - a String object.

Returns:

a ICmdLineArg object.

argForVariableName

ICmdLineArg<?> argForVariableName(String variableName)
                           throws ParseException

argForVariableName.

Parameters:

variableName - a String object.

Returns:

a ICmdLineArg object.

Throws:

ParseException - if any.

assignVariables

void assignVariables(Object target)
              throws ParseException

assignVariables.

Parameters:

target - a Object object.

Throws:

ParseException - if any.

clone

ICmdLine clone()
        throws CloneNotSupportedException

clone.

Specified by:

clone in interface ICmdLineArg<ICmdLine>

Returns:

a ICmdLineArg object.

Throws:

CloneNotSupportedException - if any.

getCommandPrefix

char getCommandPrefix()

getCommandPrefix.

Returns:

a char.

getName

String getName()

getName.

Returns:

a String object.

getParseExceptions

List<ParseException> getParseExceptions()

getParseExceptions.

Returns:

a List object.

indexOf

int indexOf(ICmdLineArg<?> arg)

indexOf.

Parameters:

arg - a ICmdLineArg object.

Returns:

a int.

parse

Object parse(IParserInput cmd)
      throws IOException,
             ParseException

parse.

Parameters:

cmd - a IParserInput object.

Returns:

a Object object.

Throws:

IOException - if any.

ParseException - if any.

parse

Object parse(IParserInput cmd,
             Object target)
      throws IOException,
             ParseException

parse.

Parameters:

cmd - a IParserInput object.

target - a Object object.

Returns:

a Object object.

Throws:

IOException - if any.

ParseException - if any.

parse

Object parse(Object target,
             String... args)
      throws IOException,
             ParseException

parse.

Parameters:

target - a Object object.

args - a String object.

Returns:

a Object object.

Throws:

IOException - if any.

ParseException - if any.

parse

Object parse(String... args)
      throws IOException,
             ParseException

parse.

Parameters:

args - a String object.

Returns:

a Object object.

Throws:

IOException - if any.

ParseException - if any.

pull

void pull(Object variableSource)
   throws ParseException

pull.

Parameters:

variableSource - a Object object.

Throws:

ParseException - if any.

remove

void remove(ICmdLineArg<?> arg)

remove.

Parameters:

arg - a ICmdLineArg object.

remove

void remove(int argIndex)

remove.

Parameters:

argIndex - a int.

size

int size()

size.

Specified by:

size in interface ICmdLineArg<ICmdLine>

Returns:

a int.