Top Description Constructors Methods
com.fasterxml.jackson.dataformat.ion.ionvalue

pack-priv Class IonValueDeserializer

extends JsonDeserializer<IonValue>
Class Inheritance
Imports
java.io.IOException, com.fasterxml.jackson.core.JsonParser, .JsonToken, com.fasterxml.jackson.databind.DeserializationContext, .JsonMappingException, .JsonDeserializer, com.fasterxml.jackson.databind.util.AccessPattern, com.fasterxml.jackson.dataformat.ion.IonParser, com.amazon.ion.IonSystem, .IonValue, .Timestamp

Deserializer that knows how to deserialize an IonValue.

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public IonValue
deserialize(JsonParser
Parser used for reading JSON content
jp
,
DeserializationContext
Context that can be used to access information about this deserialization activity.
ctxt
)

Implements abstract com.fasterxml.jackson.databind.JsonDeserializer.deserialize.

Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles.

public AccessPattern
getNullAccessPattern()

Overrides com.fasterxml.jackson.databind.JsonDeserializer.getNullAccessPattern.

Implements com.fasterxml.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 IonValue
getNullValue(DeserializationContext ctxt)

Overrides com.fasterxml.jackson.databind.JsonDeserializer.getNullValue.

Implements com.fasterxml.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 com.fasterxml.jackson.databind.JsonDeserializer:
deserializedeserializeWithTypedeserializeWithTypefindBackReferencegetAbsentValuegetDelegateegetEmptyAccessPatterngetEmptyValuegetEmptyValuegetKnownPropertyNamesgetNullValuegetObjectIdReaderhandledTypeisCachablelogicalTypereplaceDelegateesupportsUpdateunwrappingDeserializer

Constructor Detail

IonValueDeserializerback to summary
pack-priv IonValueDeserializer()

Method Detail

deserializeback to summary
public IonValue deserialize(JsonParser jp, DeserializationContext ctxt) throws IOException

Implements abstract com.fasterxml.jackson.databind.JsonDeserializer.deserialize.

Doc from com.fasterxml.jackson.databind.JsonDeserializer.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 JsonDeserializer#getNullValue(DeserializationContext) method is called to produce a null value. To influence null handling, custom deserializers should override JsonDeserializer#getNullValue(DeserializationContext) and usually also JsonDeserializer#getNullAccessPattern().

Parameters
jp:JsonParser

Parser used for reading JSON content

ctxt:DeserializationContext

Context that can be used to access information about this deserialization activity.

Returns:IonValue

Deserialized value

Annotations
@Override
getNullAccessPatternback to summary
public AccessPattern getNullAccessPattern()

Overrides com.fasterxml.jackson.databind.JsonDeserializer.getNullAccessPattern.

Implements com.fasterxml.jackson.databind.deser.NullValueProvider.getNullAccessPattern.

Doc from com.fasterxml.jackson.databind.JsonDeserializer.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 IonValue getNullValue(DeserializationContext ctxt) throws JsonMappingException

Overrides com.fasterxml.jackson.databind.JsonDeserializer.getNullValue.

Implements com.fasterxml.jackson.databind.deser.NullValueProvider.getNullValue.

Doc from com.fasterxml.jackson.databind.JsonDeserializer.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