public class StdDateFormat extends DateFormat
DateFormat
implementation used by standard Date
serializers and deserializers. For serialization defaults to using
an ISO-8601 compliant format (format String "yyyy-MM-dd'T'HH:mm:ss.SSSZ")
and for deserialization, both ISO-8601 and RFC-1123.
withColonInTimeZone(boolean)
for creating new differently configured format instance,
and configuring ObjectMapper
with it.DateFormat.Field
Modifier and Type | Field and Description |
---|---|
protected Boolean |
_lenient
Explicit override for leniency, if specified.
|
protected Locale |
_locale |
protected TimeZone |
_timezone
Caller may want to explicitly override timezone to use; if so,
we will have non-null value here.
|
protected static String[] |
ALL_FORMATS
For error messages we'll also need a list of all formats.
|
protected static Calendar |
CALENDAR
Blueprint "Calendar" instance for use during formatting.
|
protected static DateFormat |
DATE_FORMAT_RFC1123 |
static String |
DATE_FORMAT_STR_ISO8601
Defines a commonly used date format that conforms
to ISO-8601 date formatting standard, when it includes basic undecorated
timezone definition.
|
protected static String |
DATE_FORMAT_STR_PLAIN
ISO-8601 with just the Date part, no time: needed for error messages
|
protected static String |
DATE_FORMAT_STR_RFC1123
This constant defines the date format specified by
RFC 1123 / RFC 822.
|
protected static Locale |
DEFAULT_LOCALE |
protected static TimeZone |
DEFAULT_TIMEZONE
By default we use UTC for everything, with Jackson 2.7 and later
(2.6 and earlier relied on GMT)
|
static StdDateFormat |
instance
A singleton instance can be used for cloning purposes, as a blueprint of sorts.
|
protected static Pattern |
PATTERN_ISO8601 |
protected static Pattern |
PATTERN_PLAIN |
protected static String |
PATTERN_PLAIN_STR |
AM_PM_FIELD, calendar, DATE_FIELD, DAY_OF_WEEK_FIELD, DAY_OF_WEEK_IN_MONTH_FIELD, DAY_OF_YEAR_FIELD, DEFAULT, ERA_FIELD, FULL, HOUR_OF_DAY0_FIELD, HOUR_OF_DAY1_FIELD, HOUR0_FIELD, HOUR1_FIELD, LONG, MEDIUM, MILLISECOND_FIELD, MINUTE_FIELD, MONTH_FIELD, numberFormat, SECOND_FIELD, SHORT, TIMEZONE_FIELD, WEEK_OF_MONTH_FIELD, WEEK_OF_YEAR_FIELD, YEAR_FIELD
Modifier | Constructor and Description |
---|---|
|
StdDateFormat() |
|
StdDateFormat(TimeZone tz,
Locale loc)
Deprecated.
|
protected |
StdDateFormat(TimeZone tz,
Locale loc,
Boolean lenient) |
protected |
StdDateFormat(TimeZone tz,
Locale loc,
Boolean lenient,
boolean formatTzOffsetWithColon) |
Modifier and Type | Method and Description |
---|---|
protected void |
_clearFormats() |
protected static <T> boolean |
_equals(T value1,
T value2) |
protected void |
_format(TimeZone tz,
Locale loc,
Date date,
StringBuffer buffer) |
protected void |
_formatBCEYear(StringBuffer buffer,
int bceYearNoSign) |
protected Calendar |
_getCalendar(TimeZone tz) |
protected Date |
_parseAsISO8601(String dateStr,
ParsePosition bogus) |
protected Date |
_parseDate(String dateStr,
ParsePosition pos) |
StdDateFormat |
clone() |
boolean |
equals(Object o) |
StringBuffer |
format(Date date,
StringBuffer toAppendTo,
FieldPosition fieldPosition) |
static TimeZone |
getDefaultTimeZone() |
static DateFormat |
getISO8601Format(TimeZone tz,
Locale loc)
Deprecated.
Since 2.9
|
static DateFormat |
getRFC1123Format(TimeZone tz,
Locale loc)
Deprecated.
Since 2.9
|
TimeZone |
getTimeZone() |
int |
hashCode() |
boolean |
isColonIncludedInTimeZone()
Accessor for checking whether this instance would include colon
within timezone serialization or not: if {code true}, timezone offset
is serialized like
-06:00 ; if {code false} as -0600 . |
boolean |
isLenient() |
protected boolean |
looksLikeISO8601(String dateStr)
Helper method used to figure out if input looks like valid
ISO-8601 string.
|
Date |
parse(String dateStr) |
Date |
parse(String dateStr,
ParsePosition pos) |
protected Date |
parseAsISO8601(String dateStr,
ParsePosition pos) |
protected Date |
parseAsRFC1123(String dateStr,
ParsePosition pos) |
void |
setLenient(boolean enabled)
Need to override since we need to keep track of leniency locally,
and not via underlying
Calendar instance like base class
does. |
void |
setTimeZone(TimeZone tz) |
String |
toPattern() |
String |
toString() |
StdDateFormat |
withColonInTimeZone(boolean b)
"Mutant factory" method that will return an instance that has specified
handling of colon when serializing timezone (timezone either written
like
+0500 or +05:00 ):
either this instance (if setting would not change), or newly
constructed instance with desired setting for colon inclusion. |
StdDateFormat |
withLenient(Boolean b)
"Mutant factory" method that will return an instance that has specified leniency
setting: either
this instance (if setting would not change), or newly
constructed instance. |
StdDateFormat |
withLocale(Locale loc)
"Mutant factory" method that will return an instance that uses specified
Locale :
either this instance (if setting would not change), or newly
constructed instance with different Locale to use. |
StdDateFormat |
withTimeZone(TimeZone tz)
Method used for creating a new instance with specified timezone;
if no timezone specified, defaults to the default timezone (UTC).
|
format, format, getAvailableLocales, getCalendar, getDateInstance, getDateInstance, getDateInstance, getDateTimeInstance, getDateTimeInstance, getDateTimeInstance, getInstance, getNumberFormat, getTimeInstance, getTimeInstance, getTimeInstance, parseObject, setCalendar, setNumberFormat
format, formatToCharacterIterator, parseObject
protected static final String PATTERN_PLAIN_STR
protected static final Pattern PATTERN_PLAIN
protected static final Pattern PATTERN_ISO8601
public static final String DATE_FORMAT_STR_ISO8601
protected static final String DATE_FORMAT_STR_PLAIN
protected static final String DATE_FORMAT_STR_RFC1123
protected static final String[] ALL_FORMATS
protected static final TimeZone DEFAULT_TIMEZONE
protected static final Locale DEFAULT_LOCALE
protected static final DateFormat DATE_FORMAT_RFC1123
public static final StdDateFormat instance
protected static final Calendar CALENDAR
protected transient TimeZone _timezone
protected final Locale _locale
protected Boolean _lenient
Cannot be `final` because setLenient(boolean)
returns
`void`.
public StdDateFormat()
@Deprecated public StdDateFormat(TimeZone tz, Locale loc)
public static TimeZone getDefaultTimeZone()
public StdDateFormat withTimeZone(TimeZone tz)
public StdDateFormat withLocale(Locale loc)
Locale
:
either this
instance (if setting would not change), or newly
constructed instance with different Locale
to use.public StdDateFormat withLenient(Boolean b)
this
instance (if setting would not change), or newly
constructed instance.public StdDateFormat withColonInTimeZone(boolean b)
+0500
or +05:00
):
either this
instance (if setting would not change), or newly
constructed instance with desired setting for colon inclusion.
NOTE: does NOT affect deserialization as colon is optional accepted but not required -- put another way, either serialization is accepted by this class.
public StdDateFormat clone()
clone
in class DateFormat
@Deprecated public static DateFormat getISO8601Format(TimeZone tz, Locale loc)
@Deprecated public static DateFormat getRFC1123Format(TimeZone tz, Locale loc)
public TimeZone getTimeZone()
getTimeZone
in class DateFormat
public void setTimeZone(TimeZone tz)
setTimeZone
in class DateFormat
public void setLenient(boolean enabled)
Calendar
instance like base class
does.setLenient
in class DateFormat
public boolean isLenient()
isLenient
in class DateFormat
public boolean isColonIncludedInTimeZone()
-06:00
; if {code false} as -0600
.
NOTE: only relevant for serialization (formatting), as deserialization (parsing) always accepts optional colon but does not require it, regardless of this setting.
true
if a colon is to be inserted between the hours and minutes
of the TZ offset when serializing as String; otherwise false
public Date parse(String dateStr) throws ParseException
parse
in class DateFormat
ParseException
public Date parse(String dateStr, ParsePosition pos)
parse
in class DateFormat
protected Date _parseDate(String dateStr, ParsePosition pos) throws ParseException
ParseException
public StringBuffer format(Date date, StringBuffer toAppendTo, FieldPosition fieldPosition)
format
in class DateFormat
protected void _format(TimeZone tz, Locale loc, Date date, StringBuffer buffer)
protected void _formatBCEYear(StringBuffer buffer, int bceYearNoSign)
public String toPattern()
public boolean equals(Object o)
equals
in class DateFormat
public int hashCode()
hashCode
in class DateFormat
protected boolean looksLikeISO8601(String dateStr)
protected Date parseAsISO8601(String dateStr, ParsePosition pos) throws ParseException
ParseException
protected Date _parseAsISO8601(String dateStr, ParsePosition bogus) throws IllegalArgumentException, ParseException
protected Date parseAsRFC1123(String dateStr, ParsePosition pos)
protected void _clearFormats()
protected static <T> boolean _equals(T value1, T value2)
Copyright © 2021 JBoss by Red Hat. All rights reserved.