PomlessResolveStageBase.java

/*
 * JBoss, Home of Professional Open Source
 * Copyright 2012, Red Hat Middleware LLC, and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * 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
 * http://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 org.jboss.shrinkwrap.resolver.api.maven;

import java.io.File;

import org.jboss.shrinkwrap.resolver.api.InvalidConfigurationFileException;
import org.jboss.shrinkwrap.resolver.api.ResolveStage;

/**
 * Defines the contract for operations denoting a {@link ResolveStage} is able to load POM (Project Object Model)
 * metadata
 *
 * @author <a href="mailto:alr@jboss.org">Andrew Lee Rubinger</a>
 * @author <a href="mailto:kpiwko@redhat.com">Karel Piwko</a>
 */
public interface PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE, STRATEGYSTAGETYPE, FORMATSTAGETYPE>, UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE, UNEQUIPPEDRESOLVESTAGETYPE, STRATEGYSTAGETYPE, FORMATSTAGETYPE>, STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE, FORMATSTAGETYPE>, FORMATSTAGETYPE extends MavenFormatStage>
    extends MavenResolveStageBase<UNEQUIPPEDRESOLVESTAGETYPE, STRATEGYSTAGETYPE, FORMATSTAGETYPE> {

    /**
     * Configures the Maven Resolver System Project Object Model from metadata contained in the specified POM
     * {@link File}.
     *
     * @param pomFile The {@link File} representing a POM file
     * @return A new {@link PomEquippedResolveStageBase} instance for the current {@link MavenWorkingSession}
     * @throws IllegalArgumentException
     *             If no file was specified, if the file does not exist or points to a directory
     * @throws InvalidConfigurationFileException
     *             If the configuration file contents are not in appropriate format
     * @see MavenWorkingSession#loadPomFromFile(File, String...)
     */
    EQUIPPEDRESOLVESTAGETYPE loadPomFromFile(File pomFile) throws IllegalArgumentException,
        InvalidConfigurationFileException;

    /**
     * Configures the Maven Resolver System Project Object Model from metadata contained in the specified POM
     * {@link File}.
     *
     * @param pomFile The {@link File} representing a POM file
     * @param profiles List of profiles to activated/disabled
     *            Active/inactive profiles
     * @return A new {@link PomEquippedResolveStageBase} instance for the current {@link MavenWorkingSession}
     * @throws IllegalArgumentException
     *             If no file was specified, if the file does not exist or points to a directory
     * @throws InvalidConfigurationFileException
     *             If the configuration file contents are not in appropriate format
     * @see MavenWorkingSession#loadPomFromFile(File, String...)
     */
    EQUIPPEDRESOLVESTAGETYPE loadPomFromFile(File pomFile, String... profiles) throws IllegalArgumentException,
        InvalidConfigurationFileException;

    /**
     * Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the
     * specified path. The path will be represented as a new {@link File} by means of {@link File#File(String)}
     *
     * @param pathToPomFile The path to a POM file
     * @return A new {@link PomEquippedResolveStageBase} instance for the current {@link MavenWorkingSession}
     * @throws IllegalArgumentException
     *             If no path was specified, or if the path points to a file which does not exist or is a directory
     * @throws InvalidConfigurationFileException
     *             If the configuration file contents are not in appropriate format
     * @see MavenWorkingSession#loadPomFromFile(File, String...)
     */
    EQUIPPEDRESOLVESTAGETYPE loadPomFromFile(String pathToPomFile) throws IllegalArgumentException,
        InvalidConfigurationFileException;

    /**
     * Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the
     * specified path. The path will be represented as a new {@link File} by means of {@link File#File(String)}
     *
     * @param pathToPomFile The path to a POM file
     * @param profiles List of profiles to activated/disabled
     *            Active/inactive profiles
     * @return A new {@link PomEquippedResolveStageBase} instance for the current {@link MavenWorkingSession}
     * @throws IllegalArgumentException
     *             If no path was specified, or if the path points to a file which does not exist or is a directory
     * @throws InvalidConfigurationFileException
     *             If the configuration file contents are not in appropriate format
     * @see MavenWorkingSession#loadPomFromFile(File, String...)
     */
    EQUIPPEDRESOLVESTAGETYPE loadPomFromFile(String pathToPomFile, String... profiles) throws IllegalArgumentException,
        InvalidConfigurationFileException;

    /**
     * Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the
     * specified {@link ClassLoader} resource path, loaded by the current {@link Thread#getContextClassLoader()}.
     *
     * @param pathToPomResource The {@link ClassLoader} resource path to a POM file.
     * @return A new {@link PomEquippedResolveStageBase} instance for the current {@link MavenWorkingSession}
     * @throws IllegalArgumentException
     *             If no path was specified, or if the resource could not be found at the specified path
     * @throws InvalidConfigurationFileException
     *             If the configuration file contents are not in appropriate format
     * @see MavenWorkingSession#loadPomFromFile(File, String...)
     */
    EQUIPPEDRESOLVESTAGETYPE loadPomFromClassLoaderResource(String pathToPomResource) throws IllegalArgumentException,
        InvalidConfigurationFileException;

    /**
     * Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the
     * specified {@link ClassLoader} resource path, loaded by the specified {@link ClassLoader}.
     *
     * @param pathToPomResource The {@link ClassLoader} resource path to a POM file.
     * @param cl The {@link ClassLoader}
     * @return A new {@link PomEquippedResolveStageBase} instance for the current {@link MavenWorkingSession}
     * @throws IllegalArgumentException
     *             If no path was specified, no ClassLoader was specified, or if the resource could not be found at the
     *             specified path
     * @throws InvalidConfigurationFileException
     *             If the configuration file contents are not in appropriate format
     * @see MavenWorkingSession#loadPomFromFile(File, String...)
     */
    EQUIPPEDRESOLVESTAGETYPE loadPomFromClassLoaderResource(String pathToPomResource, ClassLoader cl)
        throws IllegalArgumentException, InvalidConfigurationFileException;

    /**
     * Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the
     * specified {@link ClassLoader} resource path, loaded by the specified {@link ClassLoader}.
     *
     * @param pathToPomResource The {@link ClassLoader} resource path to a POM file.
     * @param cl The {@link ClassLoader}
     * @param profiles List of profiles to activated/disabled
     *            Active/inactive profiles
     * @return A new {@link PomEquippedResolveStageBase} instance for the current {@link MavenWorkingSession}
     * @throws IllegalArgumentException
     *             If no path was specified, no ClassLoader was specified, any specified profiles are invalid or null,
     *             or if the resource could not be found at the specified path
     * @throws InvalidConfigurationFileException
     *             If the configuration file contents are not in appropriate format
     * @see MavenWorkingSession#loadPomFromFile(File, String...)
     */
    EQUIPPEDRESOLVESTAGETYPE loadPomFromClassLoaderResource(String pathToPomResource, ClassLoader cl,
        String... profiles) throws IllegalArgumentException, InvalidConfigurationFileException;

}