com.codetaco.argument.type

Class EnumCLA

java.lang.Object

com.codetaco.argument.type.AbstractCLA<String>

com.codetaco.argument.type.StringCLA

com.codetaco.argument.type.EnumCLA

All Implemented Interfaces:

ICmdLineArg<String>, Cloneable

public class EnumCLA
extends StringCLA

EnumCLA class.

Author:

Chris DeGreef fedupforone@gmail.com

Field Summary

Fields inherited from class com.codetaco.argument.type.AbstractCLA

camelCaps, camelCapsAllowed, caseSensitive, criteria, defaultValues, enumClassName, factoryArgName, factoryMethodName, format, help, instanceClass, keychar, keyword, metaphone, metaphoneAllowed, multiple, multipleMax, multipleMin, newline, parsed, positional, required, requiredValue, systemGenerated, type, uniqueId, values, variable

Constructor Summary

Constructors

Constructor and Description
EnumCLA()

Method Summary

Modifier and Type	Method and Description
Object	asEnum(String enumClassFieldName, Object[] possibleConstants) asEnum.
Enum<?>[]	asEnumArray(String enumClassFieldName, Object[] possibleConstants) asEnumArray.
String	convert(String valueStr, boolean _caseSensitive, Object target) convert.
String	defaultInstanceClass() defaultInstanceClass.
protected void	exportCommandLineData(StringBuilder out, int occ) exportCommandLineData.
protected void	exportNamespaceData(String prefix, StringBuilder out, int occ) exportNamespaceData.
protected void	exportXmlData(StringBuilder out, int occ) exportXmlData.
String	genericClassName() genericClassName.

Methods inherited from class com.codetaco.argument.type.StringCLA

getValueAsStringArray, supportsCaseSensitive, supportsInList, supportsMatches

Methods inherited from class com.codetaco.argument.type.AbstractCLA

applyDefaults, asDefinedType, clone, convert, createCamelCapVersionOfKeyword, createMetaphoneVersionOfKeyword, dontAllowCamelCaps, dontAllowMetaphone, exportCommandLine, exportCommandLine, exportNamespace, exportNamespace, exportXml, exportXml, getCamelCaps, getCriteria, getDefaultValues, getDelegateOrValue, getDelegateOrValue, getEnumClassName, getFactoryArgName, getFactoryMethodName, getFormat, getHelp, getInstanceClass, getKeychar, getKeyword, getMetaphone, getMultipleMax, getMultipleMin, getType, 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, getValues, getVariable, hasValue, isCamelCapsAllowed, isCaseSensitive, isMetaphoneAllowed, isMultiple, isParsed, isPositional, isRequired, isRequiredValue, isSystemGenerated, reset, resetCriteria, salience, setCamelCapsAllowed, setCaseSensitive, setDefaultValue, setDefaultValues, setDefaultValues, 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, setValue, setValues, setVariable, size, supportsCamelCaps, supportsDefaultValues, supportsExcludeArgs, supportsFactoryArgName, supportsFactoryMethod, supportsFormat, supportsHelp, supportsInstanceClass, supportsLongName, supportsMetaphone, supportsMultimax, supportsMultimin, supportsPositional, supportsRange, supportsRequired, supportsShortName, toString, uncompileQuoter, useDefaults, xmlEncode

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumCLA

public EnumCLA()

Method Detail

asEnum

public Object asEnum(String enumClassFieldName,
                     Object[] possibleConstants)
              throws ParseException

asEnum.

Specified by:

asEnum in interface ICmdLineArg<String>

Overrides:

asEnum in class AbstractCLA<String>

Parameters:

enumClassFieldName - a String object.

possibleConstants - an array of Object objects.

Returns:

a Object object.

Throws:

ParseException - if any.

asEnumArray

public Enum<?>[] asEnumArray(String enumClassFieldName,
                             Object[] possibleConstants)
                      throws ParseException

asEnumArray.

Specified by:

asEnumArray in interface ICmdLineArg<String>

Overrides:

asEnumArray in class AbstractCLA<String>

Parameters:

enumClassFieldName - a String object.

possibleConstants - an array of Object objects.

Returns:

an array of Object objects.

Throws:

ParseException - if any.

convert

public String convert(String valueStr,
                      boolean _caseSensitive,
                      Object target)

convert.

Specified by:

convert in interface ICmdLineArg<String>

Overrides:

convert in class StringCLA

Parameters:

valueStr - a String object.

_caseSensitive - a boolean.

target - a Object object.

Returns:

a E object.

defaultInstanceClass

public String defaultInstanceClass()

defaultInstanceClass.

Specified by:

defaultInstanceClass in interface ICmdLineArg<String>

Overrides:

defaultInstanceClass in class StringCLA

Returns:

a String object.

exportCommandLineData

protected void exportCommandLineData(StringBuilder out,
                                     int occ)

exportCommandLineData.

Overrides:

exportCommandLineData in class StringCLA

Parameters:

out - a StringBuilder object.

occ - a int.

exportNamespaceData

protected void exportNamespaceData(String prefix,
                                   StringBuilder out,
                                   int occ)

exportNamespaceData.

Overrides:

exportNamespaceData in class StringCLA

Parameters:

prefix - a String object.

out - a StringBuilder object.

occ - a int.

exportXmlData

protected void exportXmlData(StringBuilder out,
                             int occ)

exportXmlData.

Overrides:

exportXmlData in class StringCLA

Parameters:

out - a StringBuilder object.

occ - a int.

genericClassName

public String genericClassName()

genericClassName.

Specified by:

genericClassName in interface ICmdLineArg<String>

Overrides:

genericClassName in class StringCLA

Returns:

a String object.