Top Description Fields Constructors Methods
tools.jackson.dataformat.ion.ionvalue

pack-priv Class IonValueDeserializer

extends ValueDeserializer<IonValue>
Class Inheritance
Imports
com.amazon.ion.*, tools.jackson.core.*, tools.jackson.databind.*, tools.jackson.databind.util.AccessPattern, tools.jackson.dataformat.ion.IonParser

Deserializer that knows how to deserialize an IonValue.

Field Summary

Modifier and TypeField and Description
private final JavaType

Constructor Summary

AccessConstructor and Description
public
public

Method Summary

Modifier and TypeMethod and Description
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 IonValue
deserialize(JsonParser jp, 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.

private IonType
public AccessPattern
getNullAccessPattern()

Overrides tools.jackson.databind.ValueDeserializer.getNullAccessPattern.

Implements tools.jackson.databind.deser.NullValueProvider.getNullAccessPattern.

This method may be called in conjunction with calls to getNullValue(DeserializationContext), to check whether it needs to be called just once (static values), or each time empty value is needed.

public Object
getNullValue(DeserializationContext ctxt)

Overrides tools.jackson.databind.ValueDeserializer.getNullValue.

Implements tools.jackson.databind.deser.NullValueProvider.getNullValue.

Method that can be called to determine value to be used for representing null values (values deserialized when JSON token is JsonToken#VALUE_NULL).

Inherited from tools.jackson.databind.ValueDeserializer:
deserializedeserializeWithTypedeserializeWithTypefindBackReferencegetAbsentValuegetDelegateegetEmptyAccessPatterngetEmptyValuegetKnownPropertyNamesgetObjectIdReaderhandledTypeisCachablelogicalTypereplaceDelegateeresolvesupportsUpdateunwrappingDeserializer

Field Detail

_targetTypeback to summary
private final JavaType _targetType

Constructor Detail

IonValueDeserializerback to summary
public IonValueDeserializer()
IonValueDeserializerback to summary
public IonValueDeserializer(JavaType targetType)

Method Detail

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 IonValue deserialize(JsonParser jp, 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
getIonContainerTypeback to summary
private IonType getIonContainerType()
getNullAccessPatternback to summary
public AccessPattern getNullAccessPattern()

Overrides tools.jackson.databind.ValueDeserializer.getNullAccessPattern.

Implements tools.jackson.databind.deser.NullValueProvider.getNullAccessPattern.

Doc from tools.jackson.databind.ValueDeserializer.getNullAccessPattern.

This method may be called in conjunction with calls to getNullValue(DeserializationContext), to check whether it needs to be called just once (static values), or each time empty value is needed.

Default implementation indicates that the "null value" to use for input null does not vary across uses so that getNullValue(DeserializationContext) need not be called more than once per deserializer instance. This information may be used as optimization.

Annotations
@Override
getNullValueback to summary
public Object getNullValue(DeserializationContext ctxt) throws JacksonException

Overrides tools.jackson.databind.ValueDeserializer.getNullValue.

Implements tools.jackson.databind.deser.NullValueProvider.getNullValue.

Doc from tools.jackson.databind.ValueDeserializer.getNullValue.

Method that can be called to determine value to be used for representing null values (values deserialized when JSON token is JsonToken#VALUE_NULL). Usually this is simply Java null, but for some types (especially primitives) it may be necessary to use non-null values.

This method may be called once, or multiple times, depending on what getNullAccessPattern() returns.

Default implementation simply returns null.

Annotations
@Override