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,ValueInstantiator.Gettable,Serializable
public class InstantDeserializer<T extends Temporal> extends JSR310DateTimeDeserializerBase<T>
- Since:
- 2.2
- Author:
- Nick Williams
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classInstantDeserializer.FromDecimalArgumentsstatic classInstantDeserializer.FromIntegerArguments-
Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonDeserializer
JsonDeserializer.None
-
-
Field Summary
Fields Modifier and Type Field Description protected Boolean_adjustToContextTZOverrideFlag forJsonFormat.Feature.ADJUST_DATES_TO_CONTEXT_TIME_ZONEprotected boolean_isLenientFlag that indicates what leniency setting is enabled for this deserializer (either dueJsonFormat.Shapeannotation 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 BiFunction<T,ZoneId,T>adjustprotected Function<InstantDeserializer.FromIntegerArguments,T>fromMillisecondsprotected Function<InstantDeserializer.FromDecimalArguments,T>fromNanosecondsstatic InstantDeserializer<Instant>INSTANTprotected static PatternISO8601_COLONLESS_OFFSET_REGEXConstants used to check if ISO 8601 time string is colonless.static InstantDeserializer<OffsetDateTime>OFFSET_DATE_TIMEprotected Function<TemporalAccessor,T>parsedToValueprotected booleanreplaceZeroOffsetAsZIn 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 infostatic InstantDeserializer<ZonedDateTime>ZONED_DATE_TIME-
Fields inherited from class com.fasterxml.jackson.datatype.jsr310.deser.JSR310DateTimeDeserializerBase
_formatter, _shape
-
Fields inherited from class com.fasterxml.jackson.databind.deser.std.StdDeserializer
_valueClass, _valueType, F_MASK_ACCEPT_ARRAYS, F_MASK_INT_COERCIONS
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedInstantDeserializer(InstantDeserializer<T> base, Boolean adjustToContextTimezoneOverride)protectedInstantDeserializer(InstantDeserializer<T> base, DateTimeFormatter f)protectedInstantDeserializer(InstantDeserializer<T> base, DateTimeFormatter f, Boolean leniency)protectedInstantDeserializer(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)
-
Method Summary
All Methods Instance Methods Concrete Methods 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 forisLenient()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_handleUnexpectedToken(DeserializationContext context, JsonParser parser, JsonToken... expTypes)protected <R> R_handleUnexpectedToken(DeserializationContext context, JsonParser parser, String message, Object... args)protected boolean_isValidTimestampString(String str)protected DateTimeException_peelDTE(DateTimeException e)Helper method used to peel off spurious wrappings of DateTimeExceptionprotected <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)Tdeserialize(JsonParser parser, DeserializationContext context)Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles.ObjectdeserializeWithType(JsonParser parser, DeserializationContext context, TypeDeserializer typeDeserializer)Base implementation that does not assume specific type inclusion mechanism.protected booleanisLenient()LogicalTypelogicalType()Method for accessing logical type of values this deserializer produces.protected booleanshouldAdjustToContextTimezone(DeserializationContext context)protected InstantDeserializer<T>withDateFormat(DateTimeFormatter dtf)protected InstantDeserializer<T>withLeniency(Boolean leniency)protected InstantDeserializer<T>withShape(JsonFormat.Shape shape)-
Methods inherited from class com.fasterxml.jackson.datatype.jsr310.deser.JSR310DateTimeDeserializerBase
_throwNoNumericTimestampNeedTimeZone, createContextual
-
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, _checkBooleanToStringCoercion, _checkCoercionFail, _checkDoubleSpecialValue, _checkFloatSpecialValue, _checkFloatToIntCoercion, _checkFloatToStringCoercion, _checkFromStringCoercion, _checkFromStringCoercion, _checkIntToFloatCoercion, _checkIntToStringCoercion, _checkTextualNull, _checkToStringCoercion, _coerceBooleanFromInt, _coercedTypeDesc, _coercedTypeDesc, _coerceEmptyString, _coerceIntegral, _coerceNullToken, _coerceTextualNull, _deserializeFromArray, _deserializeFromEmpty, _deserializeFromEmptyString, _deserializeFromString, _deserializeWrappedValue, _failDoubleToIntCoercion, _findCoercionFromBlankString, _findCoercionFromEmptyArray, _findCoercionFromEmptyString, _findNullProvider, _hasTextualNull, _intOverflow, _isBlank, _isEmptyOrTextualNull, _isFalse, _isIntNumber, _isNaN, _isNegInf, _isPosInf, _isTrue, _neitherNull, _nonNullNumber, _parseBoolean, _parseBooleanFromInt, _parseBooleanPrimitive, _parseBooleanPrimitive, _parseBytePrimitive, _parseDate, _parseDate, _parseDateFromArray, _parseDouble, _parseDouble, _parseDoublePrimitive, _parseDoublePrimitive, _parseDoublePrimitive, _parseFloatPrimitive, _parseFloatPrimitive, _parseFloatPrimitive, _parseInteger, _parseInteger, _parseIntPrimitive, _parseIntPrimitive, _parseLong, _parseLong, _parseLongPrimitive, _parseLongPrimitive, _parseShortPrimitive, _parseString, _parseString, _reportFailedNullCoerce, _shortOverflow, _verifyEndArrayForSingle, _verifyNullForPrimitive, _verifyNullForPrimitiveCoercion, _verifyNullForScalarCoercion, _verifyNumberForScalarCoercion, _verifyStringForScalarCoercion, findContentNullProvider, findContentNullStyle, findConvertingContentDeserializer, findDeserializer, findFormatFeature, findFormatOverrides, findValueNullProvider, getValueClass, getValueInstantiator, getValueType, getValueType, handledType, handleMissingEndArrayForSingle, handleNestedArrayForSingle, handleUnknownProperty, isDefaultDeserializer, isDefaultKeyDeserializer
-
Methods inherited from class com.fasterxml.jackson.databind.JsonDeserializer
deserializeWithType, findBackReference, getAbsentValue, getDelegatee, getEmptyValue, getEmptyValue, getKnownPropertyNames, getNullValue, getNullValue, getObjectIdReader, isCachable, replaceDelegatee, unwrappingDeserializer
-
-
-
-
Field Detail
-
ISO8601_COLONLESS_OFFSET_REGEX
protected static final Pattern ISO8601_COLONLESS_OFFSET_REGEX
Constants used to check if ISO 8601 time string is colonless. See [jackson-modules-java8#131]- Since:
- 2.13
-
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
-
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 forJsonFormat.Feature.ADJUST_DATES_TO_CONTEXT_TIME_ZONE- Since:
- 2.8
-
_isLenient
protected final boolean _isLenient
Flag that indicates what leniency setting is enabled for this deserializer (either dueJsonFormat.Shapeannotation 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.
Note that with 2.12 and later coercion settings are moving to
CoercionConfig, instead of simple yes/no leniency setting.- Since:
- 2.11
-
-
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)
-
InstantDeserializer
protected InstantDeserializer(InstantDeserializer<T> base, DateTimeFormatter f, Boolean leniency)
-
-
Method Detail
-
withDateFormat
protected InstantDeserializer<T> withDateFormat(DateTimeFormatter dtf)
- Specified by:
withDateFormatin classJSR310DateTimeDeserializerBase<T extends Temporal>
-
withLeniency
protected InstantDeserializer<T> withLeniency(Boolean leniency)
- Specified by:
withLeniencyin classJSR310DateTimeDeserializerBase<T extends Temporal>
-
withShape
protected InstantDeserializer<T> withShape(JsonFormat.Shape shape)
- Specified by:
withShapein classJSR310DateTimeDeserializerBase<T extends Temporal>
-
_withFormatOverrides
protected JSR310DateTimeDeserializerBase<?> _withFormatOverrides(DeserializationContext ctxt, BeanProperty property, JsonFormat.Value formatOverrides)
- Overrides:
_withFormatOverridesin classJSR310DateTimeDeserializerBase<T extends Temporal>- Parameters:
ctxt- Active deserialization contextproperty- (optional) Property on which this deserializer is used, ornullfor root valueformatOverrides- 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 parser, DeserializationContext context) throws IOException
Description copied from class:JsonDeserializerMethod 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).
Note that this method is never called for JSON null literal, and thus deserializers need (and should) not check for it.
- Specified by:
deserializein classJsonDeserializer<T extends Temporal>- Parameters:
parser- Parsed used for reading JSON contentcontext- Context that can be used to access information about this deserialization activity.- Returns:
- Deserialized value
- Throws:
IOException
-
shouldAdjustToContextTimezone
protected boolean shouldAdjustToContextTimezone(DeserializationContext context)
-
_countPeriods
protected int _countPeriods(String str)
-
_fromString
protected T _fromString(JsonParser p, DeserializationContext ctxt, String string0) throws IOException
- Throws:
IOException
-
_fromLong
protected T _fromLong(DeserializationContext context, long timestamp)
-
_fromDecimal
protected T _fromDecimal(DeserializationContext context, BigDecimal value)
-
isLenient
protected boolean isLenient()
- Returns:
trueif lenient handling is enabled; {code false} if not (strict mode)- Since:
- 2.11
-
_fromEmptyString
protected T _fromEmptyString(JsonParser p, DeserializationContext ctxt, String str) throws IOException
Replacement forisLenient()for specific case of deserialization from empty or blank String.- Throws:
IOException- Since:
- 2.12
-
logicalType
public LogicalType logicalType()
Description copied from class:JsonDeserializerMethod 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:
logicalTypein classStdScalarDeserializer<T>- Returns:
- Logical type of values this deserializer produces, if known;
nullif not
-
deserializeWithType
public Object deserializeWithType(JsonParser parser, DeserializationContext context, TypeDeserializer typeDeserializer) throws IOException
Description copied from class:StdDeserializerBase 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:
deserializeWithTypein classStdScalarDeserializer<T>typeDeserializer- Deserializer to use for handling type information- Throws:
IOException
-
_isValidTimestampString
protected boolean _isValidTimestampString(String str)
-
_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
-
_handleDateTimeException
protected <R> R _handleDateTimeException(DeserializationContext context, DateTimeException e0, String value) throws JsonMappingException
- Throws:
JsonMappingException
-
_handleUnexpectedToken
protected <R> R _handleUnexpectedToken(DeserializationContext context, JsonParser parser, String message, Object... args) throws JsonMappingException
- Throws:
JsonMappingException
-
_handleUnexpectedToken
protected <R> R _handleUnexpectedToken(DeserializationContext context, JsonParser parser, JsonToken... expTypes) throws JsonMappingException
- Throws:
JsonMappingException
-
_failForNotLenient
protected T _failForNotLenient(JsonParser p, DeserializationContext ctxt, JsonToken expToken) throws IOException
- Throws:
IOException
-
_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.
-
-