com.martiansoftware.jsap.stringparsers
Class EnumeratedStringParser

java.lang.Object
  com.martiansoftware.jsap.StringParser
      com.martiansoftware.jsap.stringparsers.EnumeratedStringParser

public class EnumeratedStringParser

extends StringParser

A StringParser that enforces a limited set of String options for its values. These values are provided in the constructor together with one or two parameters that control the processing of these values.

EnumeratedStringParser was generously contributed to JSAP by Klaus-Peter Berg of Siemens AG, Munich, Germany.

Since:

1.03

Version:

2.0

Author:

Klaus-Peter Berg, Siemens AG, Munich, Germany

Field Summary

static char

CONSTRUCTOR_VALUE_SEPARATOR char used to separate enumerated values when they are supplied to the constructor

Constructor Summary

EnumeratedStringParser(String validOptionValues)
Deprecated. use getParser(String).

EnumeratedStringParser(String validOptionValues, boolean caseSensitive)
Deprecated. use getParser(String, boolean).

EnumeratedStringParser(String validOptionValues, boolean caseSensitive, boolean checkOptionChars)
Deprecated. use getParser(String, boolean, boolean).

Method Summary

static EnumeratedStringParser	getParser(String validOptionValues) Returns an EnumeratedParameterParser with parameter "caseSensitive" set to false and "checkOptionChars" set to true.
static EnumeratedStringParser	getParser(String validOptionValues, boolean caseSensitive) Returns an EnumeratedParameterParser with parameter "checkOptionChars" set to true.
static EnumeratedStringParser	getParser(String validOptionValues, boolean caseSensitive, boolean checkOptionChars) Returns an EnumeratedParameterParser.
Object	parse(String arg) Parses the specified argument, making sure it matches one of the valid options supplied to its constructor.

Methods inherited from class com.martiansoftware.jsap.StringParser

setUp, tearDown

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONSTRUCTOR_VALUE_SEPARATOR

public static final char CONSTRUCTOR_VALUE_SEPARATOR

char used to separate enumerated values when they are supplied to the constructor

See Also:

Constant Field Values

Constructor Detail

EnumeratedStringParser

public EnumeratedStringParser(String validOptionValues,
                              boolean caseSensitive,
                              boolean checkOptionChars)
                       throws IllegalArgumentException

Deprecated. use getParser(String, boolean, boolean).

Constructs a new instance of EnumeratedParameterParser.

Parameters:

validOptionValues - a string that contains valid values for an option in the format "value_1;value_2;..;value_n"; spaces between values are allowed to make things more readable, e.g., "value_1; value_2"; option values have to be constructed using Java identifier characters if the checkOptionChars parameter tells the parser to do this.

caseSensitive - tells the parser whether the option value is case sensitive

checkOptionChars - tells the parser whether to check for Java identifier conformant characters.

Throws:

IllegalArgumentException - if the option value string has wrong format or is empty

EnumeratedStringParser

public EnumeratedStringParser(String validOptionValues,
                              boolean caseSensitive)
                       throws IllegalArgumentException

Deprecated. use getParser(String, boolean).

Constructs a new instance of EnumeratedStringParser.

EnumeratedStringParser

public EnumeratedStringParser(String validOptionValues)
                       throws IllegalArgumentException

Deprecated. use getParser(String).

Constructs a new instance of EnumeratedStringParser.

Method Detail

getParser

public static EnumeratedStringParser getParser(String validOptionValues,
                                               boolean caseSensitive,
                                               boolean checkOptionChars)
                                        throws IllegalArgumentException

Returns an EnumeratedParameterParser.

Parameters:

validOptionValues - a string that contains valid values for an option in the format "value_1;value_2;..;value_n"; spaces between values are allowed to make things more readable, e.g., "value_1; value_2"; option values have to be constructed using Java identifier characters if the checkOptionChars parameter tells the parser to do this.

caseSensitive - tells the parser whether the option value is case sensitive

checkOptionChars - tells the parser whether to check for Java identifier conformant characters.

Throws:

IllegalArgumentException - if the option value string has wrong format or is empty

getParser

public static EnumeratedStringParser getParser(String validOptionValues,
                                               boolean caseSensitive)
                                        throws IllegalArgumentException

Returns an EnumeratedParameterParser with parameter "checkOptionChars" set to true.

Parameters:

validOptionValues - a string that contains valid values for an option in the format "value_1;value_2;..;value_n"; spaces between values are allowed to make things more readable, e.g., "value_1; value_2"; option values have to be constructed using Java identifier characters.

caseSensitive - tells the parser wether the option value is case sensitive

Throws:

IllegalArgumentException - if the option value string has wrong format or is empty

getParser

public static EnumeratedStringParser getParser(String validOptionValues)
                                        throws IllegalArgumentException

Returns an EnumeratedParameterParser with parameter "caseSensitive" set to false and "checkOptionChars" set to true. All command line arguments for this parser and the values provided by the user in the returned parser are converted to lower case.

Parameters:

validOptionValues - a string that contains valid values for an option in the format "value_1;value_2;..;value_n"; spaces between values are allowed to make things more readable, e.g., "value_1; value_2"; option values have to be constructed using Java identifier characters.

Throws:

IllegalArgumentException - if the option value string has wrong format or is empty

parse

public Object parse(String arg)
             throws ParseException

Parses the specified argument, making sure it matches one of the valid options supplied to its constructor. If the specified argument is not a valid option, a ParseException is thrown.

Specified by:

parse in class StringParser

Parameters:

arg - the argument to parse

Returns:

the String resulting from the parsed argument.

Throws:

ParseException - if the specified argument cannot be parsed.