Jackson 3.0.1 · tools.jackson.dataformat.avro.apacheimpl.CustomEncodingDeserializer

Modifier and Type	Field and Description
private final CustomEncodingWrapper<T>	encoding

Access	Constructor and Description
public	CustomEncodingDeserializer(CustomEncoding<T> encoding)

Modifier and Type	Method and Description
public T	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 T	deserialize(JsonParser p, DeserializationContext ctxt, T intoValue) Overrides tools.jackson.databind.ValueDeserializer.deserialize. Alternate deserialization method (compared to the most commonly used, `deserialize(JsonParser, DeserializationContext)`), which takes in initialized value instance, to be configured and/or populated by deserializer.

encoding	back to summary
private final CustomEncodingWrapper<T> encoding

CustomEncodingDeserializer	back to summary
public CustomEncodingDeserializer(CustomEncoding<T> encoding)

Method Detail

deserialize back to summary

deserialize	back to summary
public T 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

public T 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

deserialize back to summary

deserialize	back to summary
public T deserialize(JsonParser p, DeserializationContext ctxt, T intoValue) throws JacksonException Overrides tools.jackson.databind.ValueDeserializer.deserialize. Doc from tools.jackson.databind.ValueDeserializer.deserialize. Alternate deserialization method (compared to the most commonly used, `deserialize(JsonParser, DeserializationContext)`), which takes in initialized value instance, to be configured and/or populated by deserializer. Method is not necessarily used (or supported) by all types (it will not work for immutable types, for obvious reasons): most commonly it is used for Collections and Maps. It may be used both with "updating readers" (for POJOs) and when Collections and Maps use "getter as setter". Default implementation just throws `UnsupportedOperationException`, to indicate that types that do not explicitly add support do not necessarily support update-existing-value operation (esp. immutable types) Annotations @Override

public T deserialize(JsonParser p, DeserializationContext ctxt, T intoValue) throws JacksonException

Overrides tools.jackson.databind.ValueDeserializer.deserialize.

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

Alternate deserialization method (compared to the most commonly used, deserialize(JsonParser, DeserializationContext)), which takes in initialized value instance, to be configured and/or populated by deserializer. Method is not necessarily used (or supported) by all types (it will not work for immutable types, for obvious reasons): most commonly it is used for Collections and Maps. It may be used both with "updating readers" (for POJOs) and when Collections and Maps use "getter as setter".

Default implementation just throws UnsupportedOperationException, to indicate that types that do not explicitly add support do not necessarily support update-existing-value operation (esp. immutable types)

Annotations

@Override

public Class CustomEncodingDeserializer<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail