Class DateStringParser
java.lang.Object
com.martiansoftware.jsap.StringParser
com.martiansoftware.jsap.PropertyStringParser
com.martiansoftware.jsap.stringparsers.DateStringParser
A
StringParser
for parsing java.util.Date objects. By default, arguments
are parsed using the
java.text.SimpleDateFormat for the default locale. The format can be
overridden using this StringParser's
setProperties() method, supplying a java.util.Properties object with a
property key named "format".
The value associated with the "format" property is used to create a new
java.text.SimpleDateFormat
to parse the argument.
A ParseException is thrown if a SimpleDateFormat cannot be constructed with the specified format, or if the SimpleDateFormat throws a java.text.ParseException during parsing.
The SimpleDateFormat object is instantiated when an option referencing this DateStringParser is registered with a JSAP object.
- Author:
- Marty Lamb
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic DateStringParser
Returns aDateStringParser
.Parses the specified argument using either the java.text.SimpleDateFormat for the current locale (by default) or a java.text.SimpleDateFormat as defined by this PropertyStringParser's "format" property.void
setUp()
Instantiates the SimpleDateFormat to use for parsing.void
tearDown()
Destroys the SimpleDateFormat used for parsing.Methods inherited from class com.martiansoftware.jsap.PropertyStringParser
getProperty, getProperty, setProperty
-
Constructor Details
-
DateStringParser
public DateStringParser()Deprecated.UsegetParser()
.Creates a new DateStringParser.
-
-
Method Details
-
getParser
Returns aDateStringParser
.- Returns:
- a
DateStringParser
.
-
setUp
Instantiates the SimpleDateFormat to use for parsing.- Overrides:
setUp
in classStringParser
- Throws:
ParseException
- if a SimpleDateFormat cannot be instantiated with the contents of the "format" property.
-
tearDown
public void tearDown()Destroys the SimpleDateFormat used for parsing.- Overrides:
tearDown
in classStringParser
-
parse
Parses the specified argument using either the java.text.SimpleDateFormat for the current locale (by default) or a java.text.SimpleDateFormat as defined by this PropertyStringParser's "format" property. If the specified argument cannot be parsed by the current format, a ParseException is thrown.- Specified by:
parse
in classStringParser
- Parameters:
arg
- the argument to convert to a Date.- Returns:
- a Date as described above.
- Throws:
ParseException
- if the specified argument cannot be parsed by the current format..
-
getParser()
.