org.codehaus.mojo.versions.api
Interface VersionsHelper

All Known Implementing Classes:

DefaultVersionsHelper

public interface VersionsHelper

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

Since:

1.0-alpha-3

Author:

Stephen Connolly

Method Summary

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 getArtifactFactory().createDependencyArtifact(...) which extracts the parameters from the Dependency instance.
org.apache.maven.artifact.Artifact	createDependencyArtifact(String groupId, String artifactId, org.apache.maven.artifact.versioning.VersionRange versionRange, String type, String classifier, String scope) Shorthand method for getArtifactFactory().createDependencyArtifact(...).
org.apache.maven.artifact.Artifact	createDependencyArtifact(String groupId, String artifactId, org.apache.maven.artifact.versioning.VersionRange version, String type, String classifier, String scope, boolean optional) Shorthand method for getArtifactFactory().createDependencyArtifact(...).
org.apache.maven.artifact.Artifact	createPluginArtifact(String groupId, String artifactId, org.apache.maven.artifact.versioning.VersionRange version) Shorthand method for getArtifactFactory().createPluginArtifact(...).
Set	extractArtifacts(Collection mavenProjects) Takes a List of MavenProject instances and converts it into a Set of Artifact instances.
org.apache.maven.artifact.factory.ArtifactFactory	getArtifactFactory() Returns the artifact factory to use.
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	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	lookupArtifactUpdates(org.apache.maven.artifact.Artifact artifact, Boolean allowSnapshots, boolean usePluginRepositories) Looks up the updates of an artifact.
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	lookupDependenciesUpdates(Set dependencies, boolean usePluginRepositories) Looks up the updates for a set of dependencies.
ArtifactVersions	lookupDependencyUpdates(org.apache.maven.model.Dependency dependency, boolean usePluginRepositories) Creates an ArtifactVersions instance from a dependency.
Map	lookupPluginsUpdates(Set 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.

Method Detail

getLog

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

Gets the logger used by this helper.

Returns:

the logger used by this helper.

getVersionComparator

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

Returns the version comparator to use for the specified artifact.

Parameters:

artifact - the artifact.

Returns:

the version comparator to use.

Since:

1.0-alpha-3

getVersionComparator

VersionComparator getVersionComparator(String groupId,
                                       String artifactId)

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

Parameters:

groupId - the groupId.

artifactId - the artifactId.

Returns:

the version comparator to use.

Since:

1.0-alpha-3

getArtifactFactory

org.apache.maven.artifact.factory.ArtifactFactory getArtifactFactory()

Returns the artifact factory to use.

Returns:

the artifact factory to use.

Since:

1.0-alpha-3

createPluginArtifact

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

Shorthand method for getArtifactFactory().createPluginArtifact(...).

Parameters:

groupId - The group Id.

artifactId - The artifact Id.

version - The version range.

Returns:

the corresponding plugin artifact.

Since:

1.0-alpha-3

createDependencyArtifact

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

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

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.

Since:

1.0-alpha-3

createDependencyArtifact

org.apache.maven.artifact.Artifact createDependencyArtifact(String groupId,
                                                            String artifactId,
                                                            org.apache.maven.artifact.versioning.VersionRange versionRange,
                                                            String type,
                                                            String classifier,
                                                            String scope)

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

Parameters:

groupId - The group id.

artifactId - The artifact id.

versionRange - The version range.

type - The type.

classifier - The classifier.

scope - The scope.

Returns:

The corresponding dependency artifact.

Since:

1.0-beta-1

createDependencyArtifact

org.apache.maven.artifact.Artifact createDependencyArtifact(org.apache.maven.model.Dependency dependency)
                                                            throws org.apache.maven.artifact.versioning.InvalidVersionSpecificationException

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

Parameters:

dependency - The dependency to create the artifact for.

Returns:

The corresponding dependency artifact.

Throws:

org.apache.maven.artifact.versioning.InvalidVersionSpecificationException - if the version specified in the dependency is invalid.

Since:

1.0-alpha-3

extractArtifacts

Set extractArtifacts(Collection mavenProjects)

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

Parameters:

mavenProjects - the List of MavenProject instances.

Returns:

a Set of Artifact instances.

Since:

1.0-alpha-3

createArtifactVersion

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

Creates an ArtifactVersion instance from a string.

Parameters:

version - the string representation of the version.

Returns:

The artifact version.

Since:

1.0-beta-1

lookupArtifactVersions

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

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

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.

Since:

1.0-alpha-3

lookupArtifactUpdates

ArtifactVersions lookupArtifactUpdates(org.apache.maven.artifact.Artifact artifact,
                                       Boolean allowSnapshots,
                                       boolean usePluginRepositories)
                                       throws org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException

Looks up the updates of an artifact.

Parameters:

artifact - The artifact to look up

allowSnapshots - Include snapshots in the list of updates.

usePluginRepositories - Search the plugin repositories.

Returns:

The artifact update details.

Throws:

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

lookupDependenciesUpdates

Map lookupDependenciesUpdates(Set dependencies,
                              boolean usePluginRepositories)
                              throws org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException,
                                     org.apache.maven.artifact.versioning.InvalidVersionSpecificationException

Looks up the updates for a set of dependencies.

Parameters:

dependencies - The set of Dependency instances to look up.

usePluginRepositories - Search the plugin repositories.

Returns:

A map, keyed by dependency, with values of type ArtifactVersions.

Throws:

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

org.apache.maven.artifact.versioning.InvalidVersionSpecificationException

Since:

1.0-beta-1

lookupDependencyUpdates

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

Creates an ArtifactVersions instance from a dependency.

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.

org.apache.maven.artifact.versioning.InvalidVersionSpecificationException

Since:

1.0-beta-1

lookupPluginsUpdates

Map lookupPluginsUpdates(Set plugins,
                         Boolean allowSnapshots)
                         throws org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException,
                                org.apache.maven.artifact.versioning.InvalidVersionSpecificationException

Looks up the updates for a set of plugins.

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.

org.apache.maven.artifact.versioning.InvalidVersionSpecificationException

Since:

1.0-beta-1

lookupPluginUpdates

PluginUpdatesDetails lookupPluginUpdates(org.apache.maven.model.Plugin plugin,
                                         Boolean allowSnapshots)
                                         throws org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException,
                                                org.apache.maven.artifact.versioning.InvalidVersionSpecificationException

Looks up the updates for a plugin.

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.

org.apache.maven.artifact.versioning.InvalidVersionSpecificationException

Since:

1.0-beta-1

getExpressionEvaluator

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

Returns an ExpressionEvaluator for the specified project.

Parameters:

project - The project.

Returns:

an ExpressionEvaluator for the specified project.

Since:

1.0-beta-1

getVersionPropertiesMap

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

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

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.

resolveArtifact

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

Attempts to resolve the artifact.

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

org.apache.maven.artifact.resolver.ArtifactNotFoundException

Since:

1.3