com.fasterxml.jackson.module.kotlin.WrapsNullableValueClassDeserializer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jackson-module-kotlin Show documentation

Add-on module for Jackson (https://github.com/FasterXML/jackson/) to support Kotlin language, specifically introspection of method/constructor parameter names, without having to add explicit property name annotation.

There is a newer version: 2.18.2

Show newest version

package com.fasterxml.jackson.module.kotlin;

import com.fasterxml.jackson.core.JacksonException;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JavaType;
import com.fasterxml.jackson.databind.deser.std.StdDeserializer;
import kotlin.jvm.JvmClassMappingKt;
import kotlin.reflect.KClass;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.io.IOException;

/**
 * An interface to be inherited by JsonDeserializer that handles value classes that may wrap nullable.
 */
// To ensure maximum compatibility with StdDeserializer, this class is written in Java.
public abstract class WrapsNullableValueClassDeserializer extends StdDeserializer {
    protected WrapsNullableValueClassDeserializer(@NotNull KClass vc) {
        super(JvmClassMappingKt.getJavaClass(vc));
    }

    protected WrapsNullableValueClassDeserializer(@NotNull Class vc) {
        super(vc);
    }

    protected WrapsNullableValueClassDeserializer(@NotNull JavaType valueType) {
        super(valueType);
    }

    protected WrapsNullableValueClassDeserializer(@NotNull StdDeserializer src) {
        super(src);
    }

    @Override
    @NotNull
    public final Class handledType() {
        //noinspection unchecked
        return (Class) super.handledType();
    }

    /**
     * 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.
     */
    // It is defined so that null can also be returned so that Nulls.SKIP can be applied.
    @Nullable
    public abstract D getBoxedNullValue();

    @Override
    public abstract D deserialize(@NotNull JsonParser p, @NotNull DeserializationContext ctxt)
            throws IOException, JacksonException;
}