org.apache.maven.plugins.dependency

Class AbstractDependencyMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.dependency.AbstractDependencyMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractDependencyFilterMojo, AbstractFromConfigurationMojo, ListRepositoriesMojo

public abstract class AbstractDependencyMojo
extends org.apache.maven.plugin.AbstractMojo

Author:

Brian Fox

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	outputAbsoluteArtifactFilename Output absolute filename for resolved artifacts
protected List<org.apache.maven.project.MavenProject>	reactorProjects Contains the full list of projects in the reactor.
protected org.apache.maven.execution.MavenSession	session The Maven session

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractDependencyMojo()

Method Summary

Modifier and Type	Method and Description
protected void	copyFile(File artifact, File destFile) Does the actual copy of the file and logging.
protected abstract void	doExecute()
void	execute()
org.apache.maven.project.MavenProject	getProject()
protected boolean	isSilent()
boolean	isSkip()
org.apache.maven.project.ProjectBuildingRequest	newResolveArtifactProjectBuildingRequest()
protected org.apache.maven.project.ProjectBuildingRequest	newResolvePluginProjectBuildingRequest()
void	setSilent(boolean silent)
void	setSkip(boolean skip)

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

reactorProjects

@Parameter(defaultValue="${reactorProjects}",
           readonly=true)
protected List<org.apache.maven.project.MavenProject> reactorProjects

Contains the full list of projects in the reactor.

session

@Parameter(defaultValue="${session}",
           readonly=true,
           required=true)
protected org.apache.maven.execution.MavenSession session

The Maven session

outputAbsoluteArtifactFilename

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

Output absolute filename for resolved artifacts

Since:

2.0

Constructor Detail

AbstractDependencyMojo

public AbstractDependencyMojo()

Method Detail

execute

public final void execute()
                   throws org.apache.maven.plugin.MojoExecutionException,
                          org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

doExecute

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

Throws:

org.apache.maven.plugin.MojoExecutionException - MojoExecutionException

org.apache.maven.plugin.MojoFailureException - MojoFailureException

copyFile

protected void copyFile(File artifact,
                        File destFile)
                 throws org.apache.maven.plugin.MojoExecutionException

Does the actual copy of the file and logging.

Parameters:

artifact - represents the file to copy.

destFile - file name of destination file.

Throws:

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

newResolveArtifactProjectBuildingRequest

public org.apache.maven.project.ProjectBuildingRequest newResolveArtifactProjectBuildingRequest()

Returns:

Returns a new ProjectBuildingRequest populated from the current session and the current project remote repositories, used to resolve artifacts.

newResolvePluginProjectBuildingRequest

protected org.apache.maven.project.ProjectBuildingRequest newResolvePluginProjectBuildingRequest()

Returns:

Returns a new ProjectBuildingRequest populated from the current session and the current project remote repositories, used to resolve plugins.

getProject

public org.apache.maven.project.MavenProject getProject()

Returns:

Returns the project.

isSkip

public boolean isSkip()

Returns:

skip

setSkip

public void setSkip(boolean skip)

Parameters:

skip - skip

isSilent

protected final boolean isSilent()

Returns:

silent

setSilent

public void setSilent(boolean silent)

Parameters:

silent - silent