Top Description Fields Constructors Methods
tools.jackson.databind.ext.javatime.deser

public Class DurationDeserializer

extends JSR310DeserializerBase<Duration>
Class Inheritance
Imports
java.math.BigDecimal, java.time.DateTimeException, .Duration, java.util.Objects, com.fasterxml.jackson.annotation.JsonFormat, tools.jackson.core.JacksonException, .JsonParser, .JsonToken, .JsonTokenId, .StreamReadCapability, tools.jackson.core.io.NumberInput, tools.jackson.databind.*, tools.jackson.databind.cfg.DateTimeFeature, tools.jackson.databind.ext.javatime.util.DecimalUtils, .DurationUnitConverter

Deserializer for Java 8 temporal Durations.

Field Summary

Modifier and TypeField and Description
protected final DurationUnitConverter
_durationUnitConverter

When defined (not null) integer values will be converted into duration unit configured for the converter.

protected final Boolean
_readTimestampsAsNanosOverride

Flag for JsonFormat.Feature.READ_DATE_TIMESTAMPS_AS_NANOSECONDS

public static final DurationDeserializer
Inherited from tools.jackson.databind.ext.javatime.deser.JSR310DeserializerBase:
_isLenient

Constructor Summary

AccessConstructor and Description
public
protected
protected
protected
DurationDeserializer(DurationDeserializer base, Boolean leniency, DurationUnitConverter converter, Boolean readTimestampsAsNanosOverride)

Method Summary

Modifier and TypeMethod and Description
protected Duration
protected Duration
public ValueDeserializer<?>
createContextual(DeserializationContext ctxt, BeanProperty property)

Overrides tools.jackson.databind.ValueDeserializer.createContextual.

Method called to see if a different (or differently configured) deserializer is needed to deserialize values of specified property.

public Duration
deserialize(JsonParser parser, DeserializationContext context)

Implements abstract tools.jackson.databind.ValueDeserializer.deserialize.

Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles.

protected boolean
protected DurationDeserializer
protected DurationDeserializer
Inherited from tools.jackson.databind.ext.javatime.deser.JSR310DeserializerBase:
_failForNotLenient_fromEmptyString_handleDateTimeException_handleDateTimeFormatException_handleUnexpectedToken_handleUnexpectedToken_isValidTimestampString_peelDTE_reportWrongToken_reportWrongTokendeserializeWithTypeisLenientlogicalType

Field Detail

_durationUnitConverterback to summary
protected final DurationUnitConverter _durationUnitConverter

When defined (not null) integer values will be converted into duration unit configured for the converter. Using this converter will typically override the value specified in DateTimeFeature#READ_DATE_TIMESTAMPS_AS_NANOSECONDS as it is considered that the unit set in JsonFormat#pattern() has precedence since it is more specific.

See [jackson-modules-java8#184] for more info.

_readTimestampsAsNanosOverrideback to summary
protected final Boolean _readTimestampsAsNanosOverride

Flag for JsonFormat.Feature.READ_DATE_TIMESTAMPS_AS_NANOSECONDS

Since
2.16
INSTANCEback to summary
public static final DurationDeserializer INSTANCE

Constructor Detail

DurationDeserializerback to summary
public DurationDeserializer()
DurationDeserializerback to summary
protected DurationDeserializer(DurationDeserializer base, Boolean leniency)
Since
2.11
DurationDeserializerback to summary
protected DurationDeserializer(DurationDeserializer base, DurationUnitConverter converter)
Since
2.12
DurationDeserializerback to summary
protected DurationDeserializer(DurationDeserializer base, Boolean leniency, DurationUnitConverter converter, Boolean readTimestampsAsNanosOverride)
Since
2.16

Method Detail

_fromStringback to summary
protected Duration _fromString(JsonParser parser, DeserializationContext ctxt, String value0) throws JacksonException
_fromTimestampback to summary
protected Duration _fromTimestamp(DeserializationContext ctxt, long ts)
createContextualback to summary
public ValueDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property)

Overrides tools.jackson.databind.ValueDeserializer.createContextual.

Doc from tools.jackson.databind.ValueDeserializer.createContextual.

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.

Annotations
@Override
deserializeback to summary
public Duration deserialize(JsonParser parser, DeserializationContext context) throws JacksonException

Implements abstract tools.jackson.databind.ValueDeserializer.deserialize.

Doc from tools.jackson.databind.ValueDeserializer.deserialize.

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

Annotations
@Override
shouldReadTimestampsAsNanosecondsback to summary
protected boolean shouldReadTimestampsAsNanoseconds(DeserializationContext context)
withConverterback to summary
protected DurationDeserializer withConverter(DurationUnitConverter converter)
withLeniencyback to summary
protected DurationDeserializer withLeniency(Boolean leniency)

Implements abstract tools.jackson.databind.ext.javatime.deser.JSR310DeserializerBase.withLeniency.

Annotations
@Override