Class StdDateFormat
- java.lang.Object
-
- java.text.Format
-
- java.text.DateFormat
-
- com.fasterxml.jackson.databind.util.StdDateFormat
-
- All Implemented Interfaces:
Serializable,Cloneable
public class StdDateFormat extends DateFormat
DefaultDateFormatimplementation 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.
Note that `Z` in format String refers to RFC-822 timezone notation which produces values like "-0800" -- that is, full minute/hour combo without colon, and not using `Z` as alias for "+0000".Note also that to enable use of colon in timezone is possible by using method
withColonInTimeZone(boolean)for creating new differently configured format instance.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class java.text.DateFormat
DateFormat.Field
-
-
Field Summary
Fields Modifier and Type Field Description protected Boolean_lenientExplicit override for leniency, if specified.protected Locale_localeprotected TimeZone_timezoneCaller may want to explicitly override timezone to use; if so, we will have non-null value here.protected static String[]ALL_FORMATSFor error messages we'll also need a list of all formats.protected static CalendarCALENDARBlueprint "Calendar" instance for use during formatting.protected static DateFormatDATE_FORMAT_ISO8601protected static DateFormatDATE_FORMAT_RFC1123static StringDATE_FORMAT_STR_ISO8601Defines a commonly used date format that conforms to ISO-8601 date formatting standard, when it includes basic undecorated timezone definition.protected static StringDATE_FORMAT_STR_PLAINISO-8601 with just the Date part, no time: needed for error messagesprotected static StringDATE_FORMAT_STR_RFC1123This constant defines the date format specified by RFC 1123 / RFC 822.protected static LocaleDEFAULT_LOCALEprotected static TimeZoneDEFAULT_TIMEZONEBy default we use UTC for everything, with Jackson 2.7 and later (2.6 and earlier relied on GMT)static StdDateFormatinstanceA singleton instance can be used for cloning purposes, as a blueprint of sorts.protected static PatternPATTERN_ISO8601protected static PatternPATTERN_PLAINprotected static StringPATTERN_PLAIN_STR-
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
Constructors Modifier Constructor Description StdDateFormat()StdDateFormat(TimeZone tz, Locale loc)Deprecated.protectedStdDateFormat(TimeZone tz, Locale loc, Boolean lenient)protectedStdDateFormat(TimeZone tz, Locale loc, Boolean lenient, boolean formatTzOffsetWithColon)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method 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)StdDateFormatclone()booleanequals(Object o)StringBufferformat(Date date, StringBuffer toAppendTo, FieldPosition fieldPosition)static TimeZonegetDefaultTimeZone()static DateFormatgetISO8601Format(TimeZone tz, Locale loc)Deprecated.Since 2.9static DateFormatgetRFC1123Format(TimeZone tz, Locale loc)Deprecated.Since 2.9TimeZonegetTimeZone()inthashCode()booleanisColonIncludedInTimeZone()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.booleanisLenient()protected booleanlooksLikeISO8601(String dateStr)Helper method used to figure out if input looks like valid ISO-8601 string.Dateparse(String dateStr)Dateparse(String dateStr, ParsePosition pos)protected DateparseAsISO8601(String dateStr, ParsePosition pos)protected DateparseAsRFC1123(String dateStr, ParsePosition pos)voidsetLenient(boolean enabled)Need to override since we need to keep track of leniency locally, and not via underlyingCalendarinstance like base class does.voidsetTimeZone(TimeZone tz)StringtoPattern()StringtoString()StdDateFormatwithColonInTimeZone(boolean b)"Mutant factory" method that will return an instance that has specified handling of colon when serializing timezone (timezone either written like+0500or+05:00): eitherthisinstance (if setting would not change), or newly constructed instance with desired setting for colon inclusion.StdDateFormatwithLenient(Boolean b)"Mutant factory" method that will return an instance that has specified leniency setting: eitherthisinstance (if setting would not change), or newly constructed instance.StdDateFormatwithLocale(Locale loc)"Mutant factory" method that will return an instance that uses specifiedLocale: eitherthisinstance (if setting would not change), or newly constructed instance with differentLocaleto use.StdDateFormatwithTimeZone(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 Detail
-
PATTERN_PLAIN_STR
protected static final String PATTERN_PLAIN_STR
- See Also:
- Constant Field Values
-
PATTERN_PLAIN
protected static final Pattern PATTERN_PLAIN
-
PATTERN_ISO8601
protected static final Pattern PATTERN_ISO8601
-
DATE_FORMAT_STR_ISO8601
public static final 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.- See Also:
- Constant Field Values
-
DATE_FORMAT_STR_PLAIN
protected static final String DATE_FORMAT_STR_PLAIN
ISO-8601 with just the Date part, no time: needed for error messages- See Also:
- Constant Field Values
-
DATE_FORMAT_STR_RFC1123
protected static final String 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:
- Constant Field Values
-
ALL_FORMATS
protected static final String[] ALL_FORMATS
For error messages we'll also need a list of all formats.
-
DEFAULT_TIMEZONE
protected static final TimeZone DEFAULT_TIMEZONE
By default we use UTC for everything, with Jackson 2.7 and later (2.6 and earlier relied on GMT)
-
DEFAULT_LOCALE
protected static final Locale DEFAULT_LOCALE
-
DATE_FORMAT_RFC1123
protected static final DateFormat DATE_FORMAT_RFC1123
-
DATE_FORMAT_ISO8601
protected static final DateFormat DATE_FORMAT_ISO8601
-
instance
public static final StdDateFormat instance
A singleton instance can be used for cloning purposes, as a blueprint of sorts.
-
CALENDAR
protected static final Calendar 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
protected transient TimeZone _timezone
Caller may want to explicitly override timezone to use; if so, we will have non-null value here.
-
_locale
protected final Locale _locale
-
_lenient
protected Boolean _lenient
Explicit override for leniency, if specified.Cannot be `final` because
setLenient(boolean)returns `void`.- Since:
- 2.7
-
-
Constructor Detail
-
StdDateFormat
public StdDateFormat()
-
StdDateFormat
@Deprecated public StdDateFormat(TimeZone tz, Locale loc)
Deprecated.
-
-
Method Detail
-
getDefaultTimeZone
public static TimeZone getDefaultTimeZone()
-
withTimeZone
public StdDateFormat withTimeZone(TimeZone tz)
Method used for creating a new instance with specified timezone; if no timezone specified, defaults to the default timezone (UTC).
-
withLocale
public StdDateFormat withLocale(Locale loc)
"Mutant factory" method that will return an instance that uses specifiedLocale: eitherthisinstance (if setting would not change), or newly constructed instance with differentLocaleto use.
-
withLenient
public StdDateFormat withLenient(Boolean b)
"Mutant factory" method that will return an instance that has specified leniency setting: eitherthisinstance (if setting would not change), or newly constructed instance.- Since:
- 2.9
-
withColonInTimeZone
public 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+0500or+05:00): eitherthisinstance (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
public StdDateFormat clone()
- Overrides:
clonein classDateFormat
-
getISO8601Format
@Deprecated public static DateFormat getISO8601Format(TimeZone tz, Locale loc)
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 public static DateFormat getRFC1123Format(TimeZone tz, Locale loc)
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
public TimeZone getTimeZone()
- Overrides:
getTimeZonein classDateFormat
-
setTimeZone
public void setTimeZone(TimeZone tz)
- Overrides:
setTimeZonein classDateFormat
-
setLenient
public void setLenient(boolean enabled)
Need to override since we need to keep track of leniency locally, and not via underlyingCalendarinstance like base class does.- Overrides:
setLenientin classDateFormat
-
isLenient
public boolean isLenient()
- Overrides:
isLenientin 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:
trueif 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
public Date parse(String dateStr) throws ParseException
- Overrides:
parsein classDateFormat- Throws:
ParseException
-
parse
public Date parse(String dateStr, ParsePosition pos)
- Specified by:
parsein classDateFormat
-
_parseDate
protected Date _parseDate(String dateStr, ParsePosition pos) throws ParseException
- Throws:
ParseException
-
format
public StringBuffer format(Date date, StringBuffer toAppendTo, FieldPosition fieldPosition)
- Specified by:
formatin classDateFormat
-
_format
protected void _format(TimeZone tz, Locale loc, Date date, StringBuffer buffer)
-
_formatBCEYear
protected void _formatBCEYear(StringBuffer buffer, int bceYearNoSign)
-
toPattern
public String toPattern()
-
equals
public boolean equals(Object o)
- Overrides:
equalsin classDateFormat
-
hashCode
public int hashCode()
- Overrides:
hashCodein classDateFormat
-
looksLikeISO8601
protected boolean looksLikeISO8601(String dateStr)
Helper method used to figure out if input looks like valid ISO-8601 string.
-
parseAsISO8601
protected Date parseAsISO8601(String dateStr, ParsePosition pos) throws ParseException
- Throws:
ParseException
-
_parseAsISO8601
protected Date _parseAsISO8601(String dateStr, ParsePosition bogus) throws IllegalArgumentException, ParseException
-
parseAsRFC1123
protected Date parseAsRFC1123(String dateStr, ParsePosition pos)
-
_clearFormats
protected void _clearFormats()
-
_equals
protected static <T> boolean _equals(T value1, T value2)
-
-