com.codetaco.argument.type

Class BooleanCLA

java.lang.Object

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

com.codetaco.argument.type.BooleanCLA

All Implemented Interfaces:

ICmdLineArg<Boolean>, Cloneable

public class BooleanCLA
extends AbstractCLA<Boolean>

BooleanCLA 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
BooleanCLA() Constructor for BooleanCLA.

Method Summary

Modifier and Type	Method and Description
void	applyDefaults() applyDefaults.
Boolean	convert(String valueStr, boolean _caseSensitive, Object target) convert.
String	defaultInstanceClass() defaultInstanceClass.
void	exportCommandLine(StringBuilder out) exportCommandLine.
protected void	exportCommandLineData(StringBuilder out, int occ) exportCommandLineData.
void	exportNamespace(String prefix, StringBuilder out) exportNamespace.
protected void	exportNamespaceData(String prefix, StringBuilder out, int occ) exportNamespaceData.
void	exportXml(StringBuilder out) exportXml.
protected void	exportXmlData(StringBuilder out, int occ) exportXmlData.
String	genericClassName() genericClassName.
Boolean	getValue() getValue.
boolean	isRequiredValue() isRequiredValue.
ICmdLineArg<Boolean>	setDefaultValue(String defaultValue) setDefaultValue.
ICmdLineArg<Boolean>	setMultiple(boolean bool) setMultiple.
ICmdLineArg<Boolean>	setRequiredValue(boolean bool) setRequiredValue.
void	setValue(Boolean value) setValue.
void	setValue(int index, Boolean value) setValue.
void	setValue(List<Boolean> value) setValue.
boolean	supportsInList() supportsInList.

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

asDefinedType, asEnum, asEnumArray, clone, convert, createCamelCapVersionOfKeyword, createMetaphoneVersionOfKeyword, dontAllowCamelCaps, dontAllowMetaphone, exportCommandLine, exportNamespace, exportXml, getCamelCaps, getCriteria, getDefaultValues, getDelegateOrValue, getDelegateOrValue, getEnumClassName, getFactoryArgName, getFactoryMethodName, getFormat, getHelp, getInstanceClass, getKeychar, getKeyword, getMetaphone, getMultipleMax, getMultipleMin, getType, getUniqueId, 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, getValues, getVariable, hasValue, isCamelCapsAllowed, isCaseSensitive, isMetaphoneAllowed, isMultiple, isParsed, isPositional, isRequired, isSystemGenerated, reset, resetCriteria, salience, setCamelCapsAllowed, setCaseSensitive, setDefaultValues, setDefaultValues, setEnumCriteria, setEnumCriteriaAllowError, setFactoryArgName, setFactoryMethodName, setFormat, setHelp, setInstanceClass, setKeychar, setKeyword, setListCriteria, setMetaphoneAllowed, setMultiple, setMultiple, setObject, setParsed, setPositional, setRangeCriteria, setRegxCriteria, setRequired, setSystemGenerated, setType, setUniqueId, setValues, setVariable, size, supportsCamelCaps, supportsCaseSensitive, supportsDefaultValues, supportsExcludeArgs, supportsFactoryArgName, supportsFactoryMethod, supportsFormat, supportsHelp, supportsInstanceClass, supportsLongName, supportsMatches, 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

BooleanCLA

public BooleanCLA()

Constructor for BooleanCLA.

Method Detail

applyDefaults

public void applyDefaults()

applyDefaults.

Specified by:

applyDefaults in interface ICmdLineArg<Boolean>

Overrides:

applyDefaults in class AbstractCLA<Boolean>

convert

public Boolean convert(String valueStr,
                       boolean _caseSensitive,
                       Object target)
                throws ParseException

convert.

Specified by:

convert in interface ICmdLineArg<Boolean>

Specified by:

convert in class AbstractCLA<Boolean>

Parameters:

valueStr - a String object.

_caseSensitive - a boolean.

target - a Object object.

Returns:

a E object.

Throws:

ParseException - if any.

defaultInstanceClass

public String defaultInstanceClass()

defaultInstanceClass.

Specified by:

defaultInstanceClass in interface ICmdLineArg<Boolean>

Overrides:

defaultInstanceClass in class AbstractCLA<Boolean>

