org.jboss.shrinkwrap.resolver.impl.maven

Class ResolveStageBaseImpl<RESOLVESTAGETYPE extends MavenResolveStageBase<RESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>

java.lang.Object

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

Type Parameters:

RESOLVESTAGETYPE - A MavenResolveStageBase type

All Implemented Interfaces:

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

Direct Known Subclasses:

PomEquippedResolveStageBaseImpl, PomlessResolveStageBaseImpl

public abstract class ResolveStageBaseImpl<RESOLVESTAGETYPE extends MavenResolveStageBase<RESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage>
extends Object
implements MavenResolveStageBase<RESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>, MavenResolveWithRangeSupportStageBase, MavenWorkingSessionContainer

Base implementation providing support for operations defined by MavenResolveStageBase

Author:

Karel Piwko, Andrew Lee Rubinger

Constructor Summary

Constructors

Constructor and Description
ResolveStageBaseImpl(MavenWorkingSession session)

Method Summary

Modifier and Type	Method and Description
RESOLVESTAGETYPE	addDependencies(Collection<MavenDependency> dependencies) Adds the specified dependencies to be resolved
RESOLVESTAGETYPE	addDependencies(MavenDependency... dependencies) Adds the specified coordinates to be resolved
RESOLVESTAGETYPE	addDependency(MavenDependency dependency) Adds the specified coordinate to be resolved
protected abstract STRATEGYSTAGETYPE	createStrategyStage() Creates a new MavenStrategyStageBase instance for this MavenWorkingSession
protected abstract Class<RESOLVESTAGETYPE>	getActualClass()
MavenWorkingSession	getMavenWorkingSession()
STRATEGYSTAGETYPE	resolve() Begins resolution of the prior-defined dependencies, returning the next StrategyStage for the user to define the ResolutionStrategy
STRATEGYSTAGETYPE	resolve(Collection<String> canonicalForms) Begins resolution by defining a Collection of desired dependencies (in canonical form), returning the next StrategyStage for the user to define the ResolutionStrategy.
STRATEGYSTAGETYPE	resolve(String... coordinates) Begins resolution by defining a set of desired dependencies (in canonical form), returning the next StrategyStage for the user to define the ResolutionStrategy.
STRATEGYSTAGETYPE	resolve(String coordinate) Begins resolution by defining the single desired dependency (in canonical form), returning the next StrategyStage for the user to define the ResolutionStrategy.
protected String	resolveVersion(MavenDependency dependency) Use available information to resolve the version for the specified MavenDependency

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

Constructor Detail

ResolveStageBaseImpl

public ResolveStageBaseImpl(MavenWorkingSession session)

Method Detail

getMavenWorkingSession

public MavenWorkingSession getMavenWorkingSession()

Specified by:

getMavenWorkingSession in interface MavenWorkingSessionContainer

resolve

public final STRATEGYSTAGETYPE resolve()
                                throws IllegalStateException

Begins resolution of the prior-defined dependencies, returning the next StrategyStage for the user to define the ResolutionStrategy

Specified by:

resolve in interface ResolveStage<MavenDependency,MavenResolutionFilter,RESOLVESTAGETYPE extends MavenResolveStageBase<RESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,MavenResolvedArtifact,FORMATSTAGETYPE extends MavenFormatStage,MavenResolutionStrategy>

Returns:

The next StrategyStage for the user to define the ResolutionStrategy.

Throws:

IllegalStateException - If no dependencies have yet been added

See Also:

ResolveStage.resolve()

resolve

public final STRATEGYSTAGETYPE resolve(String coordinate)
                                throws IllegalArgumentException

Begins resolution by defining the single desired dependency (in canonical form), returning the next StrategyStage for the user to define the ResolutionStrategy. Previously-added dependencies will be included in resolution.

Specified by:

resolve in interface ResolveStage<MavenDependency,MavenResolutionFilter,RESOLVESTAGETYPE extends MavenResolveStageBase<RESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,MavenResolvedArtifact,FORMATSTAGETYPE extends MavenFormatStage,MavenResolutionStrategy>

Parameters:

coordinate - The canonical form of the single desired dependency.

Returns:

The next StrategyStage for the user to define the ResolutionStrategy.

Throws:

IllegalArgumentException - If no coordinate is supplied

See Also:

ResolveStage.resolve(java.lang.String)

resolve

public final STRATEGYSTAGETYPE resolve(String... coordinates)
                                throws IllegalArgumentException

Begins resolution by defining a set of desired dependencies (in canonical form), returning the next StrategyStage for the user to define the ResolutionStrategy. Previously-added dependencies will be included in resolution.

