org.codehaus.mojo.versions

Class DisplayDependencyUpdatesMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.versions.AbstractVersionsUpdaterMojo

org.codehaus.mojo.versions.DisplayDependencyUpdatesMojo

All Implemented Interfaces:

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

public class DisplayDependencyUpdatesMojo
extends AbstractVersionsUpdaterMojo

Displays all dependencies that have newer versions available.

Since:

1.0-alpha-1

Author:

Stephen Connolly

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	processDependencies Whether to process the dependencies section of the project.
protected Boolean	processDependencyManagement Whether to process the dependencyManagement section of the project.
protected Boolean	verbose Whether to show additional information such as dependencies that do not need updating.

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

allowSnapshots, artifactFactory, artifactMetadataSource, artifactResolver, localRepository, pathTranslator, projectBuilder, reactorProjects, remoteArtifactRepositories, remotePluginRepositories, resolver, session, settings

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

ROLE

Constructor Summary

Constructors

Constructor and Description
DisplayDependencyUpdatesMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()
boolean	isProcessingDependencies()
boolean	isProcessingDependencyManagement()
boolean	isVerbose()
void	setXmlReport(File xmlReport)
protected void	update(ModifiedPomXMLEventReader pom) Updates the pom.

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

determineUnchangedSegment, findLatestVersion, getHelper, getProject, getPropertyValue, newModifiedPomXER, process, setProject, 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

processDependencyManagement

protected Boolean processDependencyManagement

Whether to process the dependencyManagement section of the project. If not set will default to true.

Since:

1.2

processDependencies

protected Boolean processDependencies

Whether to process the dependencies section of the project. If not set will default to true.

Since:

1.2

verbose

protected Boolean verbose

Whether to show additional information such as dependencies that do not need updating. Defaults to false.

Since:

2.1

Constructor Detail

DisplayDependencyUpdatesMojo

public DisplayDependencyUpdatesMojo()

Method Detail

setXmlReport

public void setXmlReport(File xmlReport)

isProcessingDependencyManagement

public boolean isProcessingDependencyManagement()

isProcessingDependencies

public boolean isProcessingDependencies()

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()

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 - when things go wrong

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

XMLStreamException - when things go wrong with XML streaming

Since:

1.0-alpha-1

See Also:

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