Class StdDateFormat
- All Implemented Interfaces:
Serializable
,Cloneable
DateFormat
implementation used by standard Date
serializers and deserializers to implement default behavior: does NOT
fully implement all aspects expected by DateFormat
and as a consequence
SHOULD NOT to be used by code outside core Jackson databind functionality.
In particular, ParsePosition
argument of parse(String, ParsePosition)
and format(Date, StringBuffer, FieldPosition)
methods is fully ignored;
Jackson itself never calls these methods.
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.
Note that `Z` in format String refers to ISO-8601 time offset notation which produces
values like "-08:00" -- that is, full minute/hour combo without colon, and not using `Z`
as alias for "+00:00".
Inclusion of colon as separator, as default setting, started in Jackson 2.11:
prior versions omitted it.
Note that it is possible to enable/disable use of colon in time offset by using method
withColonInTimeZone(boolean)
for creating new differently configured format instance,
and configuring ObjectMapper
with it.
TODO: in Jackson 2.14 or later, should change behavior to fail if ParsePosition
is specified by caller (at least with non-0 offset).
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.text.DateFormat
DateFormat.Field
-
Field Summary
Modifier and TypeFieldDescriptionprotected Boolean
Explicit override for leniency, if specified.protected final Locale
protected TimeZone
Caller may want to explicitly override timezone to use; if so, we will have non-null value here.protected static final String[]
For error messages we'll also need a list of all formats.protected static final Calendar
Blueprint "Calendar" instance for use during formatting.protected static final DateFormat
static final String
Defines a commonly used date format that conforms to ISO-8601 date formatting standard, when it includes basic undecorated timezone definition.protected static final String
ISO-8601 with just the Date part, no time: needed for error messagesprotected static final String
This constant defines the date format specified by RFC 1123 / RFC 822.protected static final Locale
protected static final TimeZone
By default we use UTC for everything, with Jackson 2.7 and later (2.6 and earlier relied on GMT)static final StdDateFormat
A singleton instance can be used for cloning purposes, as a blueprint of sorts.protected static final Pattern
protected static final Pattern
protected static final String
Fields inherited from class java.text.DateFormat
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
-
Constructor Summary
ModifierConstructorDescriptionStdDateFormat
(TimeZone tz, Locale loc) Deprecated.protected
StdDateFormat
(TimeZone tz, Locale loc, Boolean lenient) protected
StdDateFormat
(TimeZone tz, Locale loc, Boolean lenient, boolean formatTzOffsetWithColon) -
Method Summary
Modifier and TypeMethodDescriptionprotected void
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) clone()
boolean
format
(Date date, StringBuffer toAppendTo, FieldPosition fieldPosition) static TimeZone
static DateFormat
getISO8601Format
(TimeZone tz, Locale loc) Deprecated.Since 2.9static DateFormat
getRFC1123Format
(TimeZone tz, Locale loc) Deprecated.Since 2.9int
hashCode()
boolean
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
protected boolean
looksLikeISO8601
(String dateStr) Helper method used to figure out if input looks like valid ISO-8601 string.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 underlyingCalendar
instance like base class does.void
setTimeZone
(TimeZone tz) toString()
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
): eitherthis
instance (if setting would not change), or newly constructed instance with desired setting for colon inclusion."Mutant factory" method that will return an instance that has specified leniency setting: eitherthis
instance (if setting would not change), or newly constructed instance.withLocale
(Locale loc) "Mutant factory" method that will return an instance that uses specifiedLocale
: eitherthis
instance (if setting would not change), or newly constructed instance with differentLocale
to use.withTimeZone
(TimeZone tz) Method used for creating a new instance with specified timezone; if no timezone specified, defaults to the default timezone (UTC).Methods inherited from class java.text.DateFormat
format, format, getAvailableLocales, getCalendar, getDateInstance, getDateInstance, getDateInstance, getDateTimeInstance, getDateTimeInstance, getDateTimeInstance, getInstance, getNumberFormat, getTimeInstance, getTimeInstance, getTimeInstance, parseObject, setCalendar, setNumberFormat
Methods inherited from class java.text.Format
format, formatToCharacterIterator, parseObject
-
Field Details
-
PATTERN_PLAIN_STR
- See Also:
-
PATTERN_PLAIN
-
PATTERN_ISO8601
-
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.- See Also:
-
DATE_FORMAT_STR_PLAIN
ISO-8601 with just the Date part, no time: needed for error messages- See Also:
-
DATE_FORMAT_STR_RFC1123
This constant defines the date format specified by RFC 1123 / RFC 822. Used for parsing via `SimpleDateFormat` as well as error messages.- See Also:
-
ALL_FORMATS
For error messages we'll also need a list of all formats. -
DEFAULT_TIMEZONE
By default we use UTC for everything, with Jackson 2.7 and later (2.6 and earlier relied on GMT) -
DEFAULT_LOCALE
-
DATE_FORMAT_RFC1123
-
instance
A singleton instance can be used for cloning purposes, as a blueprint of sorts. -
CALENDAR
Blueprint "Calendar" instance for use during formatting. Cannot be used as is, due to thread-safety issues, but can be used for constructing actual instances more cheaply by cloning.- Since:
- 2.9.1
-
_timezone
Caller may want to explicitly override timezone to use; if so, we will have non-null value here. -
_locale
-
_lenient
Explicit override for leniency, if specified.Cannot be `final` because
setLenient(boolean)
returns `void`.- Since:
- 2.7
-
-
Constructor Details
-
StdDateFormat
public StdDateFormat() -
StdDateFormat
Deprecated. -
StdDateFormat
-
StdDateFormat
- Since:
- 2.9.1
-
-
Method Details
-
getDefaultTimeZone
-
withTimeZone
Method used for creating a new instance with specified timezone; if no timezone specified, defaults to the default timezone (UTC). -
withLocale
"Mutant factory" method that will return an instance that uses specifiedLocale
: eitherthis
instance (if setting would not change), or newly constructed instance with differentLocale
to use. -
withLenient
"Mutant factory" method that will return an instance that has specified leniency setting: eitherthis
instance (if setting would not change), or newly constructed instance.- Since:
- 2.9
-
withColonInTimeZone
"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
): eitherthis
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.
- Since:
- 2.9.1
-
clone
- Overrides:
clone
in classDateFormat
-
getISO8601Format
Deprecated.Since 2.9Method for getting a non-shared DateFormat instance that uses specified timezone and can handle simple ISO-8601 compliant date format.- Since:
- 2.4
-
getRFC1123Format
Deprecated.Since 2.9Method for getting a non-shared DateFormat instance that uses specific timezone and can handle RFC-1123 compliant date format.- Since:
- 2.4
-
getTimeZone
- Overrides:
getTimeZone
in classDateFormat
-
setTimeZone
- Overrides:
setTimeZone
in classDateFormat
-
setLenient
public void setLenient(boolean enabled) Need to override since we need to keep track of leniency locally, and not via underlyingCalendar
instance like base class does.- Overrides:
setLenient
in classDateFormat
-
isLenient
public boolean isLenient()- Overrides:
isLenient
in classDateFormat
-
isColonIncludedInTimeZone
public 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
.NOTE: only relevant for serialization (formatting), as deserialization (parsing) always accepts optional colon but does not require it, regardless of this setting.
- Returns:
true
if a colon is to be inserted between the hours and minutes of the TZ offset when serializing as String; otherwisefalse
- Since:
- 2.9.1
-
parse
- Overrides:
parse
in classDateFormat
- Throws:
ParseException
-
parse
- Specified by:
parse
in classDateFormat
-
_parseDate
- Throws:
ParseException
-
format
- Specified by:
format
in classDateFormat
-
_format
-
_formatBCEYear
-
toString
-
toPattern
-
equals
- Overrides:
equals
in classDateFormat
-
hashCode
public int hashCode()- Overrides:
hashCode
in classDateFormat
-
looksLikeISO8601
Helper method used to figure out if input looks like valid ISO-8601 string. -
parseAsISO8601
- Throws:
ParseException
-
_parseAsISO8601
protected Date _parseAsISO8601(String dateStr, ParsePosition bogus) throws IllegalArgumentException, ParseException -
parseAsRFC1123
-
_clearFormats
protected void _clearFormats() -
_getCalendar
-
_equals
protected static <T> boolean _equals(T value1, T value2)
-