com.fasterxml.jackson.datatype.jsr310.deser

Class InstantDeserializer<T extends Temporal>

java.lang.Object

com.fasterxml.jackson.databind.JsonDeserializer<T>

com.fasterxml.jackson.databind.deser.std.StdDeserializer<T>

com.fasterxml.jackson.databind.deser.std.StdScalarDeserializer<T>

com.fasterxml.jackson.datatype.jsr310.deser.JSR310DateTimeDeserializerBase<T>

com.fasterxml.jackson.datatype.jsr310.deser.InstantDeserializer<T>

All Implemented Interfaces:

ContextualDeserializer, NullValueProvider, Serializable

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

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

Since:

2.2

Author:

Nick Williams

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonDeserializer

JsonDeserializer.None

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	_adjustToContextTZOverride Flag for JsonFormat.Feature.ADJUST_DATES_TO_CONTEXT_TIME_ZONE
protected BiFunction<T,ZoneId,T>	adjust
protected Function<InstantDeserializer.FromIntegerArguments,T>	fromMilliseconds
protected Function<InstantDeserializer.FromDecimalArguments,T>	fromNanoseconds
static InstantDeserializer<Instant>	INSTANT
static InstantDeserializer<OffsetDateTime>	OFFSET_DATE_TIME
protected Function<TemporalAccessor,T>	parsedToValue
protected 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 InstantDeserializer<ZonedDateTime>	ZONED_DATE_TIME

Fields inherited from class com.fasterxml.jackson.datatype.jsr310.deser.JSR310DateTimeDeserializerBase

_formatter

Fields inherited from class com.fasterxml.jackson.databind.deser.std.StdDeserializer

_valueClass, F_MASK_ACCEPT_ARRAYS, F_MASK_INT_COERCIONS

Constructor Summary

Constructors

Modifier	Constructor and 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)
protected	InstantDeserializer(InstantDeserializer<T> base, Boolean adjustToContextTimezoneOverride)
protected	InstantDeserializer(InstantDeserializer<T> base, DateTimeFormatter f)

Method Summary

Modifier and Type	Method and Description
protected int	_countPeriods(String str) Helper method to find Strings of form "all digits" and "digits-comma-digits"
protected T	_fromDecimal(DeserializationContext context, BigDecimal value)
protected T	_fromLong(DeserializationContext context, long timestamp)
protected DateTimeException	_peelDTE(DateTimeException e) Helper method used to peel off spurious wrappings of DateTimeException
protected <BOGUS> BOGUS	_reportWrongToken(DeserializationContext context, JsonToken exp, String unit)
protected <BOGUS> BOGUS	_reportWrongToken(JsonParser parser, DeserializationContext context, JsonToken... expTypes)
protected <BOGUS> BOGUS	_rethrowDateTimeException(JsonParser p, DeserializationContext context, DateTimeException e0, String value)
JsonDeserializer<T>	createContextual(DeserializationContext ctxt, BeanProperty property) Method called to see if a different (or differently configured) deserializer is needed to deserialize values of specified property.
T	deserialize(JsonParser parser, DeserializationContext context) 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	shouldAdjustToContextTimezone(DeserializationContext context)
protected JsonDeserializer<T>	withDateFormat(DateTimeFormatter dtf)

Methods inherited from class com.fasterxml.jackson.datatype.jsr310.deser.JSR310DateTimeDeserializerBase

_throwNoNumericTimestampNeedTimeZone

Methods inherited from class com.fasterxml.jackson.databind.deser.std.StdScalarDeserializer

deserialize, getEmptyAccessPattern, getNullAccessPattern, supportsUpdate

Methods inherited from class com.fasterxml.jackson.databind.deser.std.StdDeserializer

