com.martiansoftware.jsap

Class StringParser

java.lang.Object

com.martiansoftware.jsap.StringParser

Direct Known Subclasses:

BigDecimalStringParser, BigIntegerStringParser, BooleanStringParser, ByteStringParser, CharacterStringParser, ClassStringParser, ColorStringParser, DoubleStringParser, EnumeratedStringParser, FloatStringParser, ForNameStringParser, InetAddressStringParser, IntegerStringParser, IntSizeStringParser, LongSizeStringParser, LongStringParser, PackageStringParser, PropertyStringParser, ShortStringParser, StringStringParser, URLStringParser

public abstract class StringParser
extends java.lang.Object

Class responsible for converting Strings into Objects. Each subclass of StringParser is capable of parsing a String into a different class of object. To extend JSAP to recognize new data types, a new StringParser must be created for the new type.

"List" options (such as your environment's PATH and CLASSPATH variables) that contain multiple values are split into individual value tokens prior to the calling of the StringParser's parse() method. For example, if you had a StringStringParser parsing your PATH environment variable, that StringStringParser's parse() method would be called once for each item in the list. As a result, each StringParser only needs to know how to create an object based upon a single, simple token.

Author:

Marty Lamb

Constructor Summary

Constructors

Constructor and Description
StringParser()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.Object	parse(java.lang.String arg) Parses the specified argument into an Object of the appropriate type.
void	setUp() Performs any initialization not handled by this StringParser's constructor.
void	tearDown() Performs any cleanup necessary for this StringParser.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringParser

public StringParser()

Method Detail

setUp

public void setUp()
           throws java.lang.Exception

Performs any initialization not handled by this StringParser's constructor. The contract for this method is that it will be called AT LEAST once before this object's parse() method is called.

In the JSAP API, this method is called every time an Option containing this StringParser is registered with a JSAP. If there is an initialization error, this method should throw a JSAPException to prevent the Option from being registered.

Throws:

java.lang.Exception - if an initialization error occurs that should prevent the Option containing this StringParser from being registered.

tearDown

public void tearDown()

Performs any cleanup necessary for this StringParser. The contract for this method is that it MAY be called at any time after the setUp method has been called. It may be called more than once.

In the JSAP API, this method is called every time an Option containing this StringParser is unregistered from a JSAP. During finalization, any registered Options are unregistered from a JSAP.

parse

public abstract java.lang.Object parse(java.lang.String arg)
                                throws ParseException

Parses the specified argument into an Object of the appropriate type. If the specified argument cannot be converted into the desired Object, a ParseException should be thrown.

Note: this method MAY BE CALLED with a null argument. Take this into consideration when subclassing!

Parameters:

arg - the argument to convert to an Object of class appropriate to the StringParser subclass.

Returns:

the Object resulting from the parsed argument.

Throws:

ParseException - if the specified argument cannot be parsed.