org.codehaus.mojo.versions
Class DisplayPluginUpdatesMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.codehaus.mojo.versions.AbstractVersionsUpdaterMojo
          org.codehaus.mojo.versions.DisplayPluginUpdatesMojo

All Implemented Interfaces:

ContextEnabled, Mojo

public class DisplayPluginUpdatesMojo
extends AbstractVersionsUpdaterMojo

Displays all plugins that have newer versions available.

Since:

1.0-alpha-1

Author:

Stephen Connolly

Is defined by the goal name:

display-plugin-updates

Requires a direct invocation by the user:

false

Requires a Maven project to run:

true

Field Summary

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

allowSnapshots, artifactFactory, artifactMetadataSource, comparisonMethod, localRepository, pathTranslator, projectBuilder, reactorProjects, remoteArtifactRepositories, remotePluginRepositories, resolver

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

ROLE

Constructor Summary

DisplayPluginUpdatesMojo()

Method Summary

void	execute()
Map	getPhaseToLifecycleMap(List lifecycles) Gets the phase to lifecycle map.
protected void	update(ModifiedPomXMLEventReader pom) Updates the pom.

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

findLatestVersion, getExpressionEvaluator, getHelper, getProject, getPropertyValue, getVersionComparator, newModifiedPomXER, process, readFile, setProject, shouldApplyUpdate, 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

DisplayPluginUpdatesMojo

public DisplayPluginUpdatesMojo()

Method Detail

execute

public void execute()
             throws MojoExecutionException,
                    MojoFailureException

Description copied from class: AbstractVersionsUpdaterMojo

Specified by:

execute in interface Mojo

Overrides:

execute in class AbstractVersionsUpdaterMojo

Throws:

MojoExecutionException - when things go wrong

MojoFailureException - when things go wrong in a very bad way

Since:

1.0-alpha-1

See Also:

AbstractVersionsUpdaterMojo.execute()

getPhaseToLifecycleMap

public Map getPhaseToLifecycleMap(List lifecycles)
                           throws org.apache.maven.lifecycle.LifecycleExecutionException

Gets the phase to lifecycle map.

Parameters:

lifecycles - The list of lifecycles.

Returns:

the phase to lifecycle map.

Throws:

org.apache.maven.lifecycle.LifecycleExecutionException - the lifecycle execution exception.

update

protected void update(ModifiedPomXMLEventReader pom)
               throws MojoExecutionException,
                      MojoFailureException,
                      javax.xml.stream.XMLStreamException

Description copied from class: AbstractVersionsUpdaterMojo

Updates the pom.

Specified by:

update in class AbstractVersionsUpdaterMojo

Parameters:

pom - the pom to update.

Throws:

MojoExecutionException - when things go wrong

MojoFailureException - when things go wrong in a very bad way

javax.xml.stream.XMLStreamException - when things go wrong with XML streaming

Since:

1.0-alpha-1

See Also:

AbstractVersionsUpdaterMojo.update(ModifiedPomXMLEventReader)