public interface ICmdLineArg<E>
ICmdLineArg interface.
| Modifier and Type | Method and Description |
|---|---|
void |
applyDefaults()
applyDefaults.
|
void |
asDefinedType(StringBuilder sb)
asDefinedType.
|
Object |
asEnum(String name,
Object[] possibleConstants)
asEnum.
|
Object[] |
asEnumArray(String name,
Object[] possibleConstants)
asEnumArray.
|
ICmdLineArg<E> |
clone()
clone.
|
E |
convert(String valueStr)
convert.
|
E |
convert(String valueStr,
boolean caseSensitive,
Object target)
convert.
|
String |
defaultInstanceClass()
defaultInstanceClass.
|
void |
dontAllowCamelCaps()
dontAllowCamelCaps.
|
void |
exportCommandLine(File file)
exportCommandLine.
|
void |
exportCommandLine(StringBuilder str)
exportCommandLine.
|
void |
exportNamespace(File file)
exportNamespace.
|
void |
exportNamespace(String prefix,
StringBuilder str)
exportNamespace.
|
void |
exportXml(StringBuilder str)
exportXml.
|
void |
exportXml(String tag,
File file)
exportXml.
|
String |
genericClassName()
genericClassName.
|
String |
getCamelCaps()
getCamelCaps.
|
ICmdLineArgCriteria<?> |
getCriteria()
getCriteria.
|
List<E> |
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.
|
Object |
getMetaphone()
getMetaphone.
|
int |
getMultipleMax()
getMultipleMax.
|
int |
getMultipleMin()
getMultipleMin.
|
int |
getUniqueId()
getUniqueId.
|
E |
getValue()
getValue.
|
E |
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.
|
boolean |
hasValue()
hasValue.
|
boolean |
isCamelCapsAllowed()
isCamelCapsAllowed.
|
boolean |
isCaseSensitive()
isCaseSensitive.
|
boolean |
isMetaphoneAllowed()
isMetaphoneAllowed.
|
boolean |
isMultiple()
isMultiple.
|
boolean |
isParsed()
isParsed.
|
boolean |
isPositional()
isPositional.
|
boolean |
isRequired()
isRequired.
|
boolean |
isRequiredValue()
isRequiredValue.
|
boolean |
isSystemGenerated()
isSystemGenerated.
|
void |
reset()
reset.
|
ICmdLineArg<E> |
resetCriteria()
resetCriteria.
|
int |
salience(Token word)
salience.
|
ICmdLineArg<E> |
setCamelCapsAllowed(boolean bool)
setCamelCapsAllowed.
|
ICmdLineArg<E> |
setCaseSensitive(boolean bool)
setCaseSensitive.
|
ICmdLineArg<E> |
setDefaultValue(String defaultValue)
setDefaultValue.
|
ICmdLineArg<E> |
setEnumCriteria(String enumClassName)
setEnumCriteria.
|
ICmdLineArg<E> |
setEnumCriteriaAllowError(String enumClassName)
setEnumCriteriaAllowError.
|
ICmdLineArg<E> |
setFactoryArgName(String argName)
setFactoryArgName.
|
ICmdLineArg<E> |
setFactoryMethodName(String methodName)
setFactoryMethodName.
|
ICmdLineArg<E> |
setFormat(String format)
setFormat.
|
ICmdLineArg<E> |
setHelp(String p_helpString)
setHelp.
|
ICmdLineArg<E> |
setInstanceClass(String p_instanceClassString)
setInstanceClass.
|
ICmdLineArg<E> |
setKeychar(Character _keychar)
setKeychar.
|
ICmdLineArg<E> |
setKeyword(String _keyword)
setKeyword.
|
ICmdLineArg<E> |
setListCriteria(String[] values)
setListCriteria.
|
ICmdLineArg<E> |
setMetaphoneAllowed(boolean bool)
setMetaphoneAllowed.
|
ICmdLineArg<E> |
setMultiple(boolean bool)
setMultiple.
|
ICmdLineArg<E> |
setMultiple(int min)
setMultiple.
|
ICmdLineArg<E> |
setMultiple(int min,
int max)
setMultiple.
|
void |
setObject(Object value)
setObject.
|
ICmdLineArg<E> |
setParsed(boolean bool)
setParsed.
|
ICmdLineArg<E> |
setPositional(boolean bool)
setPositional.
|
ICmdLineArg<E> |
setRangeCriteria(String min,
String max)
setRangeCriteria.
|
ICmdLineArg<E> |
setRegxCriteria(String pattern)
setRegxCriteria.
|
ICmdLineArg<E> |
setRequired(boolean bool)
setRequired.
|
ICmdLineArg<E> |
setRequiredValue(boolean bool)
setRequiredValue.
|
ICmdLineArg<E> |
setSystemGenerated(boolean bool)
setSystemGenerated.
|
void |
setType(ClaType claType)
setType.
|
void |
setUniqueId(int i)
setUniqueId.
|
void |
setValue(E value)
setValue.
|
void |
setValue(int index,
E value)
setValue.
|
ICmdLineArg<E> |
setVariable(String p_variableString)
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.
|
void applyDefaults()
applyDefaults.
void asDefinedType(StringBuilder sb)
asDefinedType.
sb - a StringBuilder object.Object asEnum(String name, Object[] possibleConstants) throws ParseException
asEnum.
name - a String object.possibleConstants - an array of Object objects.Object object.ParseException - if any.Object[] asEnumArray(String name, Object[] possibleConstants) throws ParseException
asEnumArray.
name - a String object.possibleConstants - an array of Object objects.Object objects.ParseException - if any.ICmdLineArg<E> clone() throws CloneNotSupportedException
clone.
ICmdLineArg object.CloneNotSupportedException - if any.E convert(String valueStr) throws ParseException, IOException
convert.
valueStr - a String object.ParseException - if any.IOException - if any.E convert(String valueStr, boolean caseSensitive, Object target) throws ParseException, IOException
convert.
valueStr - a String object.caseSensitive - a boolean.target - a Object object.ParseException - if any.IOException - if any.void dontAllowCamelCaps()
dontAllowCamelCaps.
void exportCommandLine(File file) throws IOException
exportCommandLine.
file - a File object.IOException - if any.void exportCommandLine(StringBuilder str)
exportCommandLine.
str - a StringBuilder object.void exportNamespace(File file) throws IOException
exportNamespace.
file - a File object.IOException - if any.void exportNamespace(String prefix, StringBuilder str)
exportNamespace.
prefix - a String object.str - a StringBuilder object.void exportXml(String tag, File file) throws IOException
exportXml.
tag - a String object.file - a File object.IOException - if any.void exportXml(StringBuilder str)
exportXml.
str - a StringBuilder object.ICmdLineArgCriteria<?> getCriteria()
getCriteria.
ICmdLineArgCriteria
object.Object getDelegateOrValue(int occurrence)
getDelegateOrValue.
occurrence - a int.Object object.int getMultipleMax()
getMultipleMax.
int getMultipleMin()
getMultipleMin.
int getUniqueId()
getUniqueId.
E getValue()
getValue.
E getValue(int index)
getValue.
index - a int.byte[] getValueAsbyteArray()
throws ParseException
getValueAsbyteArray.
ParseException - if any.Byte[] getValueAsByteArray() throws ParseException
getValueAsByteArray.
Byte objects.ParseException - if any.Calendar[] getValueAsCalendarArray() throws ParseException
getValueAsCalendarArray.
Calendar objects.ParseException - if any.Character[] getValueAsCharacterArray() throws ParseException
getValueAsCharacterArray.
Character objects.ParseException - if any.char[] getValueAscharArray()
throws ParseException
getValueAscharArray.
ParseException - if any.Date[] getValueAsDateArray() throws ParseException
getValueAsDateArray.
Date objects.ParseException - if any.DateTimeFormatter getValueAsDateTimeFormatter() throws ParseException
getValueAsDateTimeFormatter.
DateTimeFormatter object.ParseException - if any.DateTimeFormatter[] getValueAsDateTimeFormatterArray() throws ParseException
getValueAsDateTimeFormatterArray.
DateTimeFormatter objects.ParseException - if any.double[] getValueAsdoubleArray()
throws ParseException
getValueAsdoubleArray.
ParseException - if any.Double[] getValueAsDoubleArray() throws ParseException
getValueAsDoubleArray.
Double objects.ParseException - if any.com.codetaco.algebrain.Equ getValueAsEquation()
throws ParseException
getValueAsEquation.
Equ object.ParseException - if any.com.codetaco.algebrain.Equ[] getValueAsEquationArray()
throws ParseException
getValueAsEquationArray.
Equ objects.ParseException - if any.File[] getValueAsFileArray() throws ParseException
getValueAsFileArray.
File objects.ParseException - if any.float[] getValueAsfloatArray()
throws ParseException
getValueAsfloatArray.
ParseException - if any.Float[] getValueAsFloatArray() throws ParseException
getValueAsFloatArray.
Float objects.ParseException - if any.int[] getValueAsintArray()
throws ParseException
getValueAsintArray.
ParseException - if any.Integer[] getValueAsIntegerArray() throws ParseException
getValueAsIntegerArray.
Integer objects.ParseException - if any.LocalDate[] getValueAsLocalDateArray() throws ParseException
getValueAsLocalDateArray.
LocalDate objects.ParseException - if any.LocalDateTime[] getValueAsLocalDateTimeArray() throws ParseException
getValueAsLocalDateTimeArray.
LocalDateTime objects.ParseException - if any.LocalTime[] getValueAsLocalTimeArray() throws ParseException
getValueAsLocalTimeArray.
LocalTime objects.ParseException - if any.long[] getValueAslongArray()
throws ParseException
getValueAslongArray.
ParseException - if any.Long[] getValueAsLongArray() throws ParseException
getValueAsLongArray.
Long objects.ParseException - if any.Pattern getValueAsPattern() throws ParseException
getValueAsPattern.
Pattern object.ParseException - if any.Pattern[] getValueAsPatternArray() throws ParseException
getValueAsPatternArray.
Pattern objects.ParseException - if any.SimpleDateFormat getValueAsSimpleDateFormat() throws ParseException
getValueAsSimpleDateFormat.
SimpleDateFormat object.ParseException - if any.SimpleDateFormat[] getValueAsSimpleDateFormatArray() throws ParseException
getValueAsSimpleDateFormatArray.
SimpleDateFormat objects.ParseException - if any.String[] getValueAsStringArray() throws ParseException
getValueAsStringArray.
String objects.ParseException - if any.boolean hasValue()
hasValue.
boolean isCamelCapsAllowed()
isCamelCapsAllowed.
boolean isCaseSensitive()
isCaseSensitive.
boolean isMetaphoneAllowed()
isMetaphoneAllowed.
boolean isMultiple()
isMultiple.
boolean isParsed()
isParsed.
boolean isPositional()
isPositional.
boolean isRequired()
isRequired.
boolean isRequiredValue()
isRequiredValue.
boolean isSystemGenerated()
isSystemGenerated.
void reset()
reset.
ICmdLineArg<E> resetCriteria()
resetCriteria.
ICmdLineArg object.ICmdLineArg<E> setCamelCapsAllowed(boolean bool)
setCamelCapsAllowed.
bool - a boolean.ICmdLineArg object.ICmdLineArg<E> setCaseSensitive(boolean bool)
setCaseSensitive.
bool - a boolean.ICmdLineArg object.ICmdLineArg<E> setDefaultValue(String defaultValue) throws ParseException, IOException
setDefaultValue.
defaultValue - a String object.ICmdLineArg object.ParseException - if any.IOException - if any.ICmdLineArg<E> setEnumCriteria(String enumClassName) throws ParseException, IOException
setEnumCriteria.
enumClassName - a String object.ICmdLineArg object.ParseException - if any.IOException - if any.ICmdLineArg<E> setEnumCriteriaAllowError(String enumClassName)
setEnumCriteriaAllowError.
enumClassName - a String object.ICmdLineArg object.ICmdLineArg<E> setFactoryArgName(String argName)
setFactoryArgName.
argName - a String object.ICmdLineArg object.ICmdLineArg<E> setFactoryMethodName(String methodName) throws ParseException
setFactoryMethodName.
methodName - a String object.ICmdLineArg object.ParseException - if any.ICmdLineArg<E> setFormat(String format) throws ParseException
setFormat.
format - a String object.ICmdLineArg object.ParseException - if any.ICmdLineArg<E> setHelp(String p_helpString)
setHelp.
p_helpString - a String object.ICmdLineArg object.ICmdLineArg<E> setInstanceClass(String p_instanceClassString) throws ParseException
setInstanceClass.
p_instanceClassString - a String object.ICmdLineArg object.ParseException - if any.ICmdLineArg<E> setKeychar(Character _keychar)
setKeychar.
_keychar - a Character object.ICmdLineArg object.ICmdLineArg<E> setKeyword(String _keyword)
setKeyword.
_keyword - a String object.ICmdLineArg object.ICmdLineArg<E> setListCriteria(String[] values) throws ParseException, IOException
setListCriteria.
values - an array of String objects.ICmdLineArg object.ParseException - if any.IOException - if any.ICmdLineArg<E> setMetaphoneAllowed(boolean bool)
setMetaphoneAllowed.
bool - a boolean.ICmdLineArg object.ICmdLineArg<E> setMultiple(boolean bool) throws ParseException
setMultiple.
bool - a boolean.ICmdLineArg object.ParseException - if any.ICmdLineArg<E> setMultiple(int min) throws ParseException
setMultiple.
min - a int.ICmdLineArg object.ParseException - if any.ICmdLineArg<E> setMultiple(int min, int max) throws ParseException
setMultiple.
min - a int.max - a int.ICmdLineArg object.ParseException - if any.ICmdLineArg<E> setParsed(boolean bool)
setParsed.
bool - a boolean.ICmdLineArg object.ICmdLineArg<E> setPositional(boolean bool)
setPositional.
bool - a boolean.ICmdLineArg object.ICmdLineArg<E> setRangeCriteria(String min, String max) throws ParseException, IOException
setRangeCriteria.
min - a String object.max - a String object.ICmdLineArg object.ParseException - if any.IOException - if any.ICmdLineArg<E> setRegxCriteria(String pattern) throws ParseException
setRegxCriteria.
pattern - a String object.ICmdLineArg object.ParseException - if any.ICmdLineArg<E> setRequired(boolean bool)
setRequired.
bool - a boolean.ICmdLineArg object.ICmdLineArg<E> setRequiredValue(boolean bool) throws ParseException
setRequiredValue.
bool - a boolean.ICmdLineArg object.ParseException - if any.ICmdLineArg<E> setSystemGenerated(boolean bool) throws ParseException
setSystemGenerated.
bool - a boolean.ICmdLineArg object.ParseException - if any.void setUniqueId(int i)
setUniqueId.
i - a int.void setValue(E value)
setValue.
value - a E object.void setValue(int index,
E value)
setValue.
index - a int.value - a E object.ICmdLineArg<E> setVariable(String p_variableString)
setVariable.
p_variableString - a String object.ICmdLineArg object.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.