com.martiansoftware.jsap

Class PropertyStringParser

java.lang.Object

com.martiansoftware.jsap.StringParser

com.martiansoftware.jsap.PropertyStringParser

Direct Known Subclasses:

DateStringParser, FileStringParser

public abstract class PropertyStringParser
extends StringParser

A StringParser subclass that provides a means for setting/getting properties. This is intended to support StringParsers that might requires some configuration, such as DateStringParser (which needs a format String).

Author:

Marty Lamb

See Also:

StringParser, DateStringParser

Constructor Summary

Constructors

Constructor and Description
PropertyStringParser()

Method Summary

Modifier and Type	Method and Description
String	getProperty(String key) Returns the property associated with the specified key, or null if no such property exists.
String	getProperty(String key, String defaultValue) Returns the property associated with the specified key, or the specified default value if no such property exists.
void	setProperty(String key, String value) Sets the property with the specified key to the specified value.

Methods inherited from class com.martiansoftware.jsap.StringParser

parse, setUp, tearDown

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyStringParser

public PropertyStringParser()

Method Detail

setProperty

public void setProperty(String key,
                        String value)

Sets the property with the specified key to the specified value.

Parameters:

key - the key of the property to set.

value - the value to associated with the specified key.

See Also:

Properties.setProperty(String,String)

getProperty

public String getProperty(String key)

Returns the property associated with the specified key, or null if no such property exists.

Parameters:

key - the key of the desired property

Returns:

the property associated with the specified key, or null if no such property exists.

getProperty

public String getProperty(String key,
                          String defaultValue)

Returns the property associated with the specified key, or the specified default value if no such property exists.

Parameters:

key - the key of the desired property

defaultValue - the default value to return if no such property exists

Returns:

the requested property, or the specified default value if no such property exists.