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

Author:

Brian Fox

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	outputScope	If we should display the scope when resolving.

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

outputScope

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

If we should display the scope when resolving.

Since:

2.0-alpha-2

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