snaq.util.jclap
Class EnumeratedStringOption

java.lang.Object
  extended by snaq.util.jclap.Option<E>
      extended by snaq.util.jclap.EnumeratedOption<java.lang.String>
          extended by snaq.util.jclap.EnumeratedStringOption

public final class EnumeratedStringOption
extends EnumeratedOption<java.lang.String>

Implementation of an Option with value restricted to a specified enumeration of type String.

Author:
Giles Winstanley

Constructor Summary
EnumeratedStringOption(java.lang.String shortName, java.lang.String longName, java.lang.String description, boolean mandatory, boolean allowMany, java.util.Collection<java.lang.String> allowedValues, boolean ignoreCase)
          Creates a new EnumeratedStringOption instance.
EnumeratedStringOption(java.lang.String shortName, java.lang.String longName, java.lang.String description, int minCount, int maxCount, java.util.Collection<java.lang.String> allowedValues, boolean ignoreCase)
          Creates a new EnumeratedStringOption instance.
 
Method Summary
 java.lang.String getAllowedValuesString()
          Returns the default version of the string denoting the values that can be assigned to this option ()
 java.lang.Class<java.lang.String> getType()
          Returns the class type of value this option can take.
 
Methods inherited from class snaq.util.jclap.EnumeratedOption
getAllowedValues, getAllowedValuesString, getAllowedValuesString, isValueValid, toString
 
Methods inherited from class snaq.util.jclap.Option
equals, getDescription, getLongName, getMaxCount, getMinCount, getShortName, getValues, hashCode, isAllowMany, isHidden, isMandatory, requiresValue, setHidden, setMinMaxCounts
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

EnumeratedStringOption

public EnumeratedStringOption(java.lang.String shortName,
                              java.lang.String longName,
                              java.lang.String description,
                              int minCount,
                              int maxCount,
                              java.util.Collection<java.lang.String> allowedValues,
                              boolean ignoreCase)
Creates a new EnumeratedStringOption instance.

Parameters:
shortName - short name of the option (e.g. -t)
longName - long name of the option (e.g. --type)
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
allowedValues - collection of possible values this option can take
ignoreCase - whether to ignore the case in string evaluations

EnumeratedStringOption

public EnumeratedStringOption(java.lang.String shortName,
                              java.lang.String longName,
                              java.lang.String description,
                              boolean mandatory,
                              boolean allowMany,
                              java.util.Collection<java.lang.String> allowedValues,
                              boolean ignoreCase)
Creates a new EnumeratedStringOption instance.

Parameters:
shortName - short name of the option (e.g. -t)
longName - long name of the option (e.g. --type)
description - helpful description of the option (printed for usage message)
mandatory - whether this option must be specified
allowMany - whether this option can take more than one value (i.e. be specified more than once)
allowedValues - collection of possible values this option can take
ignoreCase - whether to ignore the case in string evaluations
Method Detail

getType

public java.lang.Class<java.lang.String> getType()
Description copied from class: Option
Returns the class type of value this option can take.

Specified by:
getType in class Option<java.lang.String>

getAllowedValuesString

public java.lang.String getAllowedValuesString()
Returns the default version of the string denoting the values that can be assigned to this option ()

Overrides:
getAllowedValuesString in class EnumeratedOption<java.lang.String>
Returns:
The default version of the string denoting the values that can be assigned to this option.