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

public Class JSR310StringParsableDeserializer

extends JSR310DeserializerBase<Object>
Class Inheritance
Imports
java.time.DateTimeException, .Period, .ZoneId, .ZoneOffset, com.fasterxml.jackson.annotation.JsonFormat, tools.jackson.core.JacksonException, .JsonParser, .JsonToken, tools.jackson.core.util.VersionUtil, tools.jackson.databind.BeanProperty, .DeserializationContext, .ValueDeserializer, tools.jackson.databind.cfg.CoercionAction, .CoercionInputShape, tools.jackson.databind.jsontype.TypeDeserializer

Deserializer for all Java 8 temporal java.time types that cannot be represented with numbers and that have parse functions that can take Strings, and where format is not configurable.
Authors
Nick Williams, Tatu Saloranta

Field Summary

Modifier and TypeField and Description
protected final int
public static final ValueDeserializer<Period>
protected static final int
protected static final int
protected static final int
public static final ValueDeserializer<ZoneId>
public static final ValueDeserializer<ZoneOffset>
Inherited from tools.jackson.databind.ext.javatime.deser.JSR310DeserializerBase:
_isLenient

Constructor Summary

AccessConstructor and Description
protected
JSR310StringParsableDeserializer(Class<?> supportedType, int typeSelector)

protected

Method Summary

Modifier and TypeMethod and Description
protected Object
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.

protected static <T> ValueDeserializer<T>
createDeserializer(Class<T> type, int typeId)

public Object
deserialize(JsonParser p, DeserializationContext ctxt)

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.

public Object
deserializeWithType(JsonParser p, DeserializationContext context, TypeDeserializer deserializer)

Overrides tools.jackson.databind.ext.javatime.deser.JSR310DeserializerBase.deserializeWithType.

Base implementation that does not assume specific type inclusion mechanism.

protected JSR310StringParsableDeserializer
Inherited from tools.jackson.databind.ext.javatime.deser.JSR310DeserializerBase:
_failForNotLenient_fromEmptyString_handleDateTimeException_handleDateTimeFormatException_handleUnexpectedToken_handleUnexpectedToken_isValidTimestampString_peelDTE_reportWrongToken_reportWrongTokenisLenientlogicalType

Field Detail

_typeSelectorback to summary
protected final int _typeSelector
PERIODback to summary
public static final ValueDeserializer<Period> PERIOD
TYPE_PERIODback to summary
protected static final int TYPE_PERIOD
TYPE_ZONE_IDback to summary
protected static final int TYPE_ZONE_ID
TYPE_ZONE_OFFSETback to summary
protected static final int TYPE_ZONE_OFFSET
ZONE_IDback to summary
public static final ValueDeserializer<ZoneId> ZONE_ID
ZONE_OFFSETback to summary
public static final ValueDeserializer<ZoneOffset> ZONE_OFFSET

Constructor Detail

JSR310StringParsableDeserializerback to summary
protected JSR310StringParsableDeserializer(Class<?> supportedType, int typeSelector)
Annotations
@SuppressWarnings:unchecked
JSR310StringParsableDeserializerback to summary
protected JSR310StringParsableDeserializer(JSR310StringParsableDeserializer base, Boolean leniency)

Method Detail

_fromStringback to summary
protected Object _fromString(JsonParser p, DeserializationContext ctxt, String string) throws JacksonException
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
createDeserializerback to summary
protected static <T> ValueDeserializer<T> createDeserializer(Class<T> type, int typeId)
Annotations
@SuppressWarnings:unchecked
deserializeback to summary
public Object deserialize(JsonParser p, DeserializationContext ctxt) 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
deserializeWithTypeback to summary
public Object deserializeWithType(JsonParser p, DeserializationContext context, TypeDeserializer deserializer) throws JacksonException

Overrides tools.jackson.databind.ext.javatime.deser.JSR310DeserializerBase.deserializeWithType.

Doc from tools.jackson.databind.deser.std.StdDeserializer.deserializeWithType.

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.

Annotations
@Override
withLeniencyback to summary
protected JSR310StringParsableDeserializer withLeniency(Boolean leniency)

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

Annotations
@Override