org.jboss.shrinkwrap.resolver.impl.maven

Class ConfigurableMavenResolverSystemBaseImpl<UNCONFIGURABLERESOLVERSYSTEMTYPE extends MavenResolverSystemBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,CONFIGURALBERESOLVERSYSTEMTYPE extends ConfigurableMavenResolverSystemBase<UNCONFIGURABLERESOLVERSYSTEMTYPE,CONFIGURALBERESOLVERSYSTEMTYPE,EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,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.MavenResolverSystemBaseImpl<UNCONFIGURABLERESOLVERSYSTEMTYPE,CONFIGURALBERESOLVERSYSTEMTYPE,EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>

org.jboss.shrinkwrap.resolver.impl.maven.ConfigurableMavenResolverSystemBaseImpl<UNCONFIGURABLERESOLVERSYSTEMTYPE,CONFIGURALBERESOLVERSYSTEMTYPE,EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>

All Implemented Interfaces:

ConfigurableResolverSystem<UNCONFIGURABLERESOLVERSYSTEMTYPE>, ConfigurableMavenResolverSystemBase<UNCONFIGURABLERESOLVERSYSTEMTYPE,CONFIGURALBERESOLVERSYSTEMTYPE,EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>, MavenResolverSystemBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>, MavenResolveStageBase<UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>, PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>, ResolverSystem, ResolveStage<MavenDependency,MavenResolutionFilter,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,MavenResolvedArtifact,FORMATSTAGETYPE,MavenResolutionStrategy>, ResolveWithRangeSupportStage<MavenDependency,MavenCoordinate,MavenResolutionFilter,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,MavenResolvedArtifact,FORMATSTAGETYPE,MavenResolutionStrategy,MavenVersionRangeResult>

Direct Known Subclasses:

ConfigurableMavenResolverSystemImpl

public abstract class ConfigurableMavenResolverSystemBaseImpl<UNCONFIGURABLERESOLVERSYSTEMTYPE extends MavenResolverSystemBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,CONFIGURALBERESOLVERSYSTEMTYPE extends ConfigurableMavenResolverSystemBase<UNCONFIGURABLERESOLVERSYSTEMTYPE,CONFIGURALBERESOLVERSYSTEMTYPE,EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>
extends MavenResolverSystemBaseImpl<UNCONFIGURABLERESOLVERSYSTEMTYPE,CONFIGURALBERESOLVERSYSTEMTYPE,EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>
implements ConfigurableMavenResolverSystemBase<UNCONFIGURABLERESOLVERSYSTEMTYPE,CONFIGURALBERESOLVERSYSTEMTYPE,EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>

Base support for implementations of ConfigurableMavenResolverSystem

Author:

Andrew Lee Rubinger

Constructor Summary

Constructors

Constructor and Description
ConfigurableMavenResolverSystemBaseImpl(UNEQUIPPEDRESOLVESTAGETYPE delegate)

Method Summary

Methods

Modifier and Type	Method and Description
UNCONFIGURABLERESOLVERSYSTEMTYPE	configureFromClassloaderResource(String path) Optional operation.
UNCONFIGURABLERESOLVERSYSTEMTYPE	configureFromClassloaderResource(String path, ClassLoader loader) Optional operation.
UNCONFIGURABLERESOLVERSYSTEMTYPE	configureFromFile(File file) Optional operation.
UNCONFIGURABLERESOLVERSYSTEMTYPE	configureFromFile(String pathToFile) Optional operation.
EQUIPPEDRESOLVESTAGETYPE	configureViaPlugin() Configures the current session from POM metadata found via the ShrinkWrap Resolver Maven Plugin; retrieves information from the currently-running Maven process.
protected abstract EQUIPPEDRESOLVESTAGETYPE	createPomEquippedResolveStage() Returns a new EQUIPPEDRESOLVESTAGETYPE for the current session
protected abstract UNCONFIGURABLERESOLVERSYSTEMTYPE	getUnconfigurableView() Returns the UNCONFIGURABLERESOLVERSYSTEMTYPE view type of this ConfigurableMavenResolverSystemBase

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

addDependencies, addDependencies, addDependency, getSession, loadPomFromClassLoaderResource, loadPomFromClassLoaderResource, loadPomFromClassLoaderResource, loadPomFromFile, loadPomFromFile, loadPomFromFile, loadPomFromFile, offline, offline, resolve, resolve, resolve, resolve, resolveVersionRange

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.maven.MavenResolverSystemBase

offline, offline

Methods inherited from interface org.jboss.shrinkwrap.resolver.api.maven.PomlessResolveStageBase

loadPomFromClassLoaderResource, loadPomFromClassLoaderResource, loadPomFromClassLoaderResource, loadPomFromFile, loadPomFromFile, loadPomFromFile, loadPomFromFile

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

ConfigurableMavenResolverSystemBaseImpl

public ConfigurableMavenResolverSystemBaseImpl(UNEQUIPPEDRESOLVESTAGETYPE delegate)
                                        throws IllegalArgumentException

Parameters:

delegate -

Throws:

IllegalArgumentException

Method Detail

configureFromFile

