org.codehaus.mojo.versions

Class DisplayPluginUpdatesMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.versions.AbstractVersionsUpdaterMojo

org.codehaus.mojo.versions.AbstractVersionsDisplayMojo

org.codehaus.mojo.versions.DisplayPluginUpdatesMojo

All Implemented Interfaces:

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

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

Displays all plugins that have newer versions available, taking care of Maven version prerequisites.

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

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

DisplayPluginUpdatesMojo(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.lifecycle.LifecycleExecutor lifecycleExecutor, org.apache.maven.model.interpolation.ModelInterpolator modelInterpolator, org.apache.maven.plugin.PluginManager pluginManager, org.apache.maven.execution.RuntimeInformation runtimeInformation)

Method Summary

Modifier and Type	Method and Description
void	execute()
Map<String,org.apache.maven.lifecycle.Lifecycle>	getPhaseToLifecycleMap(List<org.apache.maven.lifecycle.Lifecycle> lifecycles) Gets the phase to lifecycle map.
protected void	update(ModifiedPomXMLEventReader pom) Updates the pom.

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

DisplayPluginUpdatesMojo

@Inject
public DisplayPluginUpdatesMojo(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.lifecycle.LifecycleExecutor lifecycleExecutor,
                                        org.apache.maven.model.interpolation.ModelInterpolator modelInterpolator,
                                        org.apache.maven.plugin.PluginManager pluginManager,
                                        org.apache.maven.execution.RuntimeInformation runtimeInformation)

Method Detail

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

getPhaseToLifecycleMap

public Map<String,org.apache.maven.lifecycle.Lifecycle> getPhaseToLifecycleMap(List<org.apache.maven.lifecycle.Lifecycle> 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 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(ModifiedPomXMLEventReader)