org.jboss.shrinkwrap.resolver.impl.maven

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

java.lang.Object

org.jboss.shrinkwrap.resolver.impl.maven.ResolveStageBaseImpl<RESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>

org.jboss.shrinkwrap.resolver.impl.maven.PomlessResolveStageBaseImpl<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>

All Implemented Interfaces:

MavenResolveStageBase<UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>, MavenResolveWithRangeSupportStageBase, PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>, ResolveStage<MavenDependency,MavenResolutionFilter,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,MavenResolvedArtifact,FORMATSTAGETYPE,MavenResolutionStrategy>, ResolveWithRangeSupportStage<MavenDependency,MavenCoordinate,MavenResolutionFilter,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,MavenResolvedArtifact,FORMATSTAGETYPE,MavenResolutionStrategy,MavenVersionRangeResult>, MavenWorkingSessionContainer

public abstract class PomlessResolveStageBaseImpl<EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>
extends ResolveStageBaseImpl<RESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>
implements PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>

Base support for implementations of a PomlessResolveStage

Author:

Andrew Lee Rubinger, Karel Piwko

Constructor Summary

Constructors

Constructor and Description
PomlessResolveStageBaseImpl(MavenWorkingSession session)

Method Summary

Modifier and Type	Method and Description
protected abstract EQUIPPEDRESOLVESTAGETYPE	createNewPomEquippedResolveStage() Obtains a new PomEquippedResolveStageBase instance for the current MavenWorkingSession
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.
MavenVersionRangeResult	resolveVersionRange(String coordinate) Performs version range resolution of specified artifact defined in canonical form.

Methods inherited from class org.jboss.shrinkwrap.resolver.impl.maven.ResolveStageBaseImpl

addDependencies, addDependencies, addDependency, createStrategyStage, getActualClass, getMavenWorkingSession, resolve, resolve, resolve, resolve, resolveVersion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Constructor Detail

PomlessResolveStageBaseImpl

public PomlessResolveStageBaseImpl(MavenWorkingSession session)

Method Detail

loadPomFromFile

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

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

Specified by:

loadPomFromFile in interface PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>

Parameters:

pomFile - The File representing a POM file

profiles - List of profiles to activated/disabled Active/inactive profiles

Returns:

A new PomEquippedResolveStageBase instance for the current MavenWorkingSession

Throws:

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

See Also:

PomlessResolveStageBase.loadPomFromFile(java.io.File, java.lang.String[])

loadPomFromFile

public final EQUIPPEDRESOLVESTAGETYPE loadPomFromFile(String pathToPomFile,
                                                      String... profiles)
                                               throws IllegalArgumentException

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(String)

Specified by:

loadPomFromFile in interface PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>

Parameters:

pathToPomFile - The path to a POM file

profiles - List of profiles to activated/disabled Active/inactive profiles

Returns:

A new PomEquippedResolveStageBase instance for the current MavenWorkingSession

Throws:

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

See Also:

PomlessResolveStageBase.loadPomFromFile(java.lang.String, java.lang.String[])

loadPomFromFile

public final EQUIPPEDRESOLVESTAGETYPE loadPomFromFile(File pomFile)
                                               throws IllegalArgumentException,
                                                      InvalidConfigurationFileException

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

Specified by:

loadPomFromFile in interface PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>

Parameters:

pomFile - The File representing a POM file

Returns:

A new PomEquippedResolveStageBase instance for the current MavenWorkingSession

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

See Also:

PomlessResolveStageBase.loadPomFromFile(java.io.File)

loadPomFromFile

public final 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(String)

Specified by:

loadPomFromFile in interface PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>

Parameters:

pathToPomFile - The path to a POM file

Returns:

A new PomEquippedResolveStageBase instance for the current MavenWorkingSession

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

See Also:

PomlessResolveStageBase.loadPomFromFile(java.lang.String)

loadPomFromClassLoaderResource

public final 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().

Specified by:

loadPomFromClassLoaderResource in interface PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>

Parameters:

pathToPomResource - The ClassLoader resource path to a POM file.

Returns:

A new PomEquippedResolveStageBase instance for the current MavenWorkingSession

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

See Also:

PomlessResolveStageBase.loadPomFromClassLoaderResource(java.lang.String)

loadPomFromClassLoaderResource

public final 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.

Specified by:

loadPomFromClassLoaderResource in interface PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>

Parameters:

pathToPomResource - The ClassLoader resource path to a POM file.

cl - The ClassLoader

Returns:

A new PomEquippedResolveStageBase instance for the current MavenWorkingSession

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

See Also:

PomlessResolveStageBase.loadPomFromClassLoaderResource(java.lang.String, java.lang.ClassLoader)

loadPomFromClassLoaderResource

public final 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.

Specified by:

loadPomFromClassLoaderResource in interface PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>

Parameters:

pathToPomResource - The ClassLoader resource path to a POM file.

cl - The ClassLoader

profiles - List of profiles to activated/disabled Active/inactive profiles

Returns:

A new PomEquippedResolveStageBase instance for the current 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

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

See Also:

PomlessResolveStageBase.loadPomFromClassLoaderResource(java.lang.String, java.lang.ClassLoader, java.lang.String[])

createNewPomEquippedResolveStage

protected abstract EQUIPPEDRESOLVESTAGETYPE createNewPomEquippedResolveStage()

Obtains a new PomEquippedResolveStageBase instance for the current MavenWorkingSession

Returns:

A new PomEquippedResolveStageBase instance for the current MavenWorkingSession

resolveVersionRange

public MavenVersionRangeResult resolveVersionRange(String coordinate)
                                            throws IllegalArgumentException

Performs version range resolution of specified artifact defined in canonical form. Returns info about available versions.

Parameters:

coordinate - coordinate in canonical form containing version range: Maven doc}

Returns:

A info about available versions.StrategyStage

Throws:

IllegalArgumentException - If no coordinate is supplied

See Also:

ResolveWithRangeSupportStage.resolveVersionRange(String)