org.codehaus.mojo.versions.api

Class DefaultVersionsHelper

java.lang.Object

org.codehaus.mojo.versions.api.DefaultVersionsHelper

All Implemented Interfaces:

VersionsHelper

public class DefaultVersionsHelper
extends Object
implements VersionsHelper

Helper class that provides common functionality required by both the mojos and the reports.

Since:

1.0-alpha-3

Author:

Stephen Connolly

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultVersionsHelper.Builder Builder class for DefaultVersionsHelper

Method Summary

Modifier and Type	Method and Description
org.apache.maven.artifact.versioning.ArtifactVersion	createArtifactVersion(String version) Creates an ArtifactVersion instance from a string.
org.apache.maven.artifact.Artifact	createDependencyArtifact(org.apache.maven.model.Dependency dependency) Shorthand method for repositorySystem.createDependencyArtifact(...) which extracts the parameters from the Dependency instance.
org.apache.maven.artifact.Artifact	createDependencyArtifact(String groupId, String artifactId, String version, String type, String classifier, String scope) Shorthand method for getArtifactFactory().createDependencyArtifact(...).
org.apache.maven.artifact.Artifact	createDependencyArtifact(String groupId, String artifactId, String version, String type, String classifier, String scope, boolean optional) Shorthand method for repositorySystem.createDependencyArtifact(...).
org.apache.maven.artifact.Artifact	createPluginArtifact(String groupId, String artifactId, String version) Shorthand method for repositorySystem.createPluginArtifact(...).
Set<org.apache.maven.artifact.Artifact>	extractArtifacts(Collection<org.apache.maven.project.MavenProject> mavenProjects) Takes a List of MavenProject instances and converts it into a Set of Artifact instances.
protected org.codehaus.mojo.versions.model.Rule	getBestFitRule(String groupId, String artifactId) Find the rule, if any, which best fits the artifact details given.
org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator	getExpressionEvaluator(org.apache.maven.project.MavenProject project) Returns an ExpressionEvaluator for the specified project.
org.apache.maven.plugin.logging.Log	getLog() Gets the logger used by this helper.
VersionComparator	getVersionComparator(org.apache.maven.artifact.Artifact artifact) Returns the version comparator to use for the specified artifact.
VersionComparator	getVersionComparator(String groupId, String artifactId) Returns the version comparator to use for the specified groupId and artifactId.
Map<Property,PropertyVersions>	getVersionPropertiesMap(org.apache.maven.project.MavenProject project, Property[] propertyDefinitions, String includeProperties, String excludeProperties, boolean autoLinkItems) Returns a map of PropertyVersions values keyed by Property instances consisting of the properties defined in the project which are associated with version information.
ArtifactVersions	lookupArtifactVersions(org.apache.maven.artifact.Artifact artifact, boolean usePluginRepositories) Looks up the versions of the specified artifact that are available in either the local repository, or the appropriate remote repositories.
Map<org.apache.maven.model.Dependency,ArtifactVersions>	lookupDependenciesUpdates(Set<org.apache.maven.model.Dependency> dependencies, boolean usePluginRepositories) Returns a map of all possible updates per dependency.
ArtifactVersions	lookupDependencyUpdates(org.apache.maven.model.Dependency dependency, boolean usePluginRepositories) Creates an ArtifactVersions instance from a dependency.
Map<org.apache.maven.model.Plugin,PluginUpdatesDetails>	lookupPluginsUpdates(Set<org.apache.maven.model.Plugin> plugins, boolean allowSnapshots) Looks up the updates for a set of plugins.
PluginUpdatesDetails	lookupPluginUpdates(org.apache.maven.model.Plugin plugin, boolean allowSnapshots) Looks up the updates for a plugin.
void	resolveArtifact(org.apache.maven.artifact.Artifact artifact, boolean usePluginRepositories) Attempts to resolve the artifact.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getLog

public org.apache.maven.plugin.logging.Log getLog()

Description copied from interface: VersionsHelper

Gets the logger used by this helper.

Specified by:

getLog in interface VersionsHelper

Returns:

the logger used by this helper.

lookupArtifactVersions

public ArtifactVersions lookupArtifactVersions(org.apache.maven.artifact.Artifact artifact,
                                               boolean usePluginRepositories)
                                        throws org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException

Description copied from interface: VersionsHelper

Looks up the versions of the specified artifact that are available in either the local repository, or the appropriate remote repositories.

