org.codehaus.mojo.versions

Class DisplayPropertyUpdatesMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.versions.AbstractVersionsUpdaterMojo

org.codehaus.mojo.versions.AbstractVersionsDisplayMojo

org.codehaus.mojo.versions.DisplayPropertyUpdatesMojo

All Implemented Interfaces:

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

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

Displays properties that are linked to artifact versions and have updates available.

Since:

1.0-beta-1

Author:

Stephen Connolly

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	includeParent Whether to include property updates from parent.

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
DisplayPropertyUpdatesMojo(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
void	execute()
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, validateInput, 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

includeParent

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

Whether to include property updates from parent. Default: false

Since:

2.14.0

Constructor Detail

DisplayPropertyUpdatesMojo

@Inject
public DisplayPropertyUpdatesMojo(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

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

org.apache.maven.plugin.MojoFailureException

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.