Class DurationDeserializer
- 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.DurationDeserializer
-
- All Implemented Interfaces:
ContextualDeserializer,NullValueProvider,ValueInstantiator.Gettable,Serializable
public class DurationDeserializer extends StdScalarDeserializer<T> implements ContextualDeserializer
Deserializer for Java 8 temporalDurations.- Since:
- 2.2
- Author:
- Nick Williams
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonDeserializer
JsonDeserializer.None
-
-
Field Summary
Fields Modifier and Type Field Description protected DurationUnitConverter_durationUnitConverterWhen defined (notnull) integer values will be converted into duration unit configured for the converter.protected 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).static DurationDeserializerINSTANCE-
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 DurationDeserializer()protectedDurationDeserializer(DurationDeserializer base, DurationUnitConverter converter)protectedDurationDeserializer(DurationDeserializer base, Boolean leniency)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected T_failForNotLenient(JsonParser p, DeserializationContext ctxt, JsonToken expToken)protected T_fromEmptyString(JsonParser p, DeserializationContext ctxt, String str)Replacement forisLenient()for specific case of deserialization from empty or blank String.protected Duration_fromString(JsonParser parser, DeserializationContext ctxt, String value0)protected Duration_fromTimestamp(DeserializationContext ctxt, long ts)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)JsonDeserializer<?>createContextual(DeserializationContext ctxt, BeanProperty property)Method called to see if a different (or differently configured) deserializer is needed to deserialize values of specified property.Durationdeserialize(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 DurationDeserializerwithConverter(DurationUnitConverter converter)protected DurationDeserializerwithLeniency(Boolean leniency)-
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
-
INSTANCE
public static final DurationDeserializer INSTANCE
-
_durationUnitConverter
protected final DurationUnitConverter _durationUnitConverter
When defined (notnull) integer values will be converted into duration unit configured for the converter. Using this converter will typically override the value specified inDeserializationFeature.READ_DATE_TIMESTAMPS_AS_NANOSECONDSas it is considered that the unit set inJsonFormat.pattern()has precedence since it is more specific.See [jackson-modules-java8#184] for more info.
- Since:
- 2.12
-
_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
-
DurationDeserializer
public DurationDeserializer()
-
DurationDeserializer
protected DurationDeserializer(DurationDeserializer base, Boolean leniency)
- Since:
- 2.11
-
DurationDeserializer
protected DurationDeserializer(DurationDeserializer base, DurationUnitConverter converter)
- Since:
- 2.12
-
-
Method Detail
-
withLeniency
protected DurationDeserializer withLeniency(Boolean leniency)
-
withConverter
protected DurationDeserializer withConverter(DurationUnitConverter converter)
-
createContextual
public JsonDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property) throws JsonMappingException
Description copied from interface:ContextualDeserializerMethod 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:
createContextualin interfaceContextualDeserializer- Parameters:
ctxt- Deserialization context to access configuration, additional deserializers that may be needed by this deserializerproperty- 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
-
deserialize
public Duration 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<Duration>- 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
-
_fromString
protected Duration _fromString(JsonParser parser, DeserializationContext ctxt, String value0) throws IOException
- Throws:
IOException
-
_fromTimestamp
protected Duration _fromTimestamp(DeserializationContext ctxt, long ts)
-
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.
-
-