Specified by:

lookupArtifactVersions in interface VersionsHelper

Parameters:

artifact - The artifact to look for versions of.

usePluginRepositories - true will consult the pluginRepositories, while false will consult the repositories for normal dependencies.

Returns:

The details of the available artifact versions.

Throws:

org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException - When things go wrong.

resolveArtifact

public void resolveArtifact(org.apache.maven.artifact.Artifact artifact,
                            boolean usePluginRepositories)
                     throws org.apache.maven.artifact.resolver.ArtifactResolutionException,
                            org.apache.maven.artifact.resolver.ArtifactNotFoundException

Description copied from interface: VersionsHelper

Attempts to resolve the artifact.

Specified by:

resolveArtifact in interface VersionsHelper

Parameters:

artifact - The artifact to resolve.

usePluginRepositories - whether to resolve from the plugin repositories or the regular repositories.

Throws:

org.apache.maven.artifact.resolver.ArtifactResolutionException - if something goes wrong.

org.apache.maven.artifact.resolver.ArtifactNotFoundException - if something goes wrong.

getVersionComparator

public VersionComparator getVersionComparator(org.apache.maven.artifact.Artifact artifact)

Description copied from interface: VersionsHelper

Returns the version comparator to use for the specified artifact.

Specified by:

getVersionComparator in interface VersionsHelper

Parameters:

artifact - the artifact.

Returns:

the version comparator to use.

getVersionComparator

public VersionComparator getVersionComparator(String groupId,
                                              String artifactId)

Description copied from interface: VersionsHelper

Returns the version comparator to use for the specified groupId and artifactId.

Specified by:

getVersionComparator in interface VersionsHelper

Parameters:

groupId - the groupId.

artifactId - the artifactId.

Returns:

the version comparator to use.

getBestFitRule

protected org.codehaus.mojo.versions.model.Rule getBestFitRule(String groupId,
                                                               String artifactId)

Find the rule, if any, which best fits the artifact details given.

Parameters:

groupId - Group id of the artifact

artifactId - Artifact id of the artifact

Returns:

Rule which best describes the given artifact

createPluginArtifact

public org.apache.maven.artifact.Artifact createPluginArtifact(String groupId,
                                                               String artifactId,
                                                               String version)

Description copied from interface: VersionsHelper

Shorthand method for repositorySystem.createPluginArtifact(...).

Specified by:

createPluginArtifact in interface VersionsHelper

Parameters:

groupId - The group Id.

artifactId - The artifact Id.

version - The version range.

Returns:

the corresponding plugin artifact.

createDependencyArtifact

public org.apache.maven.artifact.Artifact createDependencyArtifact(String groupId,
                                                                   String artifactId,
                                                                   String version,
                                                                   String type,
                                                                   String classifier,
                                                                   String scope,
                                                                   boolean optional)

Description copied from interface: VersionsHelper

Shorthand method for repositorySystem.createDependencyArtifact(...).

Specified by:

createDependencyArtifact in interface VersionsHelper

Parameters:

groupId - The group id.

artifactId - The artifact id.

version - The version (possibly a range)

type - The type.

classifier - The classifier.

scope - The scope.

optional - If optional or not.

Returns:

The corresponding dependency artifact.

createDependencyArtifact

public org.apache.maven.artifact.Artifact createDependencyArtifact(String groupId,
                                                                   String artifactId,
                                                                   String version,
                                                                   String type,
                                                                   String classifier,
                                                                   String scope)

Description copied from interface: VersionsHelper

Shorthand method for getArtifactFactory().createDependencyArtifact(...).

Specified by:

createDependencyArtifact in interface VersionsHelper

Parameters:

groupId - The group id.

artifactId - The artifact id.

version - The version.

type - The type.

classifier - The classifier.

scope - The scope.

Returns:

The corresponding dependency artifact.

createDependencyArtifact

public org.apache.maven.artifact.Artifact createDependencyArtifact(org.apache.maven.model.Dependency dependency)

Description copied from interface: VersionsHelper

Shorthand method for repositorySystem.createDependencyArtifact(...) which extracts the parameters from the Dependency instance.

Specified by:

createDependencyArtifact in interface VersionsHelper

Parameters:

dependency - The dependency to create the artifact for.

Returns:

The corresponding dependency artifact.

extractArtifacts

public Set<org.apache.maven.artifact.Artifact> extractArtifacts(Collection<org.apache.maven.project.MavenProject> mavenProjects)