public final UNCONFIGURABLERESOLVERSYSTEMTYPE configureFromFile(File file)
                                                                                                                                                                                throws IllegalArgumentException,
                                                                                                                                                                                       UnsupportedOperationException,
                                                                                                                                                                                       InvalidConfigurationFileException

Optional operation. Configures this ConfigurableResolverSystem from the specified file

Specified by:

configureFromFile in interface ConfigurableResolverSystem<UNCONFIGURABLERESOLVERSYSTEMTYPE extends MavenResolverSystemBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>>

Returns:

This configured ResolverSystem

Throws:

IllegalArgumentException - If the file is not specified, is a directory, or does not exist

UnsupportedOperationException - If this ConfigurableResolverSystem does not support configuration by File

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

See Also:

ConfigurableResolverSystem.configureFromFile(java.io.File)

configureFromFile

public final UNCONFIGURABLERESOLVERSYSTEMTYPE configureFromFile(String pathToFile)
                                                                                                                                                                                throws IllegalArgumentException,
                                                                                                                                                                                       UnsupportedOperationException,
                                                                                                                                                                                       InvalidConfigurationFileException

Optional operation. Configures this ConfigurableResolverSystem from the file at the specified path

Specified by:

configureFromFile in interface ConfigurableResolverSystem<UNCONFIGURABLERESOLVERSYSTEMTYPE extends MavenResolverSystemBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>>

Returns:

This configured ResolverSystem

Throws:

IllegalArgumentException - If the file is not specified, is a directory, or does not exist

UnsupportedOperationException - If this ConfigurableResolverSystem does not support configuration by File

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

See Also:

ConfigurableResolverSystem.configureFromFile(java.lang.String)

configureFromClassloaderResource

public final UNCONFIGURABLERESOLVERSYSTEMTYPE configureFromClassloaderResource(String path)
                                                                                                                                                                                               throws IllegalArgumentException,
                                                                                                                                                                                                      UnsupportedOperationException,
                                                                                                                                                                                                      InvalidConfigurationFileException

Optional operation. Configures this ConfigurableResolverSystem from the result of ClassLoader.getResource(String) using the current Thread.getContextClassLoader()

Specified by:

configureFromClassloaderResource in interface ConfigurableResolverSystem<UNCONFIGURABLERESOLVERSYSTEMTYPE extends MavenResolverSystemBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>>

Returns:

This configured ResolverSystem

Throws:

IllegalArgumentException - If the either argument is not specified or if the path can not be found

UnsupportedOperationException - If this ConfigurableResolverSystem does not support configuration by ClassLoader resource

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

See Also:

ConfigurableResolverSystem.configureFromClassloaderResource(java.lang.String)

configureFromClassloaderResource

public final UNCONFIGURABLERESOLVERSYSTEMTYPE configureFromClassloaderResource(String path,
                                                                ClassLoader loader)
                                                                                                                                                                                               throws IllegalArgumentException,
                                                                                                                                                                                                      UnsupportedOperationException,
                                                                                                                                                                                                      InvalidConfigurationFileException

Optional operation. Configures this ConfigurableResolverSystem from the result of ClassLoader.getResource(String) using the specified ClassLoader

Specified by:

configureFromClassloaderResource in interface ConfigurableResolverSystem<UNCONFIGURABLERESOLVERSYSTEMTYPE extends MavenResolverSystemBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>>

Returns:

This configured ResolverSystem

Throws:

IllegalArgumentException - If the either argument is not specified or if the path can not be found

UnsupportedOperationException - If this ConfigurableResolverSystem does not support configuration by ClassLoader resource

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

See Also:

ConfigurableResolverSystem.configureFromClassloaderResource(java.lang.String, java.lang.ClassLoader)

configureViaPlugin

public final EQUIPPEDRESOLVESTAGETYPE configureViaPlugin()
                                                                                                                                                  throws InvalidEnvironmentException

Configures the current session from POM metadata found via the ShrinkWrap Resolver Maven Plugin; retrieves information from the currently-running Maven process.

Specified by:

configureViaPlugin in interface ConfigurableMavenResolverSystemBase<UNCONFIGURABLERESOLVERSYSTEMTYPE extends MavenResolverSystemBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,CONFIGURALBERESOLVERSYSTEMTYPE extends ConfigurableMavenResolverSystemBase<UNCONFIGURABLERESOLVERSYSTEMTYPE,CONFIGURALBERESOLVERSYSTEMTYPE,EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>

Returns:

Throws:

InvalidEnvironmentException - If the currently-executing environment is not under the control of the ShrinkWrap Resolver Maven Plugin

See Also:

ConfigurableMavenResolverSystemBase.configureViaPlugin()

getUnconfigurableView

protected abstract UNCONFIGURABLERESOLVERSYSTEMTYPE getUnconfigurableView()

Returns the UNCONFIGURABLERESOLVERSYSTEMTYPE view type of this ConfigurableMavenResolverSystemBase

Returns:

createPomEquippedResolveStage

protected abstract EQUIPPEDRESOLVESTAGETYPE createPomEquippedResolveStage()

Returns a new EQUIPPEDRESOLVESTAGETYPE for the current session

Returns: