org.codehaus.mojo.versions

Class DisplayDependencyUpdatesMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.versions.AbstractVersionsUpdaterMojo

org.codehaus.mojo.versions.AbstractVersionsDisplayMojo

org.codehaus.mojo.versions.DisplayDependencyUpdatesMojo

All Implemented Interfaces:

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

@Mojo(name="display-dependency-updates",
      threadSafe=true)
public class DisplayDependencyUpdatesMojo
extends AbstractVersionsDisplayMojo

Displays all dependencies that have newer versions available. It will also display dependencies which are used by a plugin or defined in the plugin within a pluginManagement.

Since:

1.0-alpha-1

Author:

Stephen Connolly

Field Summary

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

logOutput, outputEncoding, outputFile, outputLineWidth

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

aetherRepositorySystem, allowSnapshots, ignoredVersions, project, reactorProjects, repositorySystem, ruleSet, session, wagonMap

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

ROLE

Constructor Summary

Constructors

Constructor and Description
DisplayDependencyUpdatesMojo(org.apache.maven.repository.RepositorySystem repositorySystem, org.eclipse.aether.RepositorySystem aetherRepositorySystem, Map<String,org.apache.maven.wagon.Wagon> wagonMap, Map<String,org.codehaus.mojo.versions.api.recording.ChangeRecorder> changeRecorders)

Method Summary

Modifier and Type	Method and Description
protected static boolean	dependenciesMatch(org.apache.maven.model.Dependency dependency, org.apache.maven.model.Dependency managedDependency)
void	execute()
boolean	isProcessingDependencies()
boolean	isProcessingDependencyManagement()
boolean	isProcessingPluginDependencies()
boolean	isProcessPluginDependenciesInDependencyManagement()
boolean	isVerbose()
protected void	update(ModifiedPomXMLEventReader pom) Updates the pom.
protected void	validateInput() Validates input parameters

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

getOutputLineWidthOffset, logInit, logLine

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

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

Constructor Detail

DisplayDependencyUpdatesMojo

@Inject
public DisplayDependencyUpdatesMojo(org.apache.maven.repository.RepositorySystem repositorySystem,
                                            org.eclipse.aether.RepositorySystem aetherRepositorySystem,
                                            Map<String,org.apache.maven.wagon.Wagon> wagonMap,
                                            Map<String,org.codehaus.mojo.versions.api.recording.ChangeRecorder> changeRecorders)

Method Detail

dependenciesMatch

protected static boolean dependenciesMatch(org.apache.maven.model.Dependency dependency,
                                           org.apache.maven.model.Dependency managedDependency)

isProcessingDependencyManagement

public boolean isProcessingDependencyManagement()

isProcessingDependencies

public boolean isProcessingDependencies()

isProcessingPluginDependencies

public boolean isProcessingPluginDependencies()

isProcessPluginDependenciesInDependencyManagement

public boolean isProcessPluginDependenciesInDependencyManagement()

isVerbose

public boolean isVerbose()

execute

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

Description copied from class: AbstractVersionsUpdaterMojo

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class AbstractVersionsUpdaterMojo

Throws:

org.apache.maven.plugin.MojoExecutionException - when things go wrong

org.apache.maven.plugin.MojoFailureException - when things go wrong in a very bad way

Since:

1.0-alpha-1

See Also:

AbstractVersionsUpdaterMojo.execute()

validateInput

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

Description copied from class: AbstractVersionsUpdaterMojo

Validates input parameters

Overrides:

validateInput in class AbstractVersionsUpdaterMojo

Throws:

org.apache.maven.plugin.MojoExecutionException - thrown if any of input parameters is invalid

update

protected void update(ModifiedPomXMLEventReader pom)

Description copied from class: AbstractVersionsUpdaterMojo

Updates the pom.

Specified by:

update in class AbstractVersionsUpdaterMojo

Parameters:

pom - the pom to update.

Since:

1.0-alpha-1

See Also:

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