E - public abstract class AbstractCLA<E> extends Object implements ICmdLineArg<E>, Cloneable
Abstract AbstractCLA class.
| Modifier and Type | Field and Description |
|---|---|
protected String |
camelCaps |
protected boolean |
camelCapsAllowed |
protected boolean |
caseSensitive |
protected ICmdLineArgCriteria<?> |
criteria |
protected List<E> |
defaultValues |
protected String |
enumClassName |
protected String |
factoryArgName |
protected String |
factoryMethodName |
protected String |
format |
protected String |
help |
protected String |
instanceClass |
protected Character |
keychar |
protected String |
keyword |
protected String |
metaphone |
protected boolean |
metaphoneAllowed |
protected boolean |
multiple |
protected int |
multipleMax |
protected int |
multipleMin |
static String |
newline
Constant
newline="System.getProperty(line.separator)" |
protected boolean |
parsed |
protected boolean |
positional |
protected boolean |
required |
protected boolean |
requiredValue |
protected boolean |
systemGenerated |
protected ClaType |
type |
protected int |
uniqueId
Set when this argument is created in the factory.
|
protected List<E> |
values |
protected String |
variable |
| Constructor and Description |
|---|
AbstractCLA() |
| Modifier and Type | Method and Description |
|---|---|
void |
applyDefaults()
applyDefaults.
|
void |
asDefinedType(StringBuilder sb)
asDefinedType.
|
Object |
asEnum(String name,
Object[] possibleConstants)
asEnum.
|
Enum<?>[] |
asEnumArray(String _name,
Object[] _possibleConstants)
asEnumArray.
|
ICmdLineArg<E> |
clone()
clone.
|
E |
convert(String valueStr)
convert.
|
abstract E |
convert(String valueStr,
boolean _caseSensitive,
Object target)
convert.
|
static String |
createCamelCapVersionOfKeyword(String _keyword)
createCamelCapVersionOfKeyword.
|
static String |
createMetaphoneVersionOfKeyword(String _keyword)
createMetaphoneVersionOfKeyword.
|
String |
defaultInstanceClass()
defaultInstanceClass.
|
void |
dontAllowCamelCaps()
dontAllowCamelCaps.
|
void |
dontAllowMetaphone()
dontAllowMetaphone.
|
void |
exportCommandLine(File file)
exportCommandLine.
|
void |
exportCommandLine(StringBuilder out)
exportCommandLine.
|
protected abstract void |
exportCommandLineData(StringBuilder str,
int occ)
exportCommandLineData.
|
void |
exportNamespace(File file)
exportNamespace.
|
void |
exportNamespace(String prefix,
StringBuilder out)
exportNamespace.
|
protected abstract void |
exportNamespaceData(String prefix,
StringBuilder str,
int occ)
exportNamespaceData.
|
void |
exportXml(StringBuilder out)
exportXml.
|
void |
exportXml(String tag,
File file)
exportXml.
|
protected abstract void |
exportXmlData(StringBuilder str,
int occ)
exportXmlData.
|
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.
|
String |
getMetaphone()
getMetaphone.
|
int |
getMultipleMax()
getMultipleMax.
|
int |
getMultipleMin()
getMultipleMin.
|
ClaType |
getType()
Getter for the field
type. |
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.
|
List<E> |
getValues()
Getter for the field
values. |
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 token)
salience.
|
ICmdLineArg<E> |
setCamelCapsAllowed(boolean allowed)
setCamelCapsAllowed.
|
ICmdLineArg<E> |
setCaseSensitive(boolean _caseSensitive)
setCaseSensitive.
|
ICmdLineArg<E> |
setDefaultValue(String defaultValue)
setDefaultValue.
|
protected void |
setDefaultValues(List<E> _defaultValues)
Setter for the field
defaultValues. |
ICmdLineArg<E> |
setDefaultValues(String[] defaults)
Setter for the field
defaultValues. |
ICmdLineArg<E> |
setEnumCriteria(String _enumClassName)
setEnumCriteria.
|
ICmdLineArg<E> |
setEnumCriteriaAllowError(String _enumClassName)
setEnumCriteriaAllowError.
|
ICmdLineArg<E> |
setFactoryArgName(String _factoryArgName)
setFactoryArgName.
|
ICmdLineArg<E> |
setFactoryMethodName(String instantiatorName)
setFactoryMethodName.
|
ICmdLineArg<E> |
setFormat(String _format)
setFormat.
|
ICmdLineArg<E> |
setHelp(String helpString)
setHelp.
|
ICmdLineArg<E> |
setInstanceClass(String _instanceClass)
setInstanceClass.
|
ICmdLineArg<E> |
setKeychar(Character _keychar)
setKeychar.
|
ICmdLineArg<E> |
setKeyword(String _keyword)
setKeyword.
|
ICmdLineArg<E> |
setListCriteria(String[] arrayOfValidValues)
setListCriteria.
|
ICmdLineArg<E> |
setMetaphoneAllowed(boolean allowed)
setMetaphoneAllowed.
|
ICmdLineArg<E> |
setMultiple(boolean bool)
setMultiple.
|
ICmdLineArg<E> |
setMultiple(int _multipleMin)
setMultiple.
|
ICmdLineArg<E> |
setMultiple(int _multipleMin,
int _multipleMax)
setMultiple.
|
void |
setObject(Object valueAsObject)
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 _systemGenerated)
setSystemGenerated.
|
void |
setType(ClaType claType)
setType.
|
void |
setUniqueId(int uniqueId)
setUniqueId.
|
void |
setValue(E value)
setValue.
|
void |
setValue(int index,
E value)
setValue.
|
void |
setValue(List<E> value)
setValue.
|
protected void |
setValues(List<E> _values)
Setter for the field
values. |
ICmdLineArg<E> |
setVariable(String _variable)
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.
|
String |
toString() |
static void |
uncompileQuoter(StringBuilder out,
String value)
uncompileQuoter.
|
void |
useDefaults()
useDefaults.
|
protected void |
xmlEncode(String in,
StringBuilder builder)
xmlEncode.
|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgenericClassNamepublic static String newline
newline="System.getProperty(line.separator)"protected int uniqueId
protected ClaType type
protected String help
protected Character keychar
protected String keyword
protected String camelCaps
protected boolean camelCapsAllowed
protected String metaphone
protected boolean metaphoneAllowed
protected String variable
protected String instanceClass
protected String format
protected String factoryMethodName
protected String factoryArgName
protected boolean multiple
protected int multipleMin
protected int multipleMax
protected boolean parsed
protected boolean positional
protected boolean caseSensitive
protected boolean required
protected boolean requiredValue
protected boolean systemGenerated
protected String enumClassName
protected ICmdLineArgCriteria<?> criteria
public static String createCamelCapVersionOfKeyword(String _keyword)
createCamelCapVersionOfKeyword.
public static String createMetaphoneVersionOfKeyword(String _keyword)
createMetaphoneVersionOfKeyword.
public static void uncompileQuoter(StringBuilder out, String value)
uncompileQuoter.
out - a StringBuilder object.value - a String object.public void applyDefaults()
applyDefaults.
applyDefaults in interface ICmdLineArg<E>public final void asDefinedType(StringBuilder sb)
asDefinedType.
asDefinedType in interface ICmdLineArg<E>sb - a StringBuilder object.public Object asEnum(String name, Object[] possibleConstants) throws ParseException
asEnum.
asEnum in interface ICmdLineArg<E>name - a String object.possibleConstants - an array of Object objects.Object object.ParseException - if any.public Enum<?>[] asEnumArray(String _name, Object[] _possibleConstants) throws ParseException
asEnumArray.
asEnumArray in interface ICmdLineArg<E>_name - a String object._possibleConstants - an array of Object objects.Object objects.ParseException - if any.public ICmdLineArg<E> clone() throws CloneNotSupportedException
clone.
clone in interface ICmdLineArg<E>clone in class ObjectICmdLineArg object.CloneNotSupportedException - if any.public E convert(String valueStr) throws ParseException, IOException
convert.
convert in interface ICmdLineArg<E>valueStr - a String object.ParseException - if any.IOException - if any.public abstract E convert(String valueStr, boolean _caseSensitive, Object target) throws ParseException, IOException
convert.
convert in interface ICmdLineArg<E>valueStr - a String object._caseSensitive - a boolean.target - a Object object.ParseException - if any.IOException - if any.public String defaultInstanceClass()
defaultInstanceClass.
defaultInstanceClass in interface ICmdLineArg<E>String object.public void dontAllowCamelCaps()
dontAllowCamelCaps.
dontAllowCamelCaps in interface ICmdLineArg<E>public void dontAllowMetaphone()
dontAllowMetaphone.
public void exportCommandLine(File file)
exportCommandLine.
exportCommandLine in interface ICmdLineArg<E>file - a File object.public void exportCommandLine(StringBuilder out)
exportCommandLine.
exportCommandLine in interface ICmdLineArg<E>out - a StringBuilder object.protected abstract void exportCommandLineData(StringBuilder str, int occ)
exportCommandLineData.
str - a StringBuilder object.occ - a int.public void exportNamespace(File file)
exportNamespace.
exportNamespace in interface ICmdLineArg<E>file - a File object.public void exportNamespace(String prefix, StringBuilder out)
exportNamespace.
exportNamespace in interface ICmdLineArg<E>prefix - a String object.out - a StringBuilder object.protected abstract void exportNamespaceData(String prefix, StringBuilder str, int occ)
exportNamespaceData.
prefix - a String object.str - a StringBuilder object.occ - a int.public void exportXml(String tag, File file)
exportXml.
exportXml in interface ICmdLineArg<E>tag - a String object.file - a File object.public void exportXml(StringBuilder out)
exportXml.
exportXml in interface ICmdLineArg<E>out - a StringBuilder object.protected abstract void exportXmlData(StringBuilder str, int occ)
exportXmlData.
str - a StringBuilder object.occ - a int.public String getCamelCaps()
getCamelCaps.
getCamelCaps in interface ICmdLineArg<E>String object.public ICmdLineArgCriteria<?> getCriteria()
getCriteria.
getCriteria in interface ICmdLineArg<E>ICmdLineArgCriteria
object.public List<E> getDefaultValues()
getDefaultValues.
getDefaultValues in interface ICmdLineArg<E>List object.public Object getDelegateOrValue()
getDelegateOrValue.
getDelegateOrValue in interface ICmdLineArg<E>Object object.public Object getDelegateOrValue(int occurrence)
getDelegateOrValue.
getDelegateOrValue in interface ICmdLineArg<E>occurrence - a int.Object object.public String getEnumClassName()
getEnumClassName.
getEnumClassName in interface ICmdLineArg<E>String object.public String getFactoryArgName()
getFactoryArgName.
getFactoryArgName in interface ICmdLineArg<E>String object.public String getFactoryMethodName()
getFactoryMethodName.
getFactoryMethodName in interface ICmdLineArg<E>String object.public String getFormat()
getFormat.
getFormat in interface ICmdLineArg<E>String object.public String getHelp()
getHelp.
getHelp in interface ICmdLineArg<E>String object.public String getInstanceClass()
getInstanceClass.
getInstanceClass in interface ICmdLineArg<E>String object.public Character getKeychar()
getKeychar.
getKeychar in interface ICmdLineArg<E>Character object.public String getKeyword()
getKeyword.
getKeyword in interface ICmdLineArg<E>String object.public String getMetaphone()
getMetaphone.
getMetaphone in interface ICmdLineArg<E>Object object.public int getMultipleMax()
getMultipleMax.
getMultipleMax in interface ICmdLineArg<E>public int getMultipleMin()
getMultipleMin.
getMultipleMin in interface ICmdLineArg<E>public int getUniqueId()
getUniqueId.
getUniqueId in interface ICmdLineArg<E>public E getValue()
getValue.
Return the last value in the list when only one is expected. And this method is for when only one value is expected. It is possible for the user to re-specify the same command on the input. That would build an array as if it were a multi-value argument. But since it is not, we return the last one specified.getValue in interface ICmdLineArg<E>public E getValue(int index)
getValue.
getValue in interface ICmdLineArg<E>index - a int.public byte[] getValueAsbyteArray()
throws ParseException
getValueAsbyteArray.
getValueAsbyteArray in interface ICmdLineArg<E>ParseException - if any.public Byte[] getValueAsByteArray() throws ParseException
getValueAsByteArray.
getValueAsByteArray in interface ICmdLineArg<E>Byte objects.ParseException - if any.public Calendar[] getValueAsCalendarArray() throws ParseException
getValueAsCalendarArray.
getValueAsCalendarArray in interface ICmdLineArg<E>Calendar objects.ParseException - if any.public Character[] getValueAsCharacterArray() throws ParseException
getValueAsCharacterArray.
getValueAsCharacterArray in interface ICmdLineArg<E>Character objects.ParseException - if any.public char[] getValueAscharArray()
throws ParseException
getValueAscharArray.
getValueAscharArray in interface ICmdLineArg<E>ParseException - if any.public Date[] getValueAsDateArray() throws ParseException
getValueAsDateArray.
getValueAsDateArray in interface ICmdLineArg<E>Date objects.ParseException - if any.public DateTimeFormatter getValueAsDateTimeFormatter() throws ParseException
getValueAsDateTimeFormatter.
getValueAsDateTimeFormatter in interface ICmdLineArg<E>DateTimeFormatter object.ParseException - if any.public DateTimeFormatter[] getValueAsDateTimeFormatterArray() throws ParseException
getValueAsDateTimeFormatterArray.
getValueAsDateTimeFormatterArray in interface ICmdLineArg<E>DateTimeFormatter objects.ParseException - if any.public double[] getValueAsdoubleArray()
throws ParseException
getValueAsdoubleArray.
getValueAsdoubleArray in interface ICmdLineArg<E>ParseException - if any.public Double[] getValueAsDoubleArray() throws ParseException
getValueAsDoubleArray.
getValueAsDoubleArray in interface ICmdLineArg<E>Double objects.ParseException - if any.public com.codetaco.algebrain.Equ getValueAsEquation()
throws ParseException
getValueAsEquation.
getValueAsEquation in interface ICmdLineArg<E>Equ object.ParseException - if any.public com.codetaco.algebrain.Equ[] getValueAsEquationArray()
throws ParseException
getValueAsEquationArray.
getValueAsEquationArray in interface ICmdLineArg<E>Equ objects.ParseException - if any.public File[] getValueAsFileArray() throws ParseException
getValueAsFileArray.
getValueAsFileArray in interface ICmdLineArg<E>File objects.ParseException - if any.public float[] getValueAsfloatArray()
throws ParseException
getValueAsfloatArray.
getValueAsfloatArray in interface ICmdLineArg<E>ParseException - if any.public Float[] getValueAsFloatArray() throws ParseException
getValueAsFloatArray.
getValueAsFloatArray in interface ICmdLineArg<E>Float objects.ParseException - if any.public int[] getValueAsintArray()
throws ParseException
getValueAsintArray.
getValueAsintArray in interface ICmdLineArg<E>ParseException - if any.public Integer[] getValueAsIntegerArray() throws ParseException
getValueAsIntegerArray.
getValueAsIntegerArray in interface ICmdLineArg<E>Integer objects.ParseException - if any.public LocalDate[] getValueAsLocalDateArray() throws ParseException
getValueAsLocalDateArray.
getValueAsLocalDateArray in interface ICmdLineArg<E>LocalDate objects.ParseException - if any.public LocalDateTime[] getValueAsLocalDateTimeArray() throws ParseException
getValueAsLocalDateTimeArray.
getValueAsLocalDateTimeArray in interface ICmdLineArg<E>LocalDateTime objects.ParseException - if any.public LocalTime[] getValueAsLocalTimeArray() throws ParseException
getValueAsLocalTimeArray.
getValueAsLocalTimeArray in interface ICmdLineArg<E>LocalTime objects.ParseException - if any.public long[] getValueAslongArray()
throws ParseException
getValueAslongArray.
getValueAslongArray in interface ICmdLineArg<E>ParseException - if any.public Long[] getValueAsLongArray() throws ParseException
getValueAsLongArray.
getValueAsLongArray in interface ICmdLineArg<E>Long objects.ParseException - if any.public Pattern getValueAsPattern() throws ParseException
getValueAsPattern.
getValueAsPattern in interface ICmdLineArg<E>Pattern object.ParseException - if any.public Pattern[] getValueAsPatternArray() throws ParseException
getValueAsPatternArray.
getValueAsPatternArray in interface ICmdLineArg<E>Pattern objects.ParseException - if any.public SimpleDateFormat getValueAsSimpleDateFormat() throws ParseException
getValueAsSimpleDateFormat.
getValueAsSimpleDateFormat in interface ICmdLineArg<E>SimpleDateFormat object.ParseException - if any.public SimpleDateFormat[] getValueAsSimpleDateFormatArray() throws ParseException
getValueAsSimpleDateFormatArray.
getValueAsSimpleDateFormatArray in interface ICmdLineArg<E>SimpleDateFormat objects.ParseException - if any.public String[] getValueAsStringArray() throws ParseException
getValueAsStringArray.
getValueAsStringArray in interface ICmdLineArg<E>String objects.ParseException - if any.public String getVariable()
getVariable.
getVariable in interface ICmdLineArg<E>String object.public boolean hasValue()
hasValue.
hasValue in interface ICmdLineArg<E>public boolean isCamelCapsAllowed()
isCamelCapsAllowed.
isCamelCapsAllowed in interface ICmdLineArg<E>public boolean isCaseSensitive()
isCaseSensitive.
isCaseSensitive in interface ICmdLineArg<E>public boolean isMetaphoneAllowed()
isMetaphoneAllowed.
isMetaphoneAllowed in interface ICmdLineArg<E>public boolean isMultiple()
isMultiple.
isMultiple in interface ICmdLineArg<E>public boolean isParsed()
isParsed.
isParsed in interface ICmdLineArg<E>public boolean isPositional()
isPositional.
isPositional in interface ICmdLineArg<E>public boolean isRequired()
isRequired.
isRequired in interface ICmdLineArg<E>public boolean isRequiredValue()
isRequiredValue.
isRequiredValue in interface ICmdLineArg<E>public boolean isSystemGenerated()
isSystemGenerated.
isSystemGenerated in interface ICmdLineArg<E>public void reset()
reset.
reset in interface ICmdLineArg<E>public ICmdLineArg<E> resetCriteria()
resetCriteria.
resetCriteria in interface ICmdLineArg<E>ICmdLineArg object.public int salience(Token token)
salience.
salience in interface ICmdLineArg<E>token - a Token object.public ICmdLineArg<E> setCamelCapsAllowed(boolean allowed)
setCamelCapsAllowed.
setCamelCapsAllowed in interface ICmdLineArg<E>allowed - a boolean.ICmdLineArg object.public ICmdLineArg<E> setCaseSensitive(boolean _caseSensitive)
setCaseSensitive.
setCaseSensitive in interface ICmdLineArg<E>_caseSensitive - a boolean.ICmdLineArg object.public ICmdLineArg<E> setDefaultValue(String defaultValue) throws ParseException, IOException
setDefaultValue.
setDefaultValue in interface ICmdLineArg<E>defaultValue - a String object.ICmdLineArg object.ParseException - if any.IOException - if any.protected void setDefaultValues(List<E> _defaultValues)
Setter for the field defaultValues.
_defaultValues - a List object.public ICmdLineArg<E> setDefaultValues(String[] defaults) throws ParseException, IOException
Setter for the field defaultValues.
defaults - an array of String objects.ICmdLineArg object.ParseException - if any.IOException - if any.public ICmdLineArg<E> setEnumCriteria(String _enumClassName) throws ParseException, IOException
setEnumCriteria.
setEnumCriteria in interface ICmdLineArg<E>_enumClassName - a String object.ICmdLineArg object.ParseException - if any.IOException - if any.public ICmdLineArg<E> setEnumCriteriaAllowError(String _enumClassName)
setEnumCriteriaAllowError.
setEnumCriteriaAllowError in interface ICmdLineArg<E>_enumClassName - a String object.ICmdLineArg object.public ICmdLineArg<E> setFactoryArgName(String _factoryArgName)
setFactoryArgName.
setFactoryArgName in interface ICmdLineArg<E>_factoryArgName - a String object.ICmdLineArg object.public ICmdLineArg<E> setFactoryMethodName(String instantiatorName) throws ParseException
setFactoryMethodName.
setFactoryMethodName in interface ICmdLineArg<E>instantiatorName - a String object.ICmdLineArg object.ParseException - if any.public ICmdLineArg<E> setFormat(String _format)
setFormat.
setFormat in interface ICmdLineArg<E>_format - a String object.ICmdLineArg object.public ICmdLineArg<E> setHelp(String helpString)
setHelp.
setHelp in interface ICmdLineArg<E>helpString - a String object.ICmdLineArg object.public ICmdLineArg<E> setInstanceClass(String _instanceClass) throws ParseException
setInstanceClass.
setInstanceClass in interface ICmdLineArg<E>_instanceClass - a String object.ICmdLineArg object.ParseException - if any.public ICmdLineArg<E> setKeychar(Character _keychar)
setKeychar.
setKeychar in interface ICmdLineArg<E>_keychar - a Character object.ICmdLineArg object.public ICmdLineArg<E> setKeyword(String _keyword)
setKeyword.
setKeyword in interface ICmdLineArg<E>_keyword - a String object.ICmdLineArg object.public ICmdLineArg<E> setListCriteria(String[] arrayOfValidValues) throws ParseException, IOException
setListCriteria.
setListCriteria in interface ICmdLineArg<E>arrayOfValidValues - an array of String objects.ICmdLineArg object.ParseException - if any.IOException - if any.public ICmdLineArg<E> setMetaphoneAllowed(boolean allowed)
setMetaphoneAllowed.
setMetaphoneAllowed in interface ICmdLineArg<E>allowed - a boolean.ICmdLineArg object.public ICmdLineArg<E> setMultiple(boolean bool) throws ParseException
setMultiple.
setMultiple in interface ICmdLineArg<E>bool - a boolean.ICmdLineArg object.ParseException - if any.public ICmdLineArg<E> setMultiple(int _multipleMin) throws ParseException
setMultiple.
setMultiple in interface ICmdLineArg<E>_multipleMin - a int.ICmdLineArg object.ParseException - if any.public ICmdLineArg<E> setMultiple(int _multipleMin, int _multipleMax) throws ParseException
setMultiple.
setMultiple in interface ICmdLineArg<E>_multipleMin - a int._multipleMax - a int.ICmdLineArg object.ParseException - if any.public void setObject(Object valueAsObject)
setObject.
setObject in interface ICmdLineArg<E>valueAsObject - a Object object.public ICmdLineArg<E> setParsed(boolean bool)
setParsed.
setParsed in interface ICmdLineArg<E>bool - a boolean.ICmdLineArg object.public ICmdLineArg<E> setPositional(boolean bool)
setPositional.
setPositional in interface ICmdLineArg<E>bool - a boolean.ICmdLineArg object.public ICmdLineArg<E> setRangeCriteria(String min, String max) throws ParseException, IOException
setRangeCriteria.
setRangeCriteria in interface ICmdLineArg<E>min - a String object.max - a String object.ICmdLineArg object.ParseException - if any.IOException - if any.public ICmdLineArg<E> setRegxCriteria(String pattern) throws ParseException
setRegxCriteria.
setRegxCriteria in interface ICmdLineArg<E>pattern - a String object.ICmdLineArg object.ParseException - if any.public ICmdLineArg<E> setRequired(boolean bool)
setRequired.
setRequired in interface ICmdLineArg<E>bool - a boolean.ICmdLineArg object.public ICmdLineArg<E> setRequiredValue(boolean bool) throws ParseException
setRequiredValue.
setRequiredValue in interface ICmdLineArg<E>bool - a boolean.ICmdLineArg object.ParseException - if any.public ICmdLineArg<E> setSystemGenerated(boolean _systemGenerated)
setSystemGenerated.
setSystemGenerated in interface ICmdLineArg<E>_systemGenerated - a boolean.ICmdLineArg object.public void setType(ClaType claType)
setType.
setType in interface ICmdLineArg<E>claType - a ClaType object.public void setUniqueId(int uniqueId)
setUniqueId.
setUniqueId in interface ICmdLineArg<E>uniqueId - a int.public void setValue(E value)
setValue.
setValue in interface ICmdLineArg<E>value - a E object.public void setValue(int index,
E value)
setValue.
setValue in interface ICmdLineArg<E>index - a int.value - a E object.protected void setValues(List<E> _values)
Setter for the field values.
_values - a List object.public ICmdLineArg<E> setVariable(String _variable)
setVariable.
setVariable in interface ICmdLineArg<E>_variable - a String object.ICmdLineArg object.public int size()
size.
size in interface ICmdLineArg<E>public boolean supportsCamelCaps()
supportsCamelCaps.
supportsCamelCaps in interface ICmdLineArg<E>public boolean supportsCaseSensitive()
supportsCaseSensitive.
supportsCaseSensitive in interface ICmdLineArg<E>public boolean supportsDefaultValues()
supportsDefaultValues.
supportsDefaultValues in interface ICmdLineArg<E>public boolean supportsExcludeArgs()
supportsExcludeArgs.
supportsExcludeArgs in interface ICmdLineArg<E>public boolean supportsFactoryArgName()
supportsFactoryArgName.
supportsFactoryArgName in interface ICmdLineArg<E>public boolean supportsFactoryMethod()
supportsFactoryMethod.
supportsFactoryMethod in interface ICmdLineArg<E>public boolean supportsFormat()
supportsFormat.
supportsFormat in interface ICmdLineArg<E>public boolean supportsHelp()
supportsHelp.
supportsHelp in interface ICmdLineArg<E>public boolean supportsInList()
supportsInList.
supportsInList in interface ICmdLineArg<E>public boolean supportsInstanceClass()
supportsInstanceClass.
supportsInstanceClass in interface ICmdLineArg<E>public boolean supportsLongName()
supportsLongName.
supportsLongName in interface ICmdLineArg<E>public boolean supportsMatches()
supportsMatches.
supportsMatches in interface ICmdLineArg<E>public boolean supportsMetaphone()
supportsMetaphone.
supportsMetaphone in interface ICmdLineArg<E>public boolean supportsMultimax()
supportsMultimax.
supportsMultimax in interface ICmdLineArg<E>public boolean supportsMultimin()
supportsMultimin.
supportsMultimin in interface ICmdLineArg<E>public boolean supportsPositional()
supportsPositional.
supportsPositional in interface ICmdLineArg<E>public boolean supportsRange()
supportsRange.
supportsRange in interface ICmdLineArg<E>public boolean supportsRequired()
supportsRequired.
supportsRequired in interface ICmdLineArg<E>public boolean supportsShortName()
supportsShortName.
supportsShortName in interface ICmdLineArg<E>public void useDefaults()
useDefaults.
useDefaults in interface ICmdLineArg<E>protected void xmlEncode(String in, StringBuilder builder)
xmlEncode.
in - a String object.builder - a StringBuilder object.