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

Class DurationDeserializer

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.DurationDeserializer
All Implemented Interfaces:
NullValueProvider, ValueInstantiator.Gettable
public class DurationDeserializer extends StdScalarDeserializer<T>
Deserializer for Java 8 temporal Durations.

  • Field Details

    • INSTANCE

      public static final DurationDeserializer INSTANCE

    • _durationUnitConverter

      protected final tools.jackson.databind.ext.javatime.util.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.

    • _readTimestampsAsNanosOverride

      protected final Boolean _readTimestampsAsNanosOverride
      Flag for JsonFormat.Feature.READ_DATE_TIMESTAMPS_AS_NANOSECONDS
      Since:
      2.16

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

    • DurationDeserializer

      public DurationDeserializer()

    • DurationDeserializer

      protected DurationDeserializer(DurationDeserializer base, Boolean leniency)
      Since:
      2.11

    • DurationDeserializer

      protected DurationDeserializer(DurationDeserializer base, tools.jackson.databind.ext.javatime.util.DurationUnitConverter converter)
      Since:
      2.12

    • DurationDeserializer

      protected DurationDeserializer(DurationDeserializer base, Boolean leniency, tools.jackson.databind.ext.javatime.util.DurationUnitConverter converter, Boolean readTimestampsAsNanosOverride)
      Since:
      2.16

  • Method Details

    • withLeniency

      protected DurationDeserializer withLeniency(Boolean leniency)

    • withConverter

      protected DurationDeserializer withConverter(tools.jackson.databind.ext.javatime.util.DurationUnitConverter converter)

    • createContextual

      public ValueDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property)
      Description copied from class: ValueDeserializer
      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.
      Overrides:
      createContextual in class ValueDeserializer<Duration>
      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.

    • deserialize

      public Duration deserialize(JsonParser parser, DeserializationContext context) 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<Duration>
      Parameters:
      parser - Parser used for reading JSON content
      context - Context that can be used to access information about this deserialization activity.
      Returns:
      Deserialized value
      Throws:
      JacksonException

    • _fromString

      protected Duration _fromString(JsonParser parser, DeserializationContext ctxt, String value0) throws JacksonException
      Throws:
      JacksonException

    • _fromTimestamp

      protected Duration _fromTimestamp(DeserializationContext ctxt, long ts)

    • shouldReadTimestampsAsNanoseconds

      protected boolean shouldReadTimestampsAsNanoseconds(DeserializationContext context)

    • isLenient

      protected boolean isLenient()
      Returns:
      true if lenient handling is enabled; {code false} if not (strict mode)

    • _fromEmptyString

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