org.jboss.shrinkwrap.resolver.api.maven

Interface PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>

All Superinterfaces:

MavenResolveStageBase<UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>, ResolveStage<MavenDependency,MavenResolutionFilter,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,MavenResolvedArtifact,FORMATSTAGETYPE,MavenResolutionStrategy>, ResolveWithRangeSupportStage<MavenDependency,MavenCoordinate,MavenResolutionFilter,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,MavenResolvedArtifact,FORMATSTAGETYPE,MavenResolutionStrategy,MavenVersionRangeResult>

All Known Subinterfaces:

ConfigurableMavenResolverSystem, ConfigurableMavenResolverSystemBase<UNCONFIGURABLERESOLVERSYSTEMTYPE,CONFIGURABLERESOLVERSYSTEMTYPE,EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>, MavenResolverSystem, MavenResolverSystemBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>, PomlessResolveStage

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>

Defines the contract for operations denoting a ResolveStage is able to load POM (Project Object Model) metadata

Author:

Andrew Lee Rubinger, Karel Piwko

Method Summary

Methods

Modifier and Type	Method and Description
EQUIPPEDRESOLVESTAGETYPE	loadPomFromClassLoaderResource(String pathToPomResource) Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the specified ClassLoader resource path, loaded by the current Thread.getContextClassLoader().
EQUIPPEDRESOLVESTAGETYPE	loadPomFromClassLoaderResource(String pathToPomResource, ClassLoader cl) Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the specified ClassLoader resource path, loaded by the specified ClassLoader.
EQUIPPEDRESOLVESTAGETYPE	loadPomFromClassLoaderResource(String pathToPomResource, ClassLoader cl, String... profiles) Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the specified ClassLoader resource path, loaded by the specified ClassLoader.
EQUIPPEDRESOLVESTAGETYPE	loadPomFromFile(File pomFile) Configures the Maven Resolver System Project Object Model from metadata contained in the specified POM File.
EQUIPPEDRESOLVESTAGETYPE	loadPomFromFile(File pomFile, String... profiles) Configures the Maven Resolver System Project Object Model from metadata contained in the specified POM File.
EQUIPPEDRESOLVESTAGETYPE	loadPomFromFile(String pathToPomFile) Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the specified path.
EQUIPPEDRESOLVESTAGETYPE	loadPomFromFile(String pathToPomFile, String... profiles) Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the specified path.

Methods inherited from interface org.jboss.shrinkwrap.resolver.api.ResolveWithRangeSupportStage

resolveVersionRange

Methods inherited from interface org.jboss.shrinkwrap.resolver.api.ResolveStage

addDependencies, addDependencies, addDependency, resolve, resolve, resolve, resolve

Method Detail

loadPomFromFile

EQUIPPEDRESOLVESTAGETYPE loadPomFromFile(File pomFile)
                                                                                                                                         throws IllegalArgumentException,
                                                                                                                                                InvalidConfigurationFileException

Configures the Maven Resolver System Project Object Model from metadata contained in the specified POM File.

Parameters:

pomFile -

Returns:

Throws:

IllegalArgumentException - If no file was specified, if the file does not exist or points to a directory

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

loadPomFromFile

EQUIPPEDRESOLVESTAGETYPE loadPomFromFile(File pomFile,
                                       String... profiles)
                                                                                                                                         throws IllegalArgumentException,
                                                                                                                                                InvalidConfigurationFileException

Configures the Maven Resolver System Project Object Model from metadata contained in the specified POM File.

Parameters:

pomFile -

profiles - Active/inactive profiles

Returns:

Throws:

IllegalArgumentException - If no file was specified, if the file does not exist or points to a directory

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

loadPomFromFile

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 File by means of File.File(String)

Parameters:

pathToPomFile -

Returns:

Throws:

IllegalArgumentException - If no path was specified, or if the path points to a file which does not exist or is a directory

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

loadPomFromFile

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 path. The path will be represented as a new File by means of File.File(String)

Parameters:

pathToPomFile -

profiles - Active/inactive profiles

Returns:

Throws:

IllegalArgumentException - If no path was specified, or if the path points to a file which does not exist or is a directory

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

loadPomFromClassLoaderResource

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 ClassLoader resource path, loaded by the current Thread.getContextClassLoader().

Parameters:

pathToPomResource -

Returns:

Throws:

IllegalArgumentException - If no path was specified, or if the resource could not be found at the specified path

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

loadPomFromClassLoaderResource

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 ClassLoader resource path, loaded by the specified ClassLoader.

Parameters:

pathToPomResource -

cl -

Returns:

Throws:

IllegalArgumentException - If no path was specified, no ClassLoader was specified, or if the resource could not be found at the specified path

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format

loadPomFromClassLoaderResource

EQUIPPEDRESOLVESTAGETYPE loadPomFromClassLoaderResource(String pathToPomResource,
                                                      ClassLoader cl,
                                                      String... profiles)
                                                                                                                                                        throws IllegalArgumentException,
                                                                                                                                                               InvalidConfigurationFileException

Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the specified ClassLoader resource path, loaded by the specified ClassLoader.

Parameters:

pathToPomResource -

cl -

profiles - Active/inactive profiles

Returns:

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

InvalidConfigurationFileException - If the configuration file contents are not in appropriate format