Specified by:

resolve in interface ResolveStage<MavenDependency,MavenResolutionFilter,RESOLVESTAGETYPE extends MavenResolveStageBase<RESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,MavenResolvedArtifact,FORMATSTAGETYPE extends MavenFormatStage,MavenResolutionStrategy>

Parameters:

coordinates - The canonical forms of the set of desired dependencies.

Returns:

The next StrategyStage for the user to define the ResolutionStrategy.

Throws:

IllegalArgumentException - If no coordinates are supplied

See Also:

ResolveStage.resolve(java.lang.String[])

addDependency

public final RESOLVESTAGETYPE addDependency(MavenDependency dependency)
                                     throws IllegalArgumentException

Adds the specified coordinate to be resolved

Specified by:

addDependency in interface ResolveStage<MavenDependency,MavenResolutionFilter,RESOLVESTAGETYPE extends MavenResolveStageBase<RESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,MavenResolvedArtifact,FORMATSTAGETYPE extends MavenFormatStage,MavenResolutionStrategy>

Parameters:

dependency - The coordinate to be resolved.

Returns:

Modified instance of the ResolveStage with added coordinate.

Throws:

IllegalArgumentException - If no dependency is supplied

See Also:

ResolveStage.addDependency(org.jboss.shrinkwrap.resolver.api.Coordinate)

addDependencies

public final RESOLVESTAGETYPE addDependencies(MavenDependency... dependencies)
                                       throws IllegalArgumentException

Adds the specified coordinates to be resolved

Specified by:

addDependencies in interface ResolveStage<MavenDependency,MavenResolutionFilter,RESOLVESTAGETYPE extends MavenResolveStageBase<RESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,MavenResolvedArtifact,FORMATSTAGETYPE extends MavenFormatStage,MavenResolutionStrategy>

Parameters:

dependencies - The set of coordinates to be resolved.

Returns:

Modified instance of the ResolveStage with added coordinates.

Throws:

IllegalArgumentException - If no dependencies are supplied

See Also:

ResolveStage.addDependencies(Coordinate[])

resolve

public STRATEGYSTAGETYPE resolve(Collection<String> canonicalForms)
                          throws IllegalArgumentException,
                                 ResolutionException,
                                 CoordinateParseException

Begins resolution by defining a Collection of desired dependencies (in canonical form), returning the next StrategyStage for the user to define the ResolutionStrategy. Previously-added dependencies will be included in resolution.

Specified by:

resolve in interface ResolveStage<MavenDependency,MavenResolutionFilter,RESOLVESTAGETYPE extends MavenResolveStageBase<RESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,MavenResolvedArtifact,FORMATSTAGETYPE extends MavenFormatStage,MavenResolutionStrategy>

Parameters:

canonicalForms - A Collection of the canonical forms a of the desired dependencies.

Returns:

The next StrategyStage for the user to define the ResolutionStrategy.

Throws:

IllegalArgumentException - If no coordinates are supplied

ResolutionException - If an error occurred in resolution

CoordinateParseException - If one or more of the specified canonical forms is invalid

See Also:

ResolveStage.resolve(java.util.Collection)

addDependencies

public RESOLVESTAGETYPE addDependencies(Collection<MavenDependency> dependencies)
                                 throws IllegalArgumentException

Adds the specified dependencies to be resolved

Specified by:

addDependencies in interface ResolveStage<MavenDependency,MavenResolutionFilter,RESOLVESTAGETYPE extends MavenResolveStageBase<RESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,MavenResolvedArtifact,FORMATSTAGETYPE extends MavenFormatStage,MavenResolutionStrategy>

Parameters:

dependencies - A collection of coordinates to be resolved.

Returns:

Modified instance of the ResolveStage with added coordinates.

Throws:

IllegalArgumentException - If the Collection is null

See Also:

ResolveStage.addDependencies(java.util.Collection)

resolveVersion

protected String resolveVersion(MavenDependency dependency)
                         throws IllegalArgumentException

Use available information to resolve the version for the specified MavenDependency

Parameters:

dependency - A MavenDependency the version should be resolved for

Returns:

The resolved version

Throws:

IllegalArgumentException

See Also:

resolveVersion(org.jboss.shrinkwrap.resolver.api.maven.coordinate.MavenDependency)

createStrategyStage

protected abstract STRATEGYSTAGETYPE createStrategyStage()

Creates a new MavenStrategyStageBase instance for this MavenWorkingSession

Returns:

A new MavenStrategyStageBase instance for this MavenWorkingSession

getActualClass

protected abstract Class<RESOLVESTAGETYPE> getActualClass()