Description copied from interface: VersionsHelper

Takes a List of MavenProject instances and converts it into a Set of Artifact instances.

Specified by:

extractArtifacts in interface VersionsHelper

Parameters:

mavenProjects - the List of MavenProject instances.

Returns:

a Set of Artifact instances.

createArtifactVersion

public org.apache.maven.artifact.versioning.ArtifactVersion createArtifactVersion(String version)

Description copied from interface: VersionsHelper

Creates an ArtifactVersion instance from a string.

Specified by:

createArtifactVersion in interface VersionsHelper

Parameters:

version - the string representation of the version.

Returns:

The artifact version.

lookupDependenciesUpdates

public Map<org.apache.maven.model.Dependency,ArtifactVersions> lookupDependenciesUpdates(Set<org.apache.maven.model.Dependency> dependencies,
                                                                                         boolean usePluginRepositories)
                                                                                  throws org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException

Returns a map of all possible updates per dependency. The lookup is done in parallel using LOOKUP_PARALLEL_THREADS threads.

Specified by:

lookupDependenciesUpdates in interface VersionsHelper

Parameters:

dependencies - The set of Dependency instances to look up.

usePluginRepositories - Search the plugin repositories.

Returns:

map containing the ArtifactVersions object per dependency

Throws:

org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException - if the lookup does not succeed

lookupDependencyUpdates

public ArtifactVersions lookupDependencyUpdates(org.apache.maven.model.Dependency dependency,
                                                boolean usePluginRepositories)
                                         throws org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException

Description copied from interface: VersionsHelper

Creates an ArtifactVersions instance from a dependency.

Specified by:

lookupDependencyUpdates in interface VersionsHelper

Parameters:

dependency - The dependency.

usePluginRepositories - Search the plugin repositories.

Returns:

The details of updates to the dependency.

Throws:

org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException - When things go wrong.

lookupPluginsUpdates

public Map<org.apache.maven.model.Plugin,PluginUpdatesDetails> lookupPluginsUpdates(Set<org.apache.maven.model.Plugin> plugins,
                                                                                    boolean allowSnapshots)
                                                                             throws org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException

Description copied from interface: VersionsHelper

Looks up the updates for a set of plugins.

Specified by:

lookupPluginsUpdates in interface VersionsHelper

Parameters:

plugins - The set of Plugin instances to look up.

allowSnapshots - Include snapshots in the list of updates.

Returns:

A map, keyed by plugin, with values of type PluginUpdatesDetails.

Throws:

org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException - When things go wrong.

lookupPluginUpdates

public PluginUpdatesDetails lookupPluginUpdates(org.apache.maven.model.Plugin plugin,
                                                boolean allowSnapshots)
                                         throws org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException

Description copied from interface: VersionsHelper

Looks up the updates for a plugin.

Specified by:

lookupPluginUpdates in interface VersionsHelper

Parameters:

plugin - The Plugin instance to look up.

allowSnapshots - Include snapshots in the list of updates.

Returns:

The plugin update details.

Throws:

org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException - When things go wrong.

getExpressionEvaluator

public org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator getExpressionEvaluator(org.apache.maven.project.MavenProject project)

Description copied from interface: VersionsHelper

Returns an ExpressionEvaluator for the specified project.

Specified by:

getExpressionEvaluator in interface VersionsHelper

Parameters:

project - The project.

Returns:

an ExpressionEvaluator for the specified project.

getVersionPropertiesMap

public Map<Property,PropertyVersions> getVersionPropertiesMap(org.apache.maven.project.MavenProject project,
                                                              Property[] propertyDefinitions,
                                                              String includeProperties,
                                                              String excludeProperties,
                                                              boolean autoLinkItems)
                                                       throws org.apache.maven.plugin.MojoExecutionException

Description copied from interface: VersionsHelper

Returns a map of PropertyVersions values keyed by Property instances consisting of the properties defined in the project which are associated with version information.

Specified by:

getVersionPropertiesMap in interface VersionsHelper

Parameters:

project - The project.

propertyDefinitions - Any extra hints about properties.

includeProperties - A comma separated list of properties to include.

excludeProperties - A comma separated list of properties to exclude.

autoLinkItems - whether to automatically infer associations

Returns:

a map of PropertyVersions values keyed by Property instances.

Throws:

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