Module tools.jackson.databind

Package tools.jackson.databind.ext.javatime.deser

Class InstantDeserializer<T extends Temporal>

java.lang.Object

tools.jackson.databind.ValueDeserializer<T>

tools.jackson.databind.deser.std.StdDeserializer<T>

tools.jackson.databind.deser.std.StdScalarDeserializer<T>

tools.jackson.databind.ext.javatime.deser.JSR310DateTimeDeserializerBase<T>

tools.jackson.databind.ext.javatime.deser.InstantDeserializer<T>

All Implemented Interfaces:

NullValueProvider, ValueInstantiator.Gettable

public class InstantDeserializer<T extends Temporal>
extends JSR310DateTimeDeserializerBase<T>

Deserializer for Java 8 temporal Instants, OffsetDateTime, and ZonedDateTimes.

Author:

Nick Williams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InstantDeserializer.FromDecimalArguments
static class	InstantDeserializer.FromIntegerArguments

Nested classes/interfaces inherited from class tools.jackson.databind.ValueDeserializer

ValueDeserializer.None

Field Summary

Fields

Modifier and Type	Field	Description
protected final Boolean	_adjustToContextTZOverride	Flag for JsonFormat.Feature.ADJUST_DATES_TO_CONTEXT_TIME_ZONE
protected final boolean	_isLenient	Flag that indicates what leniency setting is enabled for this deserializer (either due JsonFormat.Shape annotation on property or class, or due to per-type "config override", or from global settings): leniency/strictness has effect on accepting some non-default input value representations (such as integer values for dates).
protected final Boolean	_readTimestampsAsNanosOverride	Flag for JsonFormat.Feature.READ_DATE_TIMESTAMPS_AS_NANOSECONDS
protected final BiFunction<T,ZoneId,T>	adjust
protected final Function<InstantDeserializer.FromIntegerArguments,T>	fromMilliseconds
protected final Function<InstantDeserializer.FromDecimalArguments,T>	fromNanoseconds
static final InstantDeserializer<Instant>	INSTANT
protected static final Pattern	ISO8601_COLONLESS_OFFSET_REGEX	Constants used to check if ISO 8601 time string is colon-less.
static final InstantDeserializer<OffsetDateTime>	OFFSET_DATE_TIME
protected final Function<TemporalAccessor,T>	parsedToValue
protected final boolean	replaceZeroOffsetAsZ	In case of vanilla `Instant` we seem to need to translate "+0000 | +00:00 | +00" timezone designator into plain "Z" for some reason; see [jackson-modules-java8#18] for more info
static final InstantDeserializer<ZonedDateTime>	ZONED_DATE_TIME

Fields inherited from class tools.jackson.databind.ext.javatime.deser.JSR310DateTimeDeserializerBase

_formatter, _shape

Fields inherited from class tools.jackson.databind.deser.std.StdDeserializer

_valueClass, _valueType, F_MASK_INT_COERCIONS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InstantDeserializer(Class<T> supportedType, DateTimeFormatter formatter, Function<TemporalAccessor,T> parsedToValue, Function<InstantDeserializer.FromIntegerArguments,T> fromMilliseconds, Function<InstantDeserializer.FromDecimalArguments,T> fromNanoseconds, BiFunction<T,ZoneId,T> adjust, boolean replaceZeroOffsetAsZ, boolean normalizeZoneId, boolean readNumericStringsAsTimestamp)
protected	InstantDeserializer(InstantDeserializer<T> base, Boolean adjustToContextTimezoneOverride)
protected	InstantDeserializer(InstantDeserializer<T> base, Boolean leniency, DateTimeFormatter formatter, JsonFormat.Shape shape, Boolean adjustToContextTimezoneOverride, Boolean readTimestampsAsNanosOverride)
protected	InstantDeserializer(InstantDeserializer<T> base, DateTimeFormatter f)
protected	InstantDeserializer(InstantDeserializer<T> base, DateTimeFormatter f, Boolean leniency)

Method Summary

Modifier and Type	Method	Description
protected int	_countPeriods(String str)
protected T	_failForNotLenient(JsonParser p, DeserializationContext ctxt, JsonToken expToken)
protected T	_fromDecimal(DeserializationContext context, BigDecimal value)
protected T	_fromEmptyString(JsonParser p, DeserializationContext ctxt, String str)	Replacement for isLenient() for specific case of deserialization from empty or blank String.
protected T	_fromLong(DeserializationContext context, long timestamp)
protected T	_fromString(JsonParser p, DeserializationContext ctxt, String string0)
protected <R> R	_handleDateTimeException(DeserializationContext context, DateTimeException e0, String value)
protected <R> R	_handleDateTimeFormatException(DeserializationContext context, DateTimeException e0, DateTimeFormatter format, String value)
protected <R> R	_handleUnexpectedToken(DeserializationContext ctxt, JsonParser parser, String message, Object... args)
protected <R> R	_handleUnexpectedToken(DeserializationContext context, JsonParser parser, JsonToken... expTypes)
protected boolean	_isValidTimestampString(String str)
protected DateTimeException	_peelDTE(DateTimeException e)	Helper method used to peel off spurious wrappings of DateTimeException
protected <BOGUS> BOGUS	_reportWrongToken(JsonParser parser, DeserializationContext context, JsonToken... expTypes)
protected <BOGUS> BOGUS	_reportWrongToken(DeserializationContext context, JsonToken exp, String unit)
protected JSR310DateTimeDeserializerBase<?>	_withFormatOverrides(DeserializationContext ctxt, BeanProperty property, JsonFormat.Value formatOverrides)
T	deserialize(JsonParser p, DeserializationContext ctxt)	Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles.
Object	deserializeWithType(JsonParser parser, DeserializationContext context, TypeDeserializer typeDeserializer)	Base implementation that does not assume specific type inclusion mechanism.
protected boolean	isLenient()
LogicalType	logicalType()	Method for accessing logical type of values this deserializer produces.
protected boolean	shouldAdjustToContextTimezone(DeserializationContext context)
protected boolean	shouldReadTimestampsAsNanoseconds(DeserializationContext context)
protected InstantDeserializer<T>	withDateFormat(DateTimeFormatter dtf)
protected InstantDeserializer<T>	withLeniency(Boolean leniency)

Methods inherited from class tools.jackson.databind.ext.javatime.deser.JSR310DateTimeDeserializerBase

_throwNoNumericTimestampNeedTimeZone, createContextual, withShape

Methods inherited from class tools.jackson.databind.deser.std.StdScalarDeserializer

deserialize, getEmptyAccessPattern, getNullAccessPattern, supportsUpdate

Methods inherited from class tools.jackson.databind.deser.std.StdDeserializer

_byteOverflow, _checkBooleanToStringCoercion, _checkCoercionFail, _checkDoubleSpecialValue, _checkFloatSpecialValue, _checkFloatToIntCoercion, _checkFloatToStringCoercion, _checkFromStringCoercion, _checkFromStringCoercion, _checkIntToFloatCoercion, _checkIntToStringCoercion, _checkTextualNull, _checkToStringCoercion, _coerceBooleanFromInt, _coercedTypeDesc, _coercedTypeDesc, _coerceIntegral, _deserializeFromArray, _deserializeFromEmptyString, _deserializeFromString, _deserializeWrappedValue, _findCoercionFromBlankString, _findCoercionFromEmptyArray, _findCoercionFromEmptyString, _findNullProvider, _hasTextualNull, _intOverflow, _isBlank, _isFalse, _isIntNumber, _isNaN, _isNegInf, _isPosInf, _isTrue, _neitherNull, _nonNullNumber, _parseBoolean, _parseBooleanPrimitive, _parseBytePrimitive, _parseDate, _parseDate, _parseDateFromArray, _parseDouble, _parseDoublePrimitive, _parseDoublePrimitive, _parseFloatPrimitive, _parseFloatPrimitive, _parseInteger, _parseInteger, _parseIntPrimitive, _parseIntPrimitive, _parseLong, _parseLong, _parseLongPrimitive, _parseLongPrimitive, _parseShortPrimitive, _parseString, _reportFailedNullCoerce, _shortOverflow, _verifyEndArrayForSingle, _verifyNullForPrimitive, _verifyNullForPrimitiveCoercion, _wrapIOFailure, findContentNullProvider, findContentNullStyle, findConvertingContentDeserializer, findDeserializer, findFormatFeature, findFormatOverrides, findValueNullProvider, getValueInstantiator, getValueType, getValueType, handledType, handleMissingEndArrayForSingle, handleNestedArrayForSingle, handleUnknownProperty, isDefaultDeserializer, isDefaultKeyDeserializer

Methods inherited from class tools.jackson.databind.ValueDeserializer

deserializeWithType, findBackReference, getAbsentValue, getDelegatee, getEmptyValue, getKnownPropertyNames, getNullValue, getObjectIdReader, isCachable, replaceDelegatee, resolve, unwrappingDeserializer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ISO8601_COLONLESS_OFFSET_REGEX

protected static final Pattern ISO8601_COLONLESS_OFFSET_REGEX

Constants used to check if ISO 8601 time string is colon-less. See [jackson-modules-java8#131]

INSTANT

public static final InstantDeserializer<Instant> INSTANT

OFFSET_DATE_TIME

public static final InstantDeserializer<OffsetDateTime> OFFSET_DATE_TIME

ZONED_DATE_TIME

public static final InstantDeserializer<ZonedDateTime> ZONED_DATE_TIME

fromMilliseconds

protected final Function<InstantDeserializer.FromIntegerArguments,T extends Temporal> fromMilliseconds

fromNanoseconds

protected final Function<InstantDeserializer.FromDecimalArguments,T extends Temporal> fromNanoseconds

parsedToValue

protected final Function<TemporalAccessor,T extends Temporal> parsedToValue

adjust

protected final BiFunction<T extends Temporal,ZoneId,T extends Temporal> adjust

replaceZeroOffsetAsZ

protected final boolean replaceZeroOffsetAsZ

In case of vanilla `Instant` we seem to need to translate "+0000 | +00:00 | +00" timezone designator into plain "Z" for some reason; see [jackson-modules-java8#18] for more info

_adjustToContextTZOverride

protected final Boolean _adjustToContextTZOverride

Flag for JsonFormat.Feature.ADJUST_DATES_TO_CONTEXT_TIME_ZONE

_readTimestampsAsNanosOverride

protected final Boolean _readTimestampsAsNanosOverride

Flag for JsonFormat.Feature.READ_DATE_TIMESTAMPS_AS_NANOSECONDS

_isLenient

protected final boolean _isLenient

Flag that indicates what leniency setting is enabled for this deserializer (either due JsonFormat.Shape annotation on property or class, or due to per-type "config override", or from global settings): leniency/strictness has effect on accepting some non-default input value representations (such as integer values for dates).

Note that global default setting is for leniency to be enabled, for Jackson 2.x, and has to be explicitly change to force strict handling: this is to keep backwards compatibility with earlier versions.

Constructor Details

InstantDeserializer

protected InstantDeserializer(Class<T> supportedType,
 DateTimeFormatter formatter,
 Function<TemporalAccessor,T> parsedToValue,
 Function<InstantDeserializer.FromIntegerArguments,T> fromMilliseconds,
 Function<InstantDeserializer.FromDecimalArguments,T> fromNanoseconds,
 BiFunction<T,ZoneId,T> adjust,
 boolean replaceZeroOffsetAsZ,
 boolean normalizeZoneId,
 boolean readNumericStringsAsTimestamp)

Since:

2.16

InstantDeserializer

protected InstantDeserializer(InstantDeserializer<T> base,
 DateTimeFormatter f)

InstantDeserializer

protected InstantDeserializer(InstantDeserializer<T> base,
 Boolean adjustToContextTimezoneOverride)

InstantDeserializer

protected InstantDeserializer(InstantDeserializer<T> base,
 DateTimeFormatter f,
 Boolean leniency)

InstantDeserializer

protected InstantDeserializer(InstantDeserializer<T> base,
 Boolean leniency,
 DateTimeFormatter formatter,
 JsonFormat.Shape shape,
 Boolean adjustToContextTimezoneOverride,
 Boolean readTimestampsAsNanosOverride)

Method Details

withDateFormat

protected InstantDeserializer<T> withDateFormat(DateTimeFormatter dtf)

Specified by:

withDateFormat in class JSR310DateTimeDeserializerBase<T extends Temporal>

withLeniency

protected InstantDeserializer<T> withLeniency(Boolean leniency)

Specified by:

withLeniency in class JSR310DateTimeDeserializerBase<T extends Temporal>

_withFormatOverrides

protected JSR310DateTimeDeserializerBase<?> _withFormatOverrides(DeserializationContext ctxt,
 BeanProperty property,
 JsonFormat.Value formatOverrides)

Overrides:

_withFormatOverrides in class JSR310DateTimeDeserializerBase<T extends Temporal>

Parameters:

ctxt - Active deserialization context

property - (optional) Property on which this deserializer is used, or null for root value

formatOverrides - Format overrides to use (non-null)

Returns:

Either this deserializer as is, or newly constructed variant if created for different configuration

deserialize

public T deserialize(JsonParser p,
 DeserializationContext ctxt)
              throws JacksonException

Description copied from class: ValueDeserializer

Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles. Returned instance is to be constructed by method itself.

Pre-condition for this method is that the parser points to the first event that is part of value to deserializer (and which is never JSON 'null' literal, more on this below): for simple types it may be the only value; and for structured types the Object start marker or a FIELD_NAME.

The two possible input conditions for structured types result from polymorphism via fields. In the ordinary case, Jackson calls this method when it has encountered an OBJECT_START, and the method implementation must advance to the next token to see the first field name. If the application configures polymorphism via a field, then the object looks like the following.

      {
          "@class": "class name",
          ...
      }
  

Jackson consumes the two tokens (the @class field name and its value) in order to learn the class and select the deserializer. Thus, the stream is pointing to the FIELD_NAME for the first field after the @class. Thus, if you want your method to work correctly both with and without polymorphism, you must begin your method with:

       if (p.currentToken() == JsonToken.START_OBJECT) {
         p.nextToken();
       }
  

This results in the stream pointing to the field name, so that the two conditions align.

Post-condition is that the parser will point to the last event that is part of deserialized value (or in case deserialization fails, event that was not recognized or usable, which may be the same event as the one it pointed to upon call).

Handling null values (JsonToken.VALUE_NULL)
: Note that this method is never called for the JSON null literal to avoid every deserializer from having to handle null values. Instead, the ValueDeserializer.getNullValue(DeserializationContext) method is called to produce a null value. To influence null handling, custom deserializers should override ValueDeserializer.getNullValue(DeserializationContext) and usually also ValueDeserializer.getNullAccessPattern().

Specified by:

deserialize in class ValueDeserializer<T extends Temporal>

Parameters:

p - Parser used for reading JSON content

ctxt - Context that can be used to access information about this deserialization activity.

Returns:

Deserialized value

Throws:

JacksonException

shouldAdjustToContextTimezone

protected boolean shouldAdjustToContextTimezone(DeserializationContext context)

shouldReadTimestampsAsNanoseconds

protected boolean shouldReadTimestampsAsNanoseconds(DeserializationContext context)

_countPeriods

protected int _countPeriods(String str)

_fromString

protected T _fromString(JsonParser p,
 DeserializationContext ctxt,
 String string0)
                 throws JacksonException

Throws:

JacksonException

_fromLong

protected T _fromLong(DeserializationContext context,
 long timestamp)

_fromDecimal

protected T _fromDecimal(DeserializationContext context,
 BigDecimal value)

isLenient

protected boolean isLenient()

Returns:

true if lenient handling is enabled; {code false} if not (strict mode)

_fromEmptyString

protected T _fromEmptyString(JsonParser p,
 DeserializationContext ctxt,
 String str)
                      throws JacksonException

Replacement for isLenient() for specific case of deserialization from empty or blank String.

Throws:

JacksonException

Since:

2.12

logicalType

public LogicalType logicalType()

Description copied from class: ValueDeserializer

Method for accessing logical type of values this deserializer produces. Typically used for further configuring handling of values, for example, to find which coercions are legal.

Overrides:

logicalType in class StdScalarDeserializer<T>

Returns:

Logical type of values this deserializer produces, if known; null if not

deserializeWithType

public Object deserializeWithType(JsonParser parser,
 DeserializationContext context,
 TypeDeserializer typeDeserializer)
                           throws JacksonException

Description copied from class: StdDeserializer

Base implementation that does not assume specific type inclusion mechanism. Sub-classes are expected to override this method if they are to handle type information.

Overrides:

deserializeWithType in class StdScalarDeserializer<T>

typeDeserializer - Deserializer to use for handling type information

Throws:

JacksonException

_isValidTimestampString

protected boolean _isValidTimestampString(String str)

_reportWrongToken

protected <BOGUS> BOGUS _reportWrongToken(DeserializationContext context,
 JsonToken exp,
 String unit)
                                   throws JacksonException

Throws:

JacksonException

_reportWrongToken

protected <BOGUS> BOGUS _reportWrongToken(JsonParser parser,
 DeserializationContext context,
 JsonToken... expTypes)
                                   throws JacksonException

Throws:

JacksonException

_handleDateTimeException

protected <R> R _handleDateTimeException(DeserializationContext context,
 DateTimeException e0,
 String value)
                                  throws JacksonException

Throws:

JacksonException

_handleDateTimeFormatException

protected <R> R _handleDateTimeFormatException(DeserializationContext context,
 DateTimeException e0,
 DateTimeFormatter format,
 String value)
                                        throws JacksonException

Throws:

JacksonException

_handleUnexpectedToken

protected <R> R _handleUnexpectedToken(DeserializationContext ctxt,
 JsonParser parser,
 String message,
 Object... args)

_handleUnexpectedToken

protected <R> R _handleUnexpectedToken(DeserializationContext context,
 JsonParser parser,
 JsonToken... expTypes)

_failForNotLenient

protected T _failForNotLenient(JsonParser p,
 DeserializationContext ctxt,
 JsonToken expToken)
                        throws JacksonException

Throws:

JacksonException

_peelDTE

protected DateTimeException _peelDTE(DateTimeException e)

Helper method used to peel off spurious wrappings of DateTimeException

Parameters:

e - DateTimeException to peel

Returns:

DateTimeException that does not have another DateTimeException as its cause.