org.codehaus.mojo.versions

Class CompareDependenciesMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.versions.AbstractVersionsUpdaterMojo

org.codehaus.mojo.versions.AbstractVersionsDependencyUpdaterMojo

org.codehaus.mojo.versions.CompareDependenciesMojo

All Implemented Interfaces:

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

@Mojo(name="compare-dependencies",
      threadSafe=true)
public class CompareDependenciesMojo
extends AbstractVersionsDependencyUpdaterMojo

Compare dependency versions of the current project to dependencies or dependency management of a remote repository project. Can optionally update locally the project instead of reporting the comparison

Since:

1.3

Author:

Paul Gier

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	ignoreRemoteDependencies Ignore the list of remote dependencies and only compare the remote dependencyManagement
protected boolean	ignoreRemoteDependencyManagement Ignore the remote dependency management and only check against the actual dependencies of the remote project
protected org.apache.maven.project.MavenProjectBuilder	mavenProjectBuilder The project builder used to initialize the remote project.
protected String	remotePom The groupId, artifactId, and version of the remote project (POM) to which we are comparing.
protected boolean	reportMode Display the dependency version differences on the command line, but do not update the versions in the current pom.
protected File	reportOutputFile If the output file is set, the diff report will be written to this file.
protected boolean	updateDependencies Update dependency versions in the current POM.
protected boolean	updatePropertyVersions Update dependency versions stored in properties

Fields inherited from class org.codehaus.mojo.versions.AbstractVersionsUpdaterMojo

allowSnapshots, artifactMetadataSource, artifactResolver, ignoredVersions, localRepository, project, projectBuilder, reactorProjects, remoteArtifactRepositories, remotePluginRepositories, repositorySystem, ruleSet, session, settings

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

ROLE

Constructor Summary

Constructors

Constructor and Description

CompareDependenciesMojo(org.apache.maven.repository.RepositorySystem repositorySystem, org.apache.maven.project.MavenProjectBuilder projectBuilder, org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource, org.apache.maven.artifact.manager.WagonManager wagonManager, org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver, org.apache.maven.project.MavenProjectBuilder mavenProjectBuilder)

Method Summary

Modifier and Type	Method and Description
protected void	update(ModifiedPomXMLEventReader pom) Updates the pom.

Methods inherited from class org.codehaus.mojo.versions.AbstractVersionsDependencyUpdaterMojo

findArtifact, hasIncludes, isExcludeReactor, isHandledByProperty, isIncluded, isProcessingDependencies, isProcessingDependencyManagement, isProcessingParent, isProducedByReactor, separatePatterns, toArtifact, toArtifact, toString, toString

Methods inherited from class org.codehaus.mojo.versions.AbstractVersionsUpdaterMojo

execute, findLatestVersion, getChangeRecorder, getHelper, getProject, getPropertyValue, getVersion, newModifiedPomXER, process, saveChangeRecorderResults, setProject, shouldApplyUpdate, shouldApplyUpdate, updatePropertyToNewestVersion, writeFile

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

remotePom

@Parameter(property="remotePom",
           required=true)
protected String remotePom

The groupId, artifactId, and version of the remote project (POM) to which we are comparing. This should be in the form "groupId:artifactId:version"

ignoreRemoteDependencies

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

Ignore the list of remote dependencies and only compare the remote dependencyManagement

ignoreRemoteDependencyManagement

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

Ignore the remote dependency management and only check against the actual dependencies of the remote project

updateDependencies

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

Update dependency versions in the current POM.

updatePropertyVersions

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

Update dependency versions stored in properties

reportMode

@Parameter(property="reportMode",
           defaultValue="true")
protected boolean reportMode

Display the dependency version differences on the command line, but do not update the versions in the current pom. If updateDependencies is set to "true" this will automatically be set to false.

reportOutputFile

@Parameter(property="reportOutputFile")
protected File reportOutputFile

If the output file is set, the diff report will be written to this file.

mavenProjectBuilder

protected org.apache.maven.project.MavenProjectBuilder mavenProjectBuilder

The project builder used to initialize the remote project.

Constructor Detail

CompareDependenciesMojo

@Inject
public CompareDependenciesMojo(org.apache.maven.repository.RepositorySystem repositorySystem,
                                       org.apache.maven.project.MavenProjectBuilder projectBuilder,
                                       org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource,
                                       org.apache.maven.artifact.manager.WagonManager wagonManager,
                                       org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver,
                                       org.apache.maven.project.MavenProjectBuilder mavenProjectBuilder)

Method Detail

update

protected void update(ModifiedPomXMLEventReader pom)
               throws org.apache.maven.plugin.MojoExecutionException,
                      org.apache.maven.plugin.MojoFailureException,
                      XMLStreamException

Description copied from class: AbstractVersionsUpdaterMojo

Updates the pom.

Specified by:

update in class AbstractVersionsUpdaterMojo

Parameters:

pom - the pom to update.

Throws:

org.apache.maven.plugin.MojoExecutionException - Something wrong with the plugin itself

org.apache.maven.plugin.MojoFailureException - The plugin detected an error in the build

XMLStreamException - when things go wrong with XML streaming

See Also:

AbstractVersionsUpdaterMojo.update(org.codehaus.mojo.versions.rewriting.ModifiedPomXMLEventReader)