io.micronaut.starter.feature.json.SerializationFeature Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micronaut-starter-core Show documentation

Generates Micronaut applications

There is a newer version: 4.7.0

Show newest version

/*
 * Copyright 2017-2022 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.starter.feature.json;

import io.micronaut.core.annotation.NonNull;
import io.micronaut.starter.application.ApplicationType;
import io.micronaut.starter.application.generator.GeneratorContext;
import io.micronaut.starter.build.dependencies.Dependency;
import io.micronaut.starter.build.dependencies.MicronautDependencyUtils;
import io.micronaut.starter.feature.Category;
import io.micronaut.starter.options.BuildTool;

import java.util.ArrayList;
import java.util.List;

import static io.micronaut.starter.build.dependencies.MicronautDependencyUtils.GROUP_ID_MICRONAUT_SERDE;

public interface SerializationFeature extends JsonFeature {
    String MICRONAUT_SERIALIZATION = "micronaut.serialization";
    String ARTIFACT_ID_MICRONAUT_JACKSON_CORE = "micronaut-jackson-core";
    String ARTIFACT_ID_MICRONAUT_SERDE_PROCESSOR = "micronaut-serde-processor";

    @Override
    default String getCategory() {
        return Category.API;
    }

    @Override
    default String getMicronautDocumentation() {
        return "https://micronaut-projects.github.io/micronaut-serialization/latest/guide/";
    }

    @Override
    default boolean supports(ApplicationType applicationType) {
        return true;
    }

    @Override
    default void apply(GeneratorContext generatorContext) {
        dependencies(generatorContext)
                .forEach(generatorContext::addDependency);
    }

    @NonNull
    default List dependencies(@NonNull GeneratorContext generatorContext) {
        List dependencyList = new ArrayList<>();
        dependencyList.add(serdeProcessor(generatorContext.getBuildTool()));
        dependencyList.add(serdeModule(generatorContext));
        return dependencyList;
    }

    @NonNull
    default Dependency.Builder serdeModule(@NonNull GeneratorContext generatorContext) {
        return MicronautDependencyUtils.serdeDependency()
                .compile()
                .artifactId("micronaut-serde-" + getModule());
    }

    @NonNull
    default Dependency.Builder serdeProcessor(BuildTool buildTool) {
        return MicronautDependencyUtils.annotationProcessor(buildTool,
                GROUP_ID_MICRONAUT_SERDE, ARTIFACT_ID_MICRONAUT_SERDE_PROCESSOR, "micronaut.serialization.version");
    }

    String getModule();
}