Top Description Fields Constructors Methods
tools.jackson.module.kotlin

public abstract Class WrapsNullableValueClassDeserializer<D>

extends StdDeserializer<D>
Class Inheritance
Imports
kotlin.jvm.JvmClassMappingKt, kotlin.reflect.KClass, org.jetbrains.annotations.NotNull, .Nullable, tools.jackson.core.JacksonException, .JsonParser, tools.jackson.databind.DeserializationContext, .JavaType, tools.jackson.databind.deser.std.StdDeserializer
An interface to be inherited by JsonDeserializer that handles value classes that may wrap nullable.

Field Summary

Inherited from tools.jackson.databind.deser.std.StdDeserializer:
_valueClass_valueTypeF_MASK_INT_COERCIONS

Constructor Summary

AccessConstructor and Description
protected
WrapsNullableValueClassDeserializer(@NotNull kotlin.reflect.KClass<?> vc)

protected
WrapsNullableValueClassDeserializer(@NotNull Class<?> vc)

protected
WrapsNullableValueClassDeserializer(@NotNull JavaType valueType)

protected
WrapsNullableValueClassDeserializer(@NotNull StdDeserializer<D> src)

Method Summary

Modifier and TypeMethod and Description
public abstract D
deserialize(@NotNull JsonParser p, @NotNull 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 abstract D
getBoxedNullValue()

If the parameter definition is a value class that wraps a nullable and is non-null, and the input to JSON is explicitly null, this value is used.

public final @NotNull Class<D>
handledType()

Overrides tools.jackson.databind.deser.std.StdDeserializer.handledType.

Method for accessing concrete physical type of values this deserializer produces.

Inherited from tools.jackson.databind.deser.std.StdDeserializer:
_byteOverflow_checkBooleanToStringCoercion_checkCoercionFail_checkDoubleSpecialValue_checkFloatSpecialValue_checkFloatToIntCoercion_checkFloatToStringCoercion_checkFromStringCoercion_checkFromStringCoercion_checkIntToFloatCoercion_checkIntToStringCoercion_checkTextualNull_checkToStringCoercion_coerceBooleanFromInt_coercedTypeDesc_coercedTypeDesc_coerceIntegral_deserializeFromArray_deserializeFromEmptyString_deserializeFromString_deserializeWrappedValue_findCoercionFromBlankString_findCoercionFromEmptyArray_findCoercionFromEmptyString_findNullProvider_hasTextualNull_intOverflow_isBlank_isFalse_isIntNumber_isNaN_isNegInf_isPosInf_isTrue_neitherNull_nonNullNumber_parseBoolean_parseBooleanPrimitive_parseBytePrimitive_parseDate_parseDate_parseDateFromArray_parseDouble_parseDoublePrimitive_parseDoublePrimitive_parseFloatPrimitive_parseFloatPrimitive_parseInteger_parseInteger_parseIntPrimitive_parseIntPrimitive_parseLong_parseLong_parseLongPrimitive_parseLongPrimitive_parseShortPrimitive_parseString_reportFailedNullCoerce_shortOverflow_verifyEndArrayForSingle_verifyNullForPrimitive_verifyNullForPrimitiveCoercion_wrapIOFailuredeserializeWithTypefindContentNullProviderfindContentNullStylefindConvertingContentDeserializerfindDeserializerfindFormatFeaturefindFormatOverridesfindValueNullProvidergetValueInstantiatorgetValueTypegetValueTypehandleMissingEndArrayForSinglehandleNestedArrayForSinglehandleUnknownPropertyisDefaultDeserializerisDefaultKeyDeserializer

Constructor Detail

WrapsNullableValueClassDeserializerback to summary
protected WrapsNullableValueClassDeserializer(@NotNull kotlin.reflect.KClass<?> vc)
WrapsNullableValueClassDeserializerback to summary
protected WrapsNullableValueClassDeserializer(@NotNull Class<?> vc)
WrapsNullableValueClassDeserializerback to summary
protected WrapsNullableValueClassDeserializer(@NotNull JavaType valueType)
WrapsNullableValueClassDeserializerback to summary
protected WrapsNullableValueClassDeserializer(@NotNull StdDeserializer<D> src)

Method Detail

deserializeback to summary
public abstract D deserialize(@NotNull JsonParser p, @NotNull 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
getBoxedNullValueback to summary
public abstract D getBoxedNullValue()

If the parameter definition is a value class that wraps a nullable and is non-null, and the input to JSON is explicitly null, this value is used. Note that this will only be called from the KotlinValueInstantiator, so it will not work for top-level deserialization of value classes.

Annotations
@Nullable
handledTypeback to summary
public final @NotNull Class<D> handledType()

Overrides tools.jackson.databind.deser.std.StdDeserializer.handledType.

Doc from tools.jackson.databind.ValueDeserializer.handledType.

Method for accessing concrete physical type of values this deserializer produces. Note that this information is not guaranteed to be exact -- it may be a more generic (super-type) -- but it should not be incorrect (return a non-related type).

Default implementation will return null, which means almost same same as returning Object.class would; that is, that nothing is known about handled type.

Annotations
@Override
@NotNull