Interface SourceReferencesProvider
-
public interface SourceReferencesProvider
Provides the value of Eclipse-SourceReferences header [1] for a project with a given SCM URL of a maven SCM URL [2]. Implementations are plexus components which must declare their associated SCM type as role hint and are selected based on the matching type of the given SCM URL. [1] {@linkplain https://wiki.eclipse.org/PDE/UI/SourceReferences} [2] {@linkplain http://maven.apache.org/scm/scm-url-format.html}
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getSourceReferencesHeader(org.apache.maven.project.MavenProject project, ScmUrl scmUrl)
Provides the Eclipse-SourceReferences MANIFEST header value for the given maven project with given SCM URL.
-
-
-
Method Detail
-
getSourceReferencesHeader
java.lang.String getSourceReferencesHeader(org.apache.maven.project.MavenProject project, ScmUrl scmUrl) throws org.apache.maven.plugin.MojoExecutionException
Provides the Eclipse-SourceReferences MANIFEST header value for the given maven project with given SCM URL.- Parameters:
project
- the project for which to calculate the headerscmUrl
- the SCM URL of the project- Returns:
- the header value. Must be a parseable value as defined by
ManifestElement.parseHeader(String, String)
- Throws:
org.apache.maven.plugin.MojoExecutionException
-
-