io.micronaut.starter.feature.chatbots.ChatBots 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-2024 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.chatbots;

import io.micronaut.core.annotation.NonNull;
import io.micronaut.starter.application.generator.GeneratorContext;
import io.micronaut.starter.feature.FeatureContext;
import io.micronaut.starter.feature.validator.MicronautValidationFeature;
import io.micronaut.starter.feature.validator.ValidationFeature;
import io.micronaut.starter.options.BuildTool;
import io.micronaut.starter.template.RockerTemplate;

/**
 * Base class for chatbot features.
 * 
 * Used to template out the common code between the chatbot features.
 *
 * @author Tim Yates
 * @since 4.3.0
 */
public abstract class ChatBots implements ChatBotsFeature {

    private final MicronautValidationFeature validationFeature;

    protected ChatBots(MicronautValidationFeature validationFeature) {
        this.validationFeature = validationFeature;
    }

    protected abstract void renderTemplates(@NonNull GeneratorContext generatorContext);

    @Override
    public void apply(GeneratorContext generatorContext) {
        addDependencies(generatorContext);
        addConfigurations(generatorContext);
        renderTemplates(generatorContext);
    }

    @Override
    public void processSelectedFeatures(FeatureContext featureContext) {
        featureContext.addFeatureIfNotPresent(ValidationFeature.class, validationFeature);
    }

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

    protected abstract void addDependencies(@NonNull GeneratorContext generatorContext);

    protected abstract void addConfigurations(@NonNull GeneratorContext generatorContext);

    @NonNull
    protected abstract ChatBotType getChatBotType();

    @NonNull
    protected abstract RockerTemplate rootReadMeTemplate(@NonNull GeneratorContext generatorContext);

    @NonNull
    protected abstract String getBuildCommand(@NonNull BuildTool buildTool);
}