org.jboss.shrinkwrap.resolver.impl.maven

Class MavenStrategyStageBaseImpl<STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>

java.lang.Object

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

All Implemented Interfaces:

MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>, StrategyStage<MavenDependency,MavenResolutionFilter,MavenResolvedArtifact,FORMATSTAGETYPE,MavenResolutionStrategy>, TransitiveStrategyStage<MavenDependency,MavenResolutionFilter,MavenResolvedArtifact,FORMATSTAGETYPE,MavenResolutionStrategy>, MavenWorkingSessionContainer

Direct Known Subclasses:

MavenStrategyStageImpl

public abstract class MavenStrategyStageBaseImpl<STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>
extends Object
implements MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>, MavenWorkingSessionContainer

Base support for implementations of MavenStrategyStage

Author:

Karel Piwko, Andrew Lee Rubinger, Michal Matloka

Constructor Summary

Constructors

Constructor and Description
MavenStrategyStageBaseImpl(MavenWorkingSession session)

Method Summary

Modifier and Type	Method and Description
protected abstract FORMATSTAGETYPE	createFormatStage(Collection<MavenResolvedArtifact> filteredArtifacts) Creates a new MavenFormatStage instance for the current MavenWorkingSession
protected abstract Class<STRATEGYSTAGETYPE>	getActualClass()
MavenWorkingSession	getMavenWorkingSession()
FORMATSTAGETYPE	using(MavenResolutionStrategy strategy) Defines the ResolutionStrategy to be used in resolution, returning the next FormatStage.
STRATEGYSTAGETYPE	withClassPathResolution(boolean useClassPathResolution) Sets that resolution from the ClassPath should be permitted in addition to configured repositories - defaults to "true".
STRATEGYSTAGETYPE	withMavenCentralRepo(boolean useMavenCentral) Sets whether to consult the Maven Central Repository in resolution; defaults to true.
FORMATSTAGETYPE	withoutTransitivity() Alias to StrategyStage.using(ResolutionStrategy) with NonTransitiveStrategy.INSTANCE as argument
FORMATSTAGETYPE	withTransitivity() Alias to StrategyStage.using(ResolutionStrategy) with TransitiveStrategy.INSTANCE as argument

Methods inherited from class java.lang.Object

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

Constructor Detail

MavenStrategyStageBaseImpl

public MavenStrategyStageBaseImpl(MavenWorkingSession session)

Method Detail

withTransitivity

public FORMATSTAGETYPE withTransitivity()

Description copied from interface: TransitiveStrategyStage

Alias to StrategyStage.using(ResolutionStrategy) with TransitiveStrategy.INSTANCE as argument

Specified by:

withTransitivity in interface TransitiveStrategyStage<MavenDependency,MavenResolutionFilter,MavenResolvedArtifact,FORMATSTAGETYPE extends MavenFormatStage,MavenResolutionStrategy>

Returns:

The next FormatStage.

withoutTransitivity

public FORMATSTAGETYPE withoutTransitivity()

Description copied from interface: TransitiveStrategyStage

Alias to StrategyStage.using(ResolutionStrategy) with NonTransitiveStrategy.INSTANCE as argument

Specified by:

withoutTransitivity in interface TransitiveStrategyStage<MavenDependency,MavenResolutionFilter,MavenResolvedArtifact,FORMATSTAGETYPE extends MavenFormatStage,MavenResolutionStrategy>

Returns:

The next FormatStage.

getMavenWorkingSession

public MavenWorkingSession getMavenWorkingSession()

Specified by:

getMavenWorkingSession in interface MavenWorkingSessionContainer

using

public FORMATSTAGETYPE using(MavenResolutionStrategy strategy)
                      throws IllegalArgumentException

Description copied from interface: StrategyStage

Defines the ResolutionStrategy to be used in resolution, returning the next FormatStage.

Specified by:

using in interface StrategyStage<MavenDependency,MavenResolutionFilter,MavenResolvedArtifact,FORMATSTAGETYPE extends MavenFormatStage,MavenResolutionStrategy>

Parameters:

strategy - The ResolutionStrategy to be used in resolution.

Returns:

The next FormatStage.

Throws:

IllegalArgumentException - If the ResolutionStrategy is not specified

withClassPathResolution

public STRATEGYSTAGETYPE withClassPathResolution(boolean useClassPathResolution)

Sets that resolution from the ClassPath should be permitted in addition to configured repositories - defaults to "true". This method is deprecated, because it does not influence setup of pom.xml resolution. Please use Maven.configureResolver() to get resolver with extended configuration and call ConfigurableMavenResolverSystemBase.withClassPathResolution(boolean) instead.

Specified by:

withClassPathResolution in interface MavenStrategyStageBase<STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>

Parameters:

useClassPathResolution - Whether the resolution from the ClassPath should be permitted in addition to configured repositories - defaults to "true".

Returns:

Modified instance of STRATEGYSTAGETYPE.

See Also:

MavenStrategyStageBase.withClassPathResolution(boolean)

withMavenCentralRepo

public STRATEGYSTAGETYPE withMavenCentralRepo(boolean useMavenCentral)

Sets whether to consult the Maven Central Repository in resolution; defaults to true. This method is deprecated, because it does not influence setup of pom.xml resolution. Please use Maven.configureResolver() to get resolver with extended configuration and call ConfigurableMavenResolverSystemBase.withMavenCentralRepo(boolean) instead.

Specified by:

withMavenCentralRepo in interface MavenStrategyStageBase<STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>

Parameters:

useMavenCentral - Whether to consult the Maven Central Repository in resolution; defaults to true.

Returns:

Modified instance of STRATEGYSTAGETYPE.

See Also:

MavenStrategyStageBase.withMavenCentralRepo(boolean)

getActualClass

protected abstract Class<STRATEGYSTAGETYPE> getActualClass()

createFormatStage

protected abstract FORMATSTAGETYPE createFormatStage(Collection<MavenResolvedArtifact> filteredArtifacts)

Creates a new MavenFormatStage instance for the current MavenWorkingSession

Parameters:

filteredArtifacts - Required

Returns:

A new MavenFormatStage instance for the current MavenWorkingSession