org.codehaus.mojo.versions

Class UseDepVersionMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.versions.AbstractVersionsUpdaterMojo

org.codehaus.mojo.versions.AbstractVersionsDependencyUpdaterMojo

org.codehaus.mojo.versions.UseDepVersionMojo

All Implemented Interfaces:

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

@Mojo(name="use-dep-version",
      threadSafe=true)
public class UseDepVersionMojo
extends AbstractVersionsDependencyUpdaterMojo

Updates a dependency to a specific version. This can be useful if you have to manage versions for a very large (100+ module) projects where you can’t always use the most up-to-date version of a particular third party component.

Since:

2.3

Author:

Dan Arcari

Field Summary

Fields

Modifier and Type	Field and Description
protected String	depVersion The exact version to be applied for the included dependencies
protected boolean	forceVersion If set to true, will use whatever version is supplied without attempting to validate that such a version is obtainable from the repository chain.

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

Method Summary

Modifier and Type	Method and Description
protected void	update(ModifiedPomXMLEventReader pom) Updates the pom.

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

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

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

execute, 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

Field Detail

depVersion

@Parameter(property="depVersion",
           required=true)
protected String depVersion

The exact version to be applied for the included dependencies

forceVersion

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

If set to true, will use whatever version is supplied without attempting to validate that such a version is obtainable from the repository chain.

Constructor Detail

UseDepVersionMojo

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

Method Detail

update

protected void update(ModifiedPomXMLEventReader pom)
               throws org.apache.maven.plugin.MojoExecutionException,
                      org.apache.maven.plugin.MojoFailureException,
                      XMLStreamException,
                      org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException

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 - If things go wrong.

org.apache.maven.plugin.MojoFailureException - If things go wrong.

XMLStreamException - If things go wrong.

org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException - if something goes wrong.