Class FastDateParser
- All Implemented Interfaces:
Serializable
,DateParser
SimpleDateFormat
.
To obtain a proxy to a FastDateParser, use FastDateFormat.getInstance(String, TimeZone, Locale)
or another variation of the factory methods of FastDateFormat
.
Since FastDateParser is thread safe, you can use a static member instance:
private static final DateParser DATE_PARSER = FastDateFormat.getInstance("yyyy-MM-dd");
This class can be used as a direct replacement for SimpleDateFormat
in most
parsing situations. This class is especially useful in multi-threaded server environments.
SimpleDateFormat
is not thread-safe in any JDK version, nor will it be as Sun has closed
the bug/RFE.
Only parsing is supported by this class, but all patterns are compatible with SimpleDateFormat.
The class operates in lenient mode, so for example a time of 90 minutes is treated as 1 hour 30 minutes.
Timing tests indicate this class is as about as fast as SimpleDateFormat in single thread applications and about 25% faster in multi-thread applications.
- Since:
- 3.2
- Version:
- $Id$
- See Also:
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
FastDateParser
(String pattern, TimeZone timeZone, Locale locale) Constructs a new FastDateParser.protected
FastDateParser
(String pattern, TimeZone timeZone, Locale locale, Date centuryStart) Constructs a new FastDateParser. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compare another object for equality with this object.Get the locale used by this parser.Get the pattern used by this parser.Get the time zone used by this parser.int
hashCode()
Return a hashcode compatible with equals.Equivalent to DateFormat.parse(String).parse
(String source, ParsePosition pos) This implementation updates the ParsePosition if the parse succeeds.parseObject
(String source) Parses text from a string to produce a Date.parseObject
(String source, ParsePosition pos) Parse a date/time string according to the given parse position.toString()
Get a string version of this formatter.
-
Constructor Details
-
FastDateParser
Constructs a new FastDateParser. UseFastDateFormat.getInstance(String, TimeZone, Locale)
or another variation of the factory methods ofFastDateFormat
to get a cached FastDateParser instance.- Parameters:
pattern
- non-nullSimpleDateFormat
compatible patterntimeZone
- non-null time zone to uselocale
- non-null locale
-
FastDateParser
Constructs a new FastDateParser.- Parameters:
pattern
- non-nullSimpleDateFormat
compatible patterntimeZone
- non-null time zone to uselocale
- non-null localecenturyStart
- The start of the century for 2 digit year parsing- Since:
- 3.3
-
-
Method Details
-
getPattern
Description copied from interface:DateParser
Get the pattern used by this parser.- Specified by:
getPattern
in interfaceDateParser
- Returns:
- the pattern,
SimpleDateFormat
compatible
-
getTimeZone
Description copied from interface:DateParser
Get the time zone used by this parser.The default
TimeZone
used to create aDate
when theTimeZone
is not specified by the format pattern.- Specified by:
getTimeZone
in interfaceDateParser
- Returns:
- the time zone
-
getLocale
Description copied from interface:DateParser
Get the locale used by this parser.- Specified by:
getLocale
in interfaceDateParser
- Returns:
- the locale
-
equals
Compare another object for equality with this object. -
hashCode
public int hashCode()Return a hashcode compatible with equals. -
toString
Get a string version of this formatter. -
parseObject
Description copied from interface:DateParser
Parses text from a string to produce a Date.- Specified by:
parseObject
in interfaceDateParser
- Parameters:
source
- AString
whose beginning should be parsed.- Returns:
- a
java.util.Date
object - Throws:
ParseException
- if the beginning of the specified string cannot be parsed.- See Also:
-
parse
Description copied from interface:DateParser
Equivalent to DateFormat.parse(String).See
DateFormat.parse(String)
for more information.- Specified by:
parse
in interfaceDateParser
- Parameters:
source
- AString
whose beginning should be parsed.- Returns:
- A
Date
parsed from the string - Throws:
ParseException
- if the beginning of the specified string cannot be parsed.
-
parseObject
Description copied from interface:DateParser
Parse a date/time string according to the given parse position.- Specified by:
parseObject
in interfaceDateParser
- Parameters:
source
- AString
whose beginning should be parsed.pos
- the parse position- Returns:
- a
java.util.Date
object - See Also:
-
parse
This implementation updates the ParsePosition if the parse succeeds. However, unlike the methodSimpleDateFormat.parse(String, ParsePosition)
it is not able to set the error Index - i.e.ParsePosition.getErrorIndex()
- if the parse fails.To determine if the parse has succeeded, the caller must check if the current parse position given by
ParsePosition.getIndex()
has been updated. If the input buffer has been fully parsed, then the index will point to just after the end of the input buffer.See org.apache.commons.lang3.time.DateParser#parse(java.lang.String, java.text.ParsePosition) Equivalent to DateFormat.parse(String, ParsePosition).
See
DateFormat.parse(String, ParsePosition)
for more information.- Specified by:
parse
in interfaceDateParser
- Parameters:
source
- AString
, part of which should be parsed.pos
- AParsePosition
object with index and error index information as described above.- Returns:
- A
Date
parsed from the string. In case of error, returns null.
-