public class FastDateParser extends Object implements DateParser, Serializable
FastDateParser is a fast and thread-safe version of
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.
FastDatePrinter
,
Serialized FormModifier | Constructor and Description |
---|---|
protected |
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.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj)
Compares another object for equality with this object.
|
Locale |
getLocale()
Gets the locale used by this parser.
|
String |
getPattern()
Gets the pattern used by this parser.
|
TimeZone |
getTimeZone()
Gets the time zone used by this parser.
|
int |
hashCode()
Returns a hash code compatible with equals.
|
Date |
parse(String source)
Equivalent to DateFormat.parse(String).
|
Date |
parse(String source,
ParsePosition pos)
This implementation updates the ParsePosition if the parse succeeds.
|
boolean |
parse(String source,
ParsePosition pos,
Calendar calendar)
Parses a formatted date string according to the format.
|
Object |
parseObject(String source)
Parses text from a string to produce a Date.
|
Object |
parseObject(String source,
ParsePosition pos)
Parses a date/time string according to the given parse position.
|
String |
toString()
Gets a string version of this formatter.
|
String |
toStringAll()
Converts all state of this instance to a String handy for debugging.
|
protected FastDateParser(String pattern, TimeZone timeZone, Locale locale)
Constructs a new FastDateParser.
UseFastDateFormat.getInstance(String, TimeZone, Locale)
or another variation of the
factory methods of FastDateFormat
to get a cached FastDateParser instance.pattern
- non-null SimpleDateFormat
compatible
patterntimeZone
- non-null time zone to uselocale
- non-null localeprotected FastDateParser(String pattern, TimeZone timeZone, Locale locale, Date centuryStart)
Constructs a new FastDateParser.
pattern
- non-null SimpleDateFormat
compatible
patterntimeZone
- non-null time zone to uselocale
- non-null localecenturyStart
- The start of the century for 2 digit year parsingpublic String getPattern()
DateParser
Gets the pattern used by this parser.
getPattern
in interface DateParser
SimpleDateFormat
compatiblepublic TimeZone getTimeZone()
DateParser
Gets the time zone used by this parser.
The default TimeZone
used to create a Date
when the TimeZone
is not specified by
the format pattern.
getTimeZone
in interface DateParser
public Locale getLocale()
DateParser
Gets the locale used by this parser.
getLocale
in interface DateParser
public boolean equals(Object obj)
Compares another object for equality with this object.
public int hashCode()
Returns a hash code compatible with equals.
public String toString()
Gets a string version of this formatter.
public String toStringAll()
public Object parseObject(String source) throws ParseException
DateParser
parseObject
in interface DateParser
source
- A String
whose beginning should be parsed.java.util.Date
objectParseException
- if the beginning of the specified string cannot be parsed.Format.parseObject(String)
public Date parse(String source) throws ParseException
DateParser
DateFormat.parse(String)
for more information.parse
in interface DateParser
source
- A String
whose beginning should be parsed.Date
parsed from the stringParseException
- if the beginning of the specified string cannot be parsed.public Object parseObject(String source, ParsePosition pos)
DateParser
parseObject
in interface DateParser
source
- A String
whose beginning should be parsed.pos
- the parse positionjava.util.Date
objectDateFormat.parseObject(String, ParsePosition)
public Date parse(String source, ParsePosition pos)
SimpleDateFormat.parse(String, ParsePosition)
which sets
the error index to after the failed field.
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.
parse
in interface DateParser
source
- A String
, part of which should be parsed.pos
- A ParsePosition
object with index and error index information
as described above.Date
parsed from the string. In case of error, returns null.DateParser.parse(java.lang.String, java.text.ParsePosition)
public boolean parse(String source, ParsePosition pos, Calendar calendar)
parse
in interface DateParser
source
- The text to parse.pos
- On input, the position in the source to start parsing, on output, updated position.calendar
- The calendar into which to set parsed fields.IllegalArgumentException
- when Calendar has been set to be not lenient, and a parsed field is
out of range.Copyright © 2001–2021 The Apache Software Foundation. All rights reserved.