Option (JCLAP 1.4 API)

java.lang.Object
- snaq.util.jclap.Option<E>

Type Parameters:

E - the return type of the option

Direct Known Subclasses:

BooleanOption, DoubleOption, EnumeratedOption, FloatOption, IntegerOption, LocalDateOption, LongOption, StringOption
```
public abstract class Option<E>
extends Object
```
Base implementation of a command-line option.

Author:

Giles Winstanley

Field Summary

Fields
Modifier and Type	Field and Description
`protected static ResourceBundle`	`bundle` Resources for internationalization.
`protected static String`	`ILLEGAL_SN_CHARS` String denoting illegal characters for short name.
`protected static Locale`	`locale` `Locale` for help/error display.
`protected static int`	`MAX_COUNT_LIMIT` Limit to maximum number of occurrences required for this option (set to an arbitrary 100).
`protected static int`	`MIN_COUNT_LIMIT` Limit to minimum number of occurrences required for this option.
`protected List<E>`	`values` List of values for this option.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Option(String shortName, String longName, String description, boolean requiresValue, boolean mandatory, boolean allowMany)` Creates a new `Option` instance.
`protected`	`Option(String shortName, String longName, String description, boolean requiresValue, int minCount, int maxCount)` Creates a new `Option` instance.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addValue(E value)` Adds the specified value to the list of those parsed.
`boolean`	`equals(Object obj)`
`String`	`getDescription()` Returns the description text of this Option.
`String`	`getLongName()` Returns the long name of this option.
`int`	`getMaxCount()` Returns the maximum value count for this option.
`int`	`getMinCount()` Returns the minimum value count for this option.
`String`	`getShortName()` Returns the short name of this option.
`abstract Class<E>`	`getType()` Returns the class type of value this option can take.
`protected String`	`getUsageTypeString()` Returns the option type, for display in the usage message.
`List<E>`	`getValues()` Returns the mapped value of the specified argument if it exists.
`int`	`hashCode()`
`boolean`	`isAllowMany()` Returns whether this option allows multiple values to be set.
`boolean`	`isHidden()` Returns whether this option is hidden from the usage message.
`boolean`	`isMandatory()` Returns whether this option is mandatory.
`protected abstract E`	`parseValue(String arg)` Parses the argument string for an option value.
`boolean`	`requiresValue()` Returns whether this option requires a value.
`Option<E>`	`setHidden()` Sets the flag to hide this option from the usage message.
`void`	`setMinMaxCounts(int minCount, int maxCount)` Sets the minimum/maximum value counts for this option.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ILLEGAL_SN_CHARS
```
protected static final String ILLEGAL_SN_CHARS
```
    String denoting illegal characters for short name.
    
    See Also:
    
    Constant Field Values
  - MIN_COUNT_LIMIT
```
protected static final int MIN_COUNT_LIMIT
```
    Limit to minimum number of occurrences required for this option.
    
    See Also:
    
    Constant Field Values
  - MAX_COUNT_LIMIT
```
protected static final int MAX_COUNT_LIMIT
```
    Limit to maximum number of occurrences required for this option (set to an arbitrary 100).
    
    See Also:
    
    Constant Field Values
  - locale
```
protected static final Locale locale
```
    Locale for help/error display.
  - bundle
```
protected static final ResourceBundle bundle
```
    Resources for internationalization.
  - values
```
protected List<E> values
```
    List of values for this option.
- Constructor Detail
  - Option
```
protected Option(String shortName,
                 String longName,
                 String description,
                 boolean requiresValue,
                 int minCount,
                 int maxCount)
```
    Creates a new Option instance.
    
    Parameters:
    
    shortName - short name of the option (must be non-null; e.g. -?)
    
    longName - long name of the option (e.g. --help)
    
    description - helpful description of the option (printed for usage message)
    
    requiresValue - whether this option requires a subsequently-specified value
    
    minCount - minimum number of occurrences required for this option
    
    maxCount - maximum number of occurrences required for this option
  - Option
```
protected Option(String shortName,
                 String longName,
                 String description,
                 boolean requiresValue,
                 boolean mandatory,
                 boolean allowMany)
```
    Creates a new Option instance.
    
    Parameters:
    
    shortName - short name of the option (must be non-null; e.g. -?)
    
    longName - long name of the option (e.g. --help)
    
    description - helpful description of the option (printed for usage message)
    
    requiresValue - whether this option requires a subsequently-specified value
    
    mandatory - whether this option must be specified
    
    allowMany - whether this option can take more than one value (i.e. be specified more than once)
- Method Detail
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getType
```
public abstract Class<E> getType()
```
    Returns the class type of value this option can take.
    
    Returns:
    
    Class instance
  - getUsageTypeString
```
protected String getUsageTypeString()
```
    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.
    
    Returns:
    
    string describing type
  - getValues
```
public List<E> getValues()
```
    Returns the mapped value of the specified argument if it exists.
    
    Returns:
    
    list of parsed values
  - addValue
```
protected void addValue(E value)
                 throws OptionException
```
    Adds the specified value to the list of those parsed.
    
    Parameters:
    
    value - the value to add to this option
    
    Throws:
    
    OptionException - if a single-value option already has a value
  - parseValue
```
protected abstract E parseValue(String arg)
                         throws OptionException
```
    Parses the argument string for an option value. (e.g. Converts "123" to an Integer instance representing 123).
    
    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
  - getShortName
```
public String getShortName()
```
    Returns the short name of this option.
    
    Returns:
    
    string
  - getLongName
```
public String getLongName()
```
    Returns the long name of this option.
    
    Returns:
    
    string
  - getDescription
```
public String getDescription()
```
    Returns the description text of this Option.
    
    Returns:
    
    string
  - requiresValue
```
public boolean requiresValue()
```
    Returns whether this option requires a value.
    
    Returns:
    
    boolean
  - getMinCount
```
public int getMinCount()
```
    Returns the minimum value count for this option.
    
    Returns:
    
    integer
  - getMaxCount
```
public int getMaxCount()
```
    Returns the maximum value count for this option.
    
    Returns:
    
    integer
  - isMandatory
```
public boolean isMandatory()
```
    Returns whether this option is mandatory.
    
    Returns:
    
    boolean
  - isAllowMany
```
public boolean isAllowMany()
```
    Returns whether this option allows multiple values to be set.
    
    Returns:
    
    boolean
  - setMinMaxCounts
```
public void setMinMaxCounts(int minCount,
                            int maxCount)
```
    Sets the minimum/maximum value counts for this option.
    
    Parameters:
    
    minCount - minimum count for the option
    
    maxCount - maximum count for the option
  - setHidden
```
public Option<E> setHidden()
```
    Sets the flag to hide this option from the usage message.
    
    Returns:
    
    reference to option
  - isHidden
```
public boolean isHidden()
```
    Returns whether this option is hidden from the usage message.
    
    Returns:
    
    boolean

Class Option<E>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ILLEGAL_SN_CHARS

MIN_COUNT_LIMIT

MAX_COUNT_LIMIT

locale

bundle

values

Constructor Detail

Option

Option

Method Detail

equals

hashCode

toString

getType

getUsageTypeString

getValues

addValue

parseValue

getShortName

getLongName

getDescription

requiresValue

getMinCount

getMaxCount

isMandatory

isAllowMany

setMinMaxCounts

setHidden

isHidden