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

public Class YearDeserializer

extends JSR310DateTimeDeserializerBase<Year>
Class Inheritance
Imports
java.time.DateTimeException, .Year, java.time.format.DateTimeFormatter, com.fasterxml.jackson.annotation.JsonFormat, tools.jackson.core.JacksonException, .JsonParser, .JsonToken, .StreamReadCapability, tools.jackson.core.io.NumberInput, tools.jackson.databind.DeserializationContext

Deserializer for Java 8 temporal Years.
Author
Nick Williams

Field Summary

Modifier and TypeField and Description
public static final YearDeserializer
Inherited from tools.jackson.databind.ext.javatime.deser.JSR310DateTimeDeserializerBase:
_formatter_shape

Constructor Summary

AccessConstructor and Description
public
YearDeserializer()

Note

only public so that use via annotations (see [modules-java8#202]) is possible

public
protected
YearDeserializer(YearDeserializer base, Boolean leniency)

Since 2.12

public
YearDeserializer(YearDeserializer base, Boolean leniency, DateTimeFormatter formatter, JsonFormat.Shape shape)

Since 2.16

Method Summary

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

protected YearDeserializer
protected YearDeserializer
Inherited from tools.jackson.databind.ext.javatime.deser.JSR310DateTimeDeserializerBase:
_throwNoNumericTimestampNeedTimeZone_withFormatOverridescreateContextualwithShape

Field Detail

INSTANCEback to summary
public static final YearDeserializer INSTANCE

Constructor Detail

YearDeserializerback to summary
public YearDeserializer()

Note

only public so that use via annotations (see [modules-java8#202]) is possible

YearDeserializerback to summary
public YearDeserializer(DateTimeFormatter formatter)
YearDeserializerback to summary
protected YearDeserializer(YearDeserializer base, Boolean leniency)

Since 2.12

YearDeserializerback to summary
public YearDeserializer(YearDeserializer base, Boolean leniency, DateTimeFormatter formatter, JsonFormat.Shape shape)

Since 2.16

Method Detail

_fromNumberback to summary
protected Year _fromNumber(DeserializationContext ctxt, int value)
_fromStringback to summary
protected Year _fromString(JsonParser p, DeserializationContext ctxt, String string0) throws JacksonException
deserializeback to summary
public Year 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
withDateFormatback to summary
protected YearDeserializer withDateFormat(DateTimeFormatter dtf)

Implements abstract tools.jackson.databind.ext.javatime.deser.JSR310DateTimeDeserializerBase.withDateFormat.

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

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

Annotations
@Override