io.micronaut.serde.DeserializerLocator Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of micronaut-serde-api Show documentation

Enables serialization/deserialization in Micronaut applications using build time information

There is a newer version: 2.11.0

/*
 * Copyright 2017-2021 original authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.micronaut.serde;

import java.util.Collection;

import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.beans.BeanIntrospection;
import io.micronaut.core.type.Argument;
import io.micronaut.serde.exceptions.SerdeException;

/**
 * Locator strategy interface for deserializers.
 *
 * @since 1.0.0
 */
public interface DeserializerLocator {
    /**
     * Gets a custom deserializer.
     * @param deserializerClass The deserializer class, should not be {@code null}
     * @param  The generic type
     * @param  The deserializer type
     * @return The deserializer
     * @throws io.micronaut.serde.exceptions.SerdeException if no deserializer is found
     */
    @NonNull
    > D findCustomDeserializer(@NonNull Class deserializerClass)
            throws SerdeException;

    /**
     * Finds a deserializer for the given type.
     * @param type The type, should not be {@code null}
     * @param  The generic type
     * @return The deserializer
     * @throws io.micronaut.serde.exceptions.SerdeException if no deserializer is found
     */
    @NonNull  Deserializer findDeserializer(@NonNull Argument type)
            throws SerdeException;

    /**
     * Finds a deserializer for the given type.
     * @param type The type, should not be {@code null}
     * @param  The generic type
     * @return The deserializer
     * @throws io.micronaut.serde.exceptions.SerdeException if no deserializer is found
     */
    default @NonNull  Deserializer findDeserializer(@NonNull Class type)
            throws SerdeException {
        return findDeserializer(Argument.of(type));
    }

    /**
     * Locates desrializable subtypes for the given super type.
     * @param superType The super type
     * @param  The generic super type
     * @return The subtypes, never null
     */
     Collection> getDeserializableSubtypes(Class superType);
}