|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.mojo.versions.api.DefaultVersionsHelper
public class DefaultVersionsHelper
Helper class that provides common functionality required by both the mojos and the reports.
Constructor Summary | |
---|---|
DefaultVersionsHelper(org.apache.maven.artifact.factory.ArtifactFactory artifactFactory,
org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource,
List remoteArtifactRepositories,
List remotePluginRepositories,
org.apache.maven.artifact.repository.ArtifactRepository localRepository,
org.apache.maven.artifact.manager.WagonManager wagonManager,
org.apache.maven.settings.Settings settings,
String serverId,
String rulesUri,
org.apache.maven.plugin.logging.Log log,
org.apache.maven.execution.MavenSession mavenSession,
org.apache.maven.project.path.PathTranslator pathTranslator)
Constructs a new DefaultVersionsHelper . |
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 versionRange,
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 versionRange)
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DefaultVersionsHelper(org.apache.maven.artifact.factory.ArtifactFactory artifactFactory, org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource, List remoteArtifactRepositories, List remotePluginRepositories, org.apache.maven.artifact.repository.ArtifactRepository localRepository, org.apache.maven.artifact.manager.WagonManager wagonManager, org.apache.maven.settings.Settings settings, String serverId, String rulesUri, org.apache.maven.plugin.logging.Log log, org.apache.maven.execution.MavenSession mavenSession, org.apache.maven.project.path.PathTranslator pathTranslator) throws org.apache.maven.plugin.MojoExecutionException
DefaultVersionsHelper
.
artifactFactory
- The artifact factory.artifactMetadataSource
- The artifact metadata source to use.remoteArtifactRepositories
- The remote artifact repositories to consult.remotePluginRepositories
- The remote plugin repositories to consult.localRepository
- The local repository to consult.wagonManager
- The wagon manager (used if rules need to be retrieved).settings
- The settings (used to provide proxy information to the wagon manager).serverId
- The serverId hint for the wagon manager.rulesUri
- The URL to retrieve the versioning rules from.log
- The Log
to send log messages to.mavenSession
- The maven session information.pathTranslator
- The path translator component.
org.apache.maven.plugin.MojoExecutionException
- If things go wrong.Method Detail |
---|
public org.apache.maven.artifact.factory.ArtifactFactory getArtifactFactory()
getArtifactFactory
in interface VersionsHelper
public org.apache.maven.plugin.logging.Log getLog()
getLog
in interface VersionsHelper
public ArtifactVersions lookupArtifactVersions(org.apache.maven.artifact.Artifact artifact, boolean usePluginRepositories) throws org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException
lookupArtifactVersions
in interface VersionsHelper
artifact
- The artifact to look for versions of.usePluginRepositories
- true
will consult the pluginRepositories, while false
will consult the repositories for normal dependencies.
org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException
- When things go wrong.public VersionComparator getVersionComparator(org.apache.maven.artifact.Artifact artifact)
getVersionComparator
in interface VersionsHelper
artifact
- the artifact.
public VersionComparator getVersionComparator(String groupId, String artifactId)
getVersionComparator
in interface VersionsHelper
groupId
- the groupId.artifactId
- the artifactId.
public org.apache.maven.artifact.Artifact createPluginArtifact(String groupId, String artifactId, org.apache.maven.artifact.versioning.VersionRange versionRange)
getArtifactFactory().createPluginArtifact(...)
.
createPluginArtifact
in interface VersionsHelper
groupId
- The group Id.artifactId
- The artifact Id.versionRange
- The version range.
public org.apache.maven.artifact.Artifact createDependencyArtifact(String groupId, String artifactId, org.apache.maven.artifact.versioning.VersionRange versionRange, String type, String classifier, String scope, boolean optional)
getArtifactFactory().createDependencyArtifact(...)
.
createDependencyArtifact
in interface VersionsHelper
groupId
- The group id.artifactId
- The artifact id.versionRange
- The version (possibly a range)type
- The type.classifier
- The classifier.scope
- The scope.optional
- If optional or not.
public org.apache.maven.artifact.Artifact createDependencyArtifact(String groupId, String artifactId, org.apache.maven.artifact.versioning.VersionRange versionRange, String type, String classifier, String scope)
getArtifactFactory().createDependencyArtifact(...)
.
createDependencyArtifact
in interface VersionsHelper
groupId
- The group id.artifactId
- The artifact id.versionRange
- The version range.type
- The type.classifier
- The classifier.scope
- The scope.
public org.apache.maven.artifact.Artifact createDependencyArtifact(org.apache.maven.model.Dependency dependency) throws org.apache.maven.artifact.versioning.InvalidVersionSpecificationException
getArtifactFactory().createDependencyArtifact(...)
which extracts the
parameters from the Dependency instance.
createDependencyArtifact
in interface VersionsHelper
dependency
- The dependency to create the artifact for.
org.apache.maven.artifact.versioning.InvalidVersionSpecificationException
- if the version specified in the dependency is invalid.public Set extractArtifacts(Collection mavenProjects)
List
of MavenProject
instances and converts it into a
Set
of Artifact
instances.
extractArtifacts
in interface VersionsHelper
mavenProjects
- the List
of MavenProject
instances.
Set
of Artifact
instances.public org.apache.maven.artifact.versioning.ArtifactVersion createArtifactVersion(String version)
ArtifactVersion
instance from a string.
createArtifactVersion
in interface VersionsHelper
version
- the string representation of the version.
public ArtifactVersions lookupArtifactUpdates(org.apache.maven.artifact.Artifact artifact, Boolean allowSnapshots, boolean usePluginRepositories) throws org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException
lookupArtifactUpdates
in interface VersionsHelper
artifact
- The artifact to look upallowSnapshots
- Include snapshots in the list of updates.usePluginRepositories
- Search the plugin repositories.
org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException
- When things go wrong.public Map lookupDependenciesUpdates(Set dependencies, boolean usePluginRepositories) throws org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException, org.apache.maven.artifact.versioning.InvalidVersionSpecificationException
lookupDependenciesUpdates
in interface VersionsHelper
dependencies
- The set of Dependency
instances to look up.usePluginRepositories
- Search the plugin repositories.
ArtifactVersions
.
org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException
- When things go wrong.
org.apache.maven.artifact.versioning.InvalidVersionSpecificationException
public ArtifactVersions lookupDependencyUpdates(org.apache.maven.model.Dependency dependency, boolean usePluginRepositories) throws org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException, org.apache.maven.artifact.versioning.InvalidVersionSpecificationException
ArtifactVersions
instance from a dependency.
lookupDependencyUpdates
in interface VersionsHelper
dependency
- The dependency.usePluginRepositories
- Search the plugin repositories.
org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException
- When things go wrong.
org.apache.maven.artifact.versioning.InvalidVersionSpecificationException
public Map lookupPluginsUpdates(Set plugins, Boolean allowSnapshots) throws org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException, org.apache.maven.artifact.versioning.InvalidVersionSpecificationException
lookupPluginsUpdates
in interface VersionsHelper
plugins
- The set of Plugin
instances to look up.allowSnapshots
- Include snapshots in the list of updates.
PluginUpdatesDetails
.
org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException
- When things go wrong.
org.apache.maven.artifact.versioning.InvalidVersionSpecificationException
public PluginUpdatesDetails lookupPluginUpdates(org.apache.maven.model.Plugin plugin, Boolean allowSnapshots) throws org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException, org.apache.maven.artifact.versioning.InvalidVersionSpecificationException
lookupPluginUpdates
in interface VersionsHelper
plugin
- The Plugin
instance to look up.allowSnapshots
- Include snapshots in the list of updates.
org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException
- When things go wrong.
org.apache.maven.artifact.versioning.InvalidVersionSpecificationException
public org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator getExpressionEvaluator(org.apache.maven.project.MavenProject project)
ExpressionEvaluator
for the specified project.
getExpressionEvaluator
in interface VersionsHelper
project
- The project.
ExpressionEvaluator
for the specified project.public Map getVersionPropertiesMap(org.apache.maven.project.MavenProject project, Property[] propertyDefinitions, String includeProperties, String excludeProperties, boolean autoLinkItems) throws org.apache.maven.plugin.MojoExecutionException
PropertyVersions
values keyed by
Property
instances consisting of the properties defined in the project
which are associated with version information.
getVersionPropertiesMap
in interface VersionsHelper
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
PropertyVersions
values keyed by
Property
instances.
org.apache.maven.plugin.MojoExecutionException
- if something goes wrong.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |