Class ResolveDependenciesMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.dependency.AbstractDependencyMojo

org.apache.maven.plugins.dependency.fromDependencies.AbstractDependencyFilterMojo

org.apache.maven.plugins.dependency.resolvers.AbstractResolveMojo

org.apache.maven.plugins.dependency.resolvers.ResolveDependenciesMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

CollectDependenciesMojo, ListMojo, ResolveDependencySourcesMojo

@Mojo(name="resolve",
      requiresDependencyResolution=TEST,
      defaultPhase=GENERATE_SOURCES,
      threadSafe=true)
public class ResolveDependenciesMojo
extends AbstractResolveMojo

Goal that resolves the project dependencies from the repository. When running on Java 9, the module names will be visible as well.

Since:

2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ResolveDependenciesMojo.ModuleDescriptor

Field Summary

Fields

Modifier and Type	Field	Description
(package private) boolean	includeParents	Include parent poms in the dependency resolution list.
private boolean	outputAbsoluteArtifactFilename	Output absolute filename for resolved artifacts.
private String	outputEncoding
protected boolean	outputScope	If we should display the scope when resolving.
(package private) DependencyStatusSets	results	Only used to store results for integration test validation.
(package private) boolean	sort	Sort the output list of resolved artifacts alphabetically.

Fields inherited from class AbstractResolveMojo

appendOutput, outputFile

Fields inherited from class AbstractDependencyFilterMojo

classifier, excludeArtifactIds, excludeClassifiers, excludeGroupIds, excludeScope, excludeTransitive, excludeTypes, includeArtifactIds, includeClassifiers, includeGroupIds, includeScope, includeTypes, markersDirectory, overWriteIfNewer, overWriteReleases, overWriteSnapshots, prependGroupId, type

Fields inherited from class AbstractDependencyMojo

session

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
ResolveDependenciesMojo(org.apache.maven.execution.MavenSession session, org.sonatype.plexus.build.incremental.BuildContext buildContext, org.apache.maven.project.MavenProject project, ResolverUtil resolverUtil, org.apache.maven.project.ProjectBuilder projectBuilder, org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager)

Method Summary

Modifier and Type	Method	Description
private StringBuilder	buildArtifactListOutput(Set<org.apache.maven.artifact.Artifact> artifacts, boolean outputAbsoluteArtifactFilename, boolean theOutputScope, boolean theSort)
protected void	doExecute()	Main entry into mojo.
protected org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter	getMarkedArtifactFilter()	Return an ArtifactsFilter indicating which artifacts must be filtered out.
private ResolveDependenciesMojo.ModuleDescriptor	getModuleDescriptor(File artifactFile)
String	getOutput(boolean outputAbsoluteArtifactFilename, boolean theOutputScope, boolean theSort)
DependencyStatusSets	getResults()

Methods inherited from class AbstractDependencyFilterMojo

filterMarkedDependencies, getDependencySets, getDependencySets, getMarkersDirectory, getResolvedDependencies, getResolverUtil, isPrependGroupId, setMarkersDirectory, setPrependGroupId

Methods inherited from class AbstractDependencyMojo

execute, getProject, isSilent, isSkip, setSilent, setSkip

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class Object

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

Field Details

outputEncoding

@Parameter(property="outputEncoding",
           defaultValue="${project.reporting.outputEncoding}")
private String outputEncoding

outputScope

@Parameter(property="mdep.outputScope",
           defaultValue="true")
protected boolean outputScope

If we should display the scope when resolving.

Since:

2.0-alpha-2

outputAbsoluteArtifactFilename

@Parameter(property="outputAbsoluteArtifactFilename",
           defaultValue="false")
private boolean outputAbsoluteArtifactFilename

Output absolute filename for resolved artifacts.

Since:

2.0

results

DependencyStatusSets results

Only used to store results for integration test validation.

sort

@Parameter(property="sort",
           defaultValue="false")
boolean sort

Sort the output list of resolved artifacts alphabetically. The default ordering matches the classpath order.

Since:

2.8

includeParents

@Parameter(property="includeParents",
           defaultValue="false")
boolean includeParents

Include parent poms in the dependency resolution list.

Since:

2.8

Constructor Details

ResolveDependenciesMojo

@Inject
public ResolveDependenciesMojo(org.apache.maven.execution.MavenSession session,
 org.sonatype.plexus.build.incremental.BuildContext buildContext,
 org.apache.maven.project.MavenProject project,
 ResolverUtil resolverUtil,
 org.apache.maven.project.ProjectBuilder projectBuilder,
 org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager)

Method Details

doExecute

protected void doExecute()
                  throws org.apache.maven.plugin.MojoExecutionException

Main entry into mojo. Gets the list of dependencies and iterates through displaying the resolved version.

Specified by:

doExecute in class AbstractDependencyMojo

Throws:

org.apache.maven.plugin.MojoExecutionException - with a message if an error occurs

getResults

public DependencyStatusSets getResults()

Returns:

returns the results

getMarkedArtifactFilter

protected org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter getMarkedArtifactFilter()

Description copied from class: AbstractDependencyFilterMojo

Return an ArtifactsFilter indicating which artifacts must be filtered out.

Specified by:

getMarkedArtifactFilter in class AbstractDependencyFilterMojo

Returns:

an ArtifactsFilter indicating which artifacts must be filtered out

getOutput

public String getOutput(boolean outputAbsoluteArtifactFilename,
 boolean theOutputScope,
 boolean theSort)

Parameters:

outputAbsoluteArtifactFilename - absolute artifact filename

theOutputScope - the output scope

theSort - sort yes/no

Returns:

the output

buildArtifactListOutput

private StringBuilder buildArtifactListOutput(Set<org.apache.maven.artifact.Artifact> artifacts,
 boolean outputAbsoluteArtifactFilename,
 boolean theOutputScope,
 boolean theSort)

getModuleDescriptor

private ResolveDependenciesMojo.ModuleDescriptor getModuleDescriptor(File artifactFile)