Package 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

Modifier and Type	Field	Description
static final Pattern	PATTERN_PROJECT_PLUGIN
protected boolean	processUnboundPlugins	If set to true, will also display updates to plugins where no version is specified in the current POM, but whose version is specified in the parent or the "superpom".
protected final org.apache.maven.project.ProjectBuilder	projectBuilder	The (injected) instance of ProjectBuilder
static final String	SUPERPOM_PATH

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

logOutput, outputEncoding, outputFile, outputLineWidth

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

allowSnapshots, artifactHandlerManager, generateBackupPoms, ignoredVersions, project, reactorProjects, repositorySystem, ruleSet, session, wagonMap

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

ROLE

Constructor Summary

Constructors

Constructor

Description

DisplayPluginUpdatesMojo(org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager, org.eclipse.aether.RepositorySystem repositorySystem, org.apache.maven.project.ProjectBuilder projectBuilder, Map<String,org.apache.maven.wagon.Wagon> wagonMap, org.apache.maven.lifecycle.LifecycleExecutor lifecycleExecutor, org.apache.maven.model.interpolation.ModelInterpolator modelInterpolator, org.apache.maven.rtinfo.RuntimeInformation runtimeInformation, Map<String,ChangeRecorder> changeRecorders)

Method Summary

Modifier and Type	Method	Description
void	execute()
protected void	update(MutableXMLStreamReader 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, getVersion, process, saveChangeRecorderResults, setProject, shouldApplyUpdate, shouldApplyUpdate, updatePropertyToNewestVersion, validateInput

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 Details

PATTERN_PROJECT_PLUGIN

public static final Pattern PATTERN_PROJECT_PLUGIN

SUPERPOM_PATH

public static final String SUPERPOM_PATH

See Also:

• Constant Field Values

projectBuilder

protected final org.apache.maven.project.ProjectBuilder projectBuilder

The (injected) instance of ProjectBuilder

Since:

2.14.0

processUnboundPlugins

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

If set to true, will also display updates to plugins where no version is specified in the current POM, but whose version is specified in the parent or the "superpom".

It might not always be possible to update these plugins, thus the default value of this parameter is false

.

Since:

2.15.0

Constructor Details

DisplayPluginUpdatesMojo

@Inject
public DisplayPluginUpdatesMojo(org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager,
 org.eclipse.aether.RepositorySystem repositorySystem,
 org.apache.maven.project.ProjectBuilder projectBuilder,
 Map<String,org.apache.maven.wagon.Wagon> wagonMap,
 org.apache.maven.lifecycle.LifecycleExecutor lifecycleExecutor,
 org.apache.maven.model.interpolation.ModelInterpolator modelInterpolator,
 org.apache.maven.rtinfo.RuntimeInformation runtimeInformation,
 Map<String,ChangeRecorder> changeRecorders)

Method Details

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