_byteOverflow, _coercedTypeDesc, _coerceEmptyString, _coerceIntegral, _coerceNullToken, _coerceTextualNull, _deserializeFromArray, _deserializeFromEmpty, _deserializeWrappedValue, _failDoubleToIntCoercion, _findNullProvider, _hasTextualNull, _intOverflow, _isEmptyOrTextualNull, _isIntNumber, _isNaN, _isNegInf, _isPosInf, _neitherNull, _nonNullNumber, _parseBooleanFromInt, _parseBooleanPrimitive, _parseBytePrimitive, _parseDate, _parseDate, _parseDateFromArray, _parseDoublePrimitive, _parseDoublePrimitive, _parseFloatPrimitive, _parseFloatPrimitive, _parseIntPrimitive, _parseIntPrimitive, _parseLongPrimitive, _parseLongPrimitive, _parseShortPrimitive, _parseString, _reportFailedNullCoerce, _shortOverflow, _verifyEndArrayForSingle, _verifyNullForPrimitive, _verifyNullForPrimitiveCoercion, _verifyNullForScalarCoercion, _verifyNumberForScalarCoercion, _verifyStringForScalarCoercion, findContentNullProvider, findContentNullStyle, findConvertingContentDeserializer, findDeserializer, findFormatFeature, findFormatOverrides, findValueNullProvider, getValueClass, getValueType, handledType, handleMissingEndArrayForSingle, handleUnknownProperty, isDefaultDeserializer, isDefaultKeyDeserializer, parseDouble

Methods inherited from class com.fasterxml.jackson.databind.JsonDeserializer

findBackReference, getDelegatee, getEmptyValue, getEmptyValue, getKnownPropertyNames, getNullValue, getNullValue, getObjectIdReader, isCachable, replaceDelegatee, unwrappingDeserializer

Methods inherited from class java.lang.Object

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

Field Detail

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

Since:

2.9.0

_adjustToContextTZOverride

protected final Boolean _adjustToContextTZOverride

Flag for JsonFormat.Feature.ADJUST_DATES_TO_CONTEXT_TIME_ZONE

Since:

2.8

Constructor Detail

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)

InstantDeserializer

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

InstantDeserializer

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

Method Detail

withDateFormat

protected JsonDeserializer<T> withDateFormat(DateTimeFormatter dtf)

Specified by:

withDateFormat in class JSR310DateTimeDeserializerBase<T extends Temporal>

deserialize

public T deserialize(JsonParser parser,
                     DeserializationContext context)
              throws IOException

Description copied from class: JsonDeserializer

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.getCurrentToken() == 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).

Note that this method is never called for JSON null literal, and thus deserializers need (and should) not check for it.

Specified by:

deserialize in class JsonDeserializer<T extends Temporal>

Parameters:

parser - Parsed used for reading JSON content

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

Returns:

Deserialized value

Throws:

IOException

createContextual

public JsonDeserializer<T> createContextual(DeserializationContext ctxt,
                                            BeanProperty property)
                                     throws JsonMappingException

Description copied from interface: ContextualDeserializer

Method called to see if a different (or differently configured) deserializer is needed to deserialize values of specified property. Note that instance that this method is called on is typically shared one and as a result method should NOT modify this instance but rather construct and return a new instance. This instance should only be returned as-is, in case it is already suitable for use.

Specified by:

createContextual in interface ContextualDeserializer

Overrides:

createContextual in class JSR310DateTimeDeserializerBase<T extends Temporal>

Parameters:

ctxt - Deserialization context to access configuration, additional deserializers that may be needed by this deserializer

property - Method, field or constructor parameter that represents the property (and is used to assign deserialized value). Should be available; but there may be cases where caller cannot provide it and null is passed instead (in which case impls usually pass 'this' deserializer as is)

Returns:

Deserializer to use for deserializing values of specified property; may be this instance or a new instance.

Throws:

JsonMappingException

shouldAdjustToContextTimezone

protected boolean shouldAdjustToContextTimezone(DeserializationContext context)

_countPeriods

protected int _countPeriods(String str)

Helper method to find Strings of form "all digits" and "digits-comma-digits"

_fromLong

protected T _fromLong(DeserializationContext context,
                      long timestamp)

_fromDecimal

protected T _fromDecimal(DeserializationContext context,
                         BigDecimal value)

deserializeWithType

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

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:

IOException

_reportWrongToken

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

Throws:

IOException

_reportWrongToken

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

Throws:

IOException

_rethrowDateTimeException

protected <BOGUS> BOGUS _rethrowDateTimeException(JsonParser p,
                                                  DeserializationContext context,
                                                  DateTimeException e0,
                                                  String value)
                                           throws JsonMappingException

Throws:

JsonMappingException

_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.