org.apache.maven.plugins.dependency.resolvers

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:

ContextEnabled, 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 using this goal while 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 and Description
protected boolean	outputScope If we should display the scope when resolving

Fields inherited from class org.apache.maven.plugins.dependency.resolvers.AbstractResolveMojo

appendOutput, excludeReactor, ignorePermissions, outputFile, useJvmChmod

Fields inherited from class org.apache.maven.plugins.dependency.fromDependencies.AbstractDependencyFilterMojo

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

Fields inherited from class org.apache.maven.plugins.dependency.AbstractDependencyMojo

outputAbsoluteArtifactFilename, reactorProjects, session

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

ROLE

Constructor Summary

Constructors

Constructor and Description
ResolveDependenciesMojo()

Method Summary

Modifier and Type	Method and Description
protected void	doExecute() Main entry into mojo.
protected 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 org.apache.maven.plugins.dependency.resolvers.AbstractResolveMojo

getPluginArtifactsFilter, resolveArtifactDependencies

Methods inherited from class org.apache.maven.plugins.dependency.fromDependencies.AbstractDependencyFilterMojo

filterMarkedDependencies, getArtifactResolver, getClassifierTranslatedDependencies, getDependencyResolver, getDependencySets, getDependencySets, getMarkersDirectory, getRepositoryManager, getResolvedDependencies, isPrependGroupId, resolve, setMarkersDirectory, setPrependGroupId

Methods inherited from class org.apache.maven.plugins.dependency.AbstractDependencyMojo

copyFile, execute, getArchiverManager, getProject, isSilent, isSkip, isUseJvmChmod, newResolveArtifactProjectBuildingRequest, setArchiverManager, setSilent, setSkip, setUseJvmChmod, unpack, unpack, unpack

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

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

outputScope

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

If we should display the scope when resolving

Since:

2.0-alpha-2

Constructor Detail

ResolveDependenciesMojo

public ResolveDependenciesMojo()

Method Detail

doExecute

protected void doExecute()
                  throws MojoExecutionException

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

Specified by:

doExecute in class AbstractDependencyMojo

Throws:

MojoExecutionException - with a message if an error occurs.

getResults

public DependencyStatusSets getResults()

Returns:

Returns the results.

getMarkedArtifactFilter

protected 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 artfiact filename.

theOutputScope - The output scope.

theSort - sort yes/no.

Returns:

The output.