snaq.util.jclap

Class BooleanOption

java.lang.Object

snaq.util.jclap.Option<Boolean>

snaq.util.jclap.BooleanOption

public final class BooleanOption
extends Option<Boolean>

Implementation of an Option with value of type Boolean (otherwise known as a "flag").

Author:

Giles Winstanley

Field Summary

Fields

Modifier and Type	Field and Description
protected static String[]	sFalse
protected static String[]	sTrue

Fields inherited from class snaq.util.jclap.Option

bundle, ILLEGAL_SN_CHARS, locale, MAX_COUNT_LIMIT, MIN_COUNT_LIMIT, values

Constructor Summary

Constructors

Constructor and Description
BooleanOption(String shortName, String longName, String description, boolean allowMany) Creates a new BooleanOption instance.
BooleanOption(String shortName, String longName, String description, int minCount, int maxCount) Creates a new BooleanOption instance.

Method Summary

Methods

Modifier and Type	Method and Description
Class<Boolean>	getType() Returns the class type of value this option can take.
protected String	getUsageTypeString() Returns the option type, for display in the usage message.
protected Boolean	parseValue(String arg) Parsing of a flag option makes little sense.

Methods inherited from class snaq.util.jclap.Option

addValue, equals, getDescription, getLongName, getMaxCount, getMinCount, getShortName, getValues, hashCode, isAllowMany, isHidden, isMandatory, requiresValue, setHidden, setMinMaxCounts, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

sTrue

protected static final String[] sTrue

sFalse

protected static final String[] sFalse

Constructor Detail

BooleanOption

public BooleanOption(String shortName,
             String longName,
             String description,
             int minCount,
             int maxCount)

Creates a new BooleanOption instance.

Parameters:

shortName - short name of the option (e.g. -?)

longName - long name of the option (e.g. --help)

description - helpful description of the option (printed for usage message)

minCount - minimum number of occurrences required for this option

maxCount - maximum number of occurrences required for this option

BooleanOption

public BooleanOption(String shortName,
             String longName,
             String description,
             boolean allowMany)

Creates a new BooleanOption instance.

Parameters:

shortName - short name of the option (e.g. -?)

longName - long name of the option (e.g. --help)

description - helpful description of the option (printed for usage message)

allowMany - whether this option can take more than one value (i.e. be specified more than once)

Method Detail

parseValue

protected Boolean parseValue(String arg)
                      throws OptionException

Parsing of a flag option makes little sense. Possible argument for case of -f=true / --flag=1 / etc.

Specified by:

parseValue in class Option<Boolean>

Parameters:

arg - string argument from which a value is to be parsed

Returns:

Value of the parsed argument string

Throws:

OptionException - if a problem occurs while parsing the argument string

getType

public Class<Boolean> getType()

Description copied from class: Option

Returns the class type of value this option can take.

Specified by:

getType in class Option<Boolean>

getUsageTypeString

protected String getUsageTypeString()

Description copied from class: Option

Returns the option type, for display in the usage message. This may be overridden by sub-classes to provide a more meaningful type. By default this returns an appropriate type for the primitives, and string type for all others.

Overrides:

getUsageTypeString in class Option<Boolean>