com.devonfw.cobigen.impl.config.ContextConfiguration 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.io.File;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import com.devonfw.cobigen.api.exception.InvalidConfigurationException;
import com.devonfw.cobigen.impl.config.entity.Trigger;
import com.devonfw.cobigen.impl.config.reader.ContextConfigurationReader;

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

    /**
     * All available {@link Trigger}s
     */
    private Map triggers;

    /**
     * Path of the configuration. Might point to a folder or a jar or maybe even something different in
     * future.
     */
    private Path configurationPath;

    /**
     * Creates a new {@link ContextConfiguration} with the contents initially loaded from the context.xml
     * @param configRoot
     *            root path for the configuration of CobiGen
     * @throws InvalidConfigurationException
     *             thrown if the {@link File} is not valid with respect to the context.xsd
     */
    public ContextConfiguration(Path configRoot) throws InvalidConfigurationException {
        configurationPath = configRoot;
        readConfiguration(configRoot);
    }

    /**
     * Reads the configuration from the given path
     * @param configRoot
     *            CobiGen configuration root path
     * @throws InvalidConfigurationException
     *             thrown if the {@link File} is not valid with respect to the context.xsd
     */
    private void readConfiguration(Path configRoot) throws InvalidConfigurationException {
        ContextConfigurationReader reader = new ContextConfigurationReader(configRoot);
        configurationPath = reader.getContextRoot();
        triggers = reader.loadTriggers();
    }

    /**
     * Reloads the configuration from source. This function might be called if the configuration file has
     * changed in a running system
     * @param configRoot
     *            CobiGen configuration root path
     * @throws InvalidConfigurationException
     *             thrown if the {@link File} is not valid with respect to the context.xsd
     */
    public void reloadConfigurationFromFile(Path configRoot) throws InvalidConfigurationException {
        readConfiguration(configRoot);
    }

    /**
     * Returns all registered {@link Trigger}s
     * @return all registered {@link Trigger}s
     */
    public List getTriggers() {
        return new ArrayList<>(triggers.values());
    }

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

    /**
     * Returns the configuration's {@link Path} represented by this object.
     * @return the {@link Path}
     */
    public Path getConfigurationPath() {
        return configurationPath;
    }

}