com.buschmais.jqassistant.scm.maven.provider.ConfigurationProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jqassistant-maven-plugin Show documentation

jQAssistant plugin for Apache Maven to integrate jQAssistant into a Maven based project.

There is a newer version: 2.5.0

Show newest version

package com.buschmais.jqassistant.scm.maven.provider;

import java.io.File;
import java.util.List;

import com.buschmais.jqassistant.core.runtime.api.configuration.ConfigurationLoader;
import com.buschmais.jqassistant.core.runtime.impl.configuration.ConfigurationLoaderImpl;
import com.buschmais.jqassistant.scm.maven.configuration.MavenConfiguration;

import org.codehaus.plexus.component.annotations.Component;
import org.eclipse.microprofile.config.spi.ConfigSource;

/**
 * Provides the runtime {@link MavenConfiguration} for jQAssistant within a Maven reactor.
 * 
 * Declared as singleton to allow caching the {@link ConfigurationLoader} instance.
 */
@Component(role = ConfigurationProvider.class, instantiationStrategy = "singleton")
public class ConfigurationProvider {

    /**
     * The ordinal for config sources from the plugin execution configuration.
     */
    public static final int ORDINAL_PLUGIN_EXECUTION = 90;

    /**
     * Cached {@link ConfigurationLoader} instance.
     */
    private ConfigurationLoader configurationLoader;

    /**
     * Return the Configuration.
     *
     * @param executionRoot
     *     The Session execution root.
     * @param configLocations
     *     The config locations directory.
     * @param configSources
     *     Additional {@link ConfigSource}s.
     * @return The {@link MavenConfiguration}.
     */
    public MavenConfiguration getConfiguration(File executionRoot, List configLocations, ConfigSource... configSources) {
        if (configurationLoader == null) {
            File userHome = new File(System.getProperty("user.home"));
            configurationLoader = new ConfigurationLoaderImpl<>(MavenConfiguration.class, userHome, executionRoot, configLocations);
        }
        return configurationLoader.load(configSources);
    }

}