org.codehaus.mojo.versions

Class UseLatestVersionsMojoBase

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.versions.AbstractVersionsUpdaterMojo

org.codehaus.mojo.versions.AbstractVersionsDependencyUpdaterMojo

org.codehaus.mojo.versions.UseLatestVersionsMojoBase

All Implemented Interfaces:

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

Direct Known Subclasses:

UseLatestReleasesMojo, UseLatestSnapshotsMojo, UseLatestVersionsMojo, UseNextReleasesMojo, UseNextSnapshotsMojo, UseNextVersionsMojo

public abstract class UseLatestVersionsMojoBase
extends AbstractVersionsDependencyUpdaterMojo

Common base class for UseLatestVersionsMojo and UseLatestReleasesMojo

Field Summary

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

SNAPSHOT_REGEX

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

protected void

useLatestVersions(ModifiedPomXMLEventReader pom, Collection<org.apache.maven.model.Dependency> dependencies, BiFunction<org.apache.maven.model.Dependency,ArtifactVersions,Optional<org.apache.maven.artifact.versioning.ArtifactVersion>> newestVersionProducer, org.codehaus.mojo.versions.api.recording.ChangeRecord.ChangeKind changeKind, Predicate<org.apache.maven.model.Dependency>... filters) Updates the pom, given a set of dependencies, a function retrieving the newest version, and an optional array of filters against which the input dependencies are matched.

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

findArtifact, getParentDependency, hasIncludes, isExcludeReactor, isHandledByProperty, isIncluded, isProcessingDependencies, isProcessingDependencyManagement, isProcessingParent, isProducedByReactor, separatePatterns, toArtifact, toArtifact, toString, toString, updateDependencyVersion

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

execute, findLatestVersion, getChangeRecorder, getHelper, getProject, getPropertyValue, getVersion, newModifiedPomXER, process, saveChangeRecorderResults, setProject, shouldApplyUpdate, shouldApplyUpdate, update, 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

Constructor Detail

UseLatestVersionsMojoBase

public UseLatestVersionsMojoBase(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

useLatestVersions

@SafeVarargs
protected final void useLatestVersions(ModifiedPomXMLEventReader pom,
                                                    Collection<org.apache.maven.model.Dependency> dependencies,
                                                    BiFunction<org.apache.maven.model.Dependency,ArtifactVersions,Optional<org.apache.maven.artifact.versioning.ArtifactVersion>> newestVersionProducer,
                                                    org.codehaus.mojo.versions.api.recording.ChangeRecord.ChangeKind changeKind,
                                                    Predicate<org.apache.maven.model.Dependency>... filters)
                                             throws XMLStreamException,
                                                    org.apache.maven.plugin.MojoExecutionException,
                                                    VersionRetrievalException

Updates the pom, given a set of dependencies, a function retrieving the newest version, and an optional array of filters against which the input dependencies are matched.

Parameters:

pom - POM to be modified

dependencies - collection of dependencies with the dependency versions before the change

newestVersionProducer - function providing the newest version given a dependency and an ArtifactVersions instance

changeKind - title for the change recorder records

filters - optional array of filters

Throws:

XMLStreamException - thrown if the POM update doesn't succeed

org.apache.maven.plugin.MojoExecutionException - if something goes wrong.

VersionRetrievalException - thrown if an artifact versions cannot be retrieved