|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.codehaus.mojo.versions.AbstractVersionsReport
public abstract class AbstractVersionsReport
Base class for all versions reports.
Field Summary | |
---|---|
protected Boolean |
allowSnapshots
Whether to allow snapshots when searching for the latest version of an artifact. |
protected org.apache.maven.artifact.factory.ArtifactFactory |
artifactFactory
|
protected org.apache.maven.artifact.metadata.ArtifactMetadataSource |
artifactMetadataSource
The artifact metadata source to use. |
protected String |
comparisonMethod
The versioning rule to use when comparing versions. |
protected org.apache.maven.artifact.repository.ArtifactRepository |
localRepository
|
protected org.apache.maven.project.path.PathTranslator |
pathTranslator
|
protected List |
remoteArtifactRepositories
|
protected List |
remotePluginRepositories
|
protected org.apache.maven.execution.MavenSession |
session
The Maven Session. |
Fields inherited from interface org.apache.maven.reporting.MavenReport |
---|
CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE |
Fields inherited from interface org.apache.maven.plugin.Mojo |
---|
ROLE |
Constructor Summary | |
---|---|
AbstractVersionsReport()
|
Method Summary | |
---|---|
protected abstract void |
doGenerateReport(Locale locale,
org.apache.maven.doxia.sink.Sink sink)
generates the report. |
protected void |
executeReport(Locale locale)
|
protected org.apache.maven.artifact.versioning.ArtifactVersion |
findLatestVersion(org.apache.maven.artifact.Artifact artifact,
org.apache.maven.artifact.versioning.VersionRange versionRange,
Boolean allowingSnapshots,
boolean usePluginRepositories)
Finds the latest version of the specified artifact that matches the version range. |
Boolean |
getAllowSnapshots()
|
String |
getComparisonMethod()
|
String |
getDescription(Locale locale)
|
VersionsHelper |
getHelper()
|
org.codehaus.plexus.i18n.I18N |
getI18n()
|
String |
getName(Locale locale)
|
protected String |
getOutputDirectory()
|
protected org.apache.maven.project.MavenProject |
getProject()
|
org.apache.maven.artifact.resolver.ArtifactResolver |
getResolver()
|
protected org.apache.maven.doxia.siterenderer.Renderer |
getSiteRenderer()
|
String |
getText(Locale locale,
String key)
Gets the localized message for this report. |
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport |
---|
canGenerateReport, closeReport, execute, generate, generate, generate, getCategoryName, getReportOutputDirectory, getSink, getSinkFactory, isExternalReport, setReportOutputDirectory |
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 |
Methods inherited from interface org.apache.maven.reporting.MavenReport |
---|
getOutputName |
Field Detail |
---|
protected org.apache.maven.artifact.factory.ArtifactFactory artifactFactory
protected org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource
protected List remoteArtifactRepositories
protected List remotePluginRepositories
protected org.apache.maven.artifact.repository.ArtifactRepository localRepository
protected String comparisonMethod
maven
,
numeric
which will handle long version numbers provided all components are numeric, or
mercury
which will use the mercury version number comparison rules.
protected Boolean allowSnapshots
protected org.apache.maven.execution.MavenSession session
protected org.apache.maven.project.path.PathTranslator pathTranslator
Constructor Detail |
---|
public AbstractVersionsReport()
Method Detail |
---|
public VersionsHelper getHelper() throws org.apache.maven.reporting.MavenReportException
org.apache.maven.reporting.MavenReportException
protected void executeReport(Locale locale) throws org.apache.maven.reporting.MavenReportException
executeReport
in class org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.reporting.MavenReportException
protected abstract void doGenerateReport(Locale locale, org.apache.maven.doxia.sink.Sink sink) throws org.apache.maven.reporting.MavenReportException, org.apache.maven.plugin.MojoExecutionException
locale
- the locale to generate the report for.sink
- the report formatting tool.
org.apache.maven.reporting.MavenReportException
- when things go wrong.
org.apache.maven.plugin.MojoExecutionException
protected org.apache.maven.artifact.versioning.ArtifactVersion findLatestVersion(org.apache.maven.artifact.Artifact artifact, org.apache.maven.artifact.versioning.VersionRange versionRange, Boolean allowingSnapshots, boolean usePluginRepositories) throws org.apache.maven.reporting.MavenReportException
artifact
- The artifact.versionRange
- The version range.allowingSnapshots
- null
for no override, otherwise the local override to apply.
null
if no matching version could be found.
org.apache.maven.plugin.MojoExecutionException
- If the artifact metadata could not be found.
org.apache.maven.reporting.MavenReportException
protected org.apache.maven.project.MavenProject getProject()
getProject
in class org.apache.maven.reporting.AbstractMavenReport
AbstractMavenReport.getProject()
protected String getOutputDirectory()
getOutputDirectory
in class org.apache.maven.reporting.AbstractMavenReport
AbstractMavenReport.getOutputDirectory()
protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
getSiteRenderer
in class org.apache.maven.reporting.AbstractMavenReport
AbstractMavenReport.getSiteRenderer()
public String getDescription(Locale locale)
MavenReport.getDescription(java.util.Locale)
public String getName(Locale locale)
MavenReport.getName(java.util.Locale)
public String getText(Locale locale, String key)
locale
- the locale.key
- the message key.
public Boolean getAllowSnapshots()
public String getComparisonMethod()
public org.apache.maven.artifact.resolver.ArtifactResolver getResolver()
public org.codehaus.plexus.i18n.I18N getI18n()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |