com.devonfw.cobigen.impl.config.TemplatesConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
A Code-based incremental Generator
There is a newer version: 2021.12.006
package com.devonfw.cobigen.impl.config;

import java.nio.file.Path;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;

import com.devonfw.cobigen.api.exception.InvalidConfigurationException;
import com.devonfw.cobigen.api.exception.UnknownExpressionException;
import com.devonfw.cobigen.api.extension.TextTemplateEngine;
import com.devonfw.cobigen.impl.config.entity.Increment;
import com.devonfw.cobigen.impl.config.entity.Template;
import com.devonfw.cobigen.impl.config.entity.Trigger;
import com.devonfw.cobigen.impl.config.reader.TemplatesConfigurationReader;
import com.devonfw.cobigen.impl.exceptions.UnknownContextVariableException;

/**
 * The {@link TemplatesConfiguration} is a configuration data wrapper for all information of a context about
 * templates and the target destination for the generated data.
 */
public class TemplatesConfiguration {

    /** Folder name of the context definition (root folder for all templates) */
    private String templatesFolderName;

    /** All available templates */
    private Map templates;

    /** All available increments */
    private Map increments;

    /** {@link Trigger}, all templates of this configuration depend on */
    private Trigger trigger;

    /** {@link TextTemplateEngine} to be used for the template set covered by this configuration. */
    private String templateEngine;

    /**
     * {@link TemplatesConfigurationReader} to be used for reading external increments
     */
    private TemplatesConfigurationReader externalReader;

    /**
     * Creates a new {@link TemplatesConfiguration} for the given template folder with the given settings
     * reference. We use the configurationHolder to store there all the external TemplatesConfiguration
     *
     * @param configRoot
     *            configuration root path
     * @param trigger
     *            {@link Trigger} of this {@link TemplatesConfiguration}
     * @param configurationHolder
     *            The {@link ConfigurationHolder} used for reading templates folder
     * @throws UnknownContextVariableException
     *             if the destination path contains an undefined context variable
     * @throws UnknownExpressionException
     *             if there is an unknown variable modifier
     * @throws InvalidConfigurationException
     *             if the given templates.xml is not valid
     */
    public TemplatesConfiguration(Path configRoot, Trigger trigger, ConfigurationHolder configurationHolder)
        throws InvalidConfigurationException {

        TemplatesConfigurationReader reader =
            new TemplatesConfigurationReader(configRoot, trigger.getTemplateFolder(), configurationHolder);

        templatesFolderName = trigger.getTemplateFolder();

        templates = reader.loadTemplates(trigger);
        increments = reader.loadIncrements(templates, trigger);
        templateEngine = reader.getTemplateEngine();
        this.trigger = trigger;
    }

    /**
     * Creates a new {@link TemplatesConfiguration} for the given template folder with the given settings
     * reference
     *
     * @param configRoot
     *            configuration root path
     * @param trigger
     *            {@link Trigger} of this {@link TemplatesConfiguration}
     * @param configurationHolder
     *            The {@link ConfigurationHolder} used for reading templates folder
     * @param incrementToSearch
     *            String name of the increment we should retrieve and store
     * @throws UnknownContextVariableException
     *             if the destination path contains an undefined context variable
     * @throws UnknownExpressionException
     *             if there is an unknown variable modifier
     * @throws InvalidConfigurationException
     *             if the given templates.xml is not valid
     */
    public TemplatesConfiguration(Path configRoot, Trigger trigger, ConfigurationHolder configurationHolder,
        String incrementToSearch) throws InvalidConfigurationException {

        externalReader = new TemplatesConfigurationReader(configRoot, trigger.getTemplateFolder(), configurationHolder);
        templatesFolderName = trigger.getTemplateFolder();
        templates = externalReader.loadTemplates(trigger);
        Map externalIncrements =
            externalReader.loadSpecificIncrement(templates, trigger, incrementToSearch);
        increments = new HashMap<>();
        increments.putAll(externalIncrements);
        templateEngine = externalReader.getTemplateEngine();
        this.trigger = trigger;
    }

    /**
     * Returns the {@link Template} with the given id
     *
     * @param id
     *            of the {@link Template} to be searched for
     * @return the {@link Template} with the given id or null if there is no
     */
    public Template getTemplate(String id) {
        return templates.get(id);
    }

    /**
     * Returns the set of all available templates
     *
     * @return the set of all available templates
     */
    public Set