Returns:

a String object.

exportCommandLine

public void exportCommandLine(StringBuilder out)

exportCommandLine.

Specified by:

exportCommandLine in interface ICmdLineArg<Boolean>

Overrides:

exportCommandLine in class AbstractCLA<Boolean>

Parameters:

out - a StringBuilder object.

exportCommandLineData

protected void exportCommandLineData(StringBuilder out,
                                     int occ)

exportCommandLineData.

Specified by:

exportCommandLineData in class AbstractCLA<Boolean>

Parameters:

out - a StringBuilder object.

occ - a int.

exportNamespace

public void exportNamespace(String prefix,
                            StringBuilder out)

exportNamespace.

Specified by:

exportNamespace in interface ICmdLineArg<Boolean>

Overrides:

exportNamespace in class AbstractCLA<Boolean>

Parameters:

prefix - a String object.

out - a StringBuilder object.

exportNamespaceData

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

exportNamespaceData.

Specified by:

exportNamespaceData in class AbstractCLA<Boolean>

Parameters:

prefix - a String object.

out - a StringBuilder object.

occ - a int.

exportXml

public void exportXml(StringBuilder out)

exportXml.

Specified by:

exportXml in interface ICmdLineArg<Boolean>

Overrides:

exportXml in class AbstractCLA<Boolean>

Parameters:

out - a StringBuilder object.

exportXmlData

protected void exportXmlData(StringBuilder out,
                             int occ)

exportXmlData.

Specified by:

exportXmlData in class AbstractCLA<Boolean>

Parameters:

out - a StringBuilder object.

occ - a int.

genericClassName

public String genericClassName()

genericClassName.

Returns:

a String object.

getValue

public Boolean 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.

Specified by:

getValue in interface ICmdLineArg<Boolean>

Overrides:

getValue in class AbstractCLA<Boolean>

Returns:

a E object.

isRequiredValue

public boolean isRequiredValue()

isRequiredValue.

Specified by:

isRequiredValue in interface ICmdLineArg<Boolean>

Overrides:

isRequiredValue in class AbstractCLA<Boolean>

Returns:

a boolean.

setDefaultValue

public ICmdLineArg<Boolean> setDefaultValue(String defaultValue)
                                     throws ParseException,
                                            IOException

setDefaultValue.

Specified by:

setDefaultValue in interface ICmdLineArg<Boolean>

Overrides:

setDefaultValue in class AbstractCLA<Boolean>

Parameters:

defaultValue - a String object.

Returns:

a ICmdLineArg object.

Throws:

ParseException - if any.

IOException - if any.

setMultiple

public ICmdLineArg<Boolean> setMultiple(boolean bool)
                                 throws ParseException

setMultiple.

Specified by:

setMultiple in interface ICmdLineArg<Boolean>

Overrides:

setMultiple in class AbstractCLA<Boolean>

Parameters:

bool - a boolean.

Returns:

a ICmdLineArg object.

Throws:

ParseException - if any.

setRequiredValue

public ICmdLineArg<Boolean> setRequiredValue(boolean bool)
                                      throws ParseException

setRequiredValue.

Specified by:

setRequiredValue in interface ICmdLineArg<Boolean>

Overrides:

setRequiredValue in class AbstractCLA<Boolean>

Parameters:

bool - a boolean.

Returns:

a ICmdLineArg object.

Throws:

ParseException - if any.

setValue

public void setValue(Boolean value)

setValue.

Specified by:

setValue in interface ICmdLineArg<Boolean>

Overrides:

setValue in class AbstractCLA<Boolean>

Parameters:

value - a E object.

setValue

public void setValue(int index,
                     Boolean value)

setValue.

Specified by:

setValue in interface ICmdLineArg<Boolean>

Overrides:

setValue in class AbstractCLA<Boolean>

Parameters:

index - a int.

value - a E object.

setValue

public void setValue(List<Boolean> value)

setValue.

Overrides:

setValue in class AbstractCLA<Boolean>

Parameters:

value - a List object.

supportsInList

public boolean supportsInList()

supportsInList.

Specified by:

supportsInList in interface ICmdLineArg<Boolean>

Overrides:

supportsInList in class AbstractCLA<Boolean>

Returns:

a boolean.