Package org.revapi.maven

Class ReportAggregateMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.revapi.maven.ReportMojo

org.revapi.maven.ReportAggregateMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport

@Mojo(name="report-aggregate",
      aggregator=true,
      defaultPhase=SITE)
@Execute(phase=PACKAGE)
public class ReportAggregateMojo
extends ReportMojo

Uses the configuration supplied at the top level aggregator project to run analysis on all sub-projects.

The artifacts to compare are taken from the configurations of the child projects while the configuration of Revapi and the extensions to use are taken from the aggregator project. The analyses are run in succession using a single instance of Revapi. Therefore you need to configure your custom Revapi reporter(s) to somehow not overwrite their reports, but append to it. The default site page generator can do this and the revapi-reporter-text reporter has an append boolean parameter for this. If you're using some other reporter, consult its documentation on how to append to a report instead of overwriting it.

Since:

0.5.0

Author:

Lukas Krejci

Field Summary

Fields inherited from class org.revapi.maven.ReportMojo

alwaysCheckForReleaseVersion, analysisConfiguration, analysisConfigurationFiles, checkDependencies, disallowedExtensions, expandProperties, failOnMissingConfigurationFiles, failOnUnresolvedArtifacts, failOnUnresolvedDependencies, generateSiteReport, newArtifacts, newPromotedDependencies, newVersion, oldArtifacts, oldPromotedDependencies, oldVersion, outputDirectory, pipelineConfiguration, promotedDependencies, reportCriticality, reportSeverity, repositorySystem, repositorySystemSession, resolveProvidedDependencies, resolveTransitiveProvidedDependencies, skip, versionFormat

Fields inherited from class org.apache.maven.reporting.AbstractMavenReport

project, siteRenderer

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

Constructors

Constructor	Description
ReportAggregateMojo()

Method Summary

Modifier and Type	Method	Description
boolean	canGenerateReport()
protected void	executeReport(Locale locale)
protected static org.apache.maven.model.Plugin	findRevapi(org.apache.maven.project.MavenProject project)
protected static String[]	getArtifacts(org.codehaus.plexus.util.xml.Xpp3Dom config, String artifactTag)
String	getDescription(Locale locale)
protected String	getOutputDirectory()
String	getOutputName()
File	getReportOutputDirectory()
protected void	reportBody(ReportTimeReporter reporterWithResults, org.revapi.API oldAPI, org.revapi.API newAPI, org.apache.maven.doxia.sink.Sink sink, ResourceBundle messages)
void	setReportOutputDirectory(File reportOutputDirectory)

Methods inherited from class org.revapi.maven.ReportMojo

endReport, getBundle, getName, getProject, niceList, prepareAnalyzer, startReport

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

closeReport, execute, generate, generate, generate, getCategoryName, getInputEncoding, getOutputEncoding, getSink, getSinkFactory, getSiteRenderer, isExternalReport

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

Constructor Detail

ReportAggregateMojo

public ReportAggregateMojo()

Method Detail

getOutputName

public String getOutputName()

Specified by:

getOutputName in interface org.apache.maven.reporting.MavenReport

Overrides:

getOutputName in class ReportMojo

getReportOutputDirectory

public File getReportOutputDirectory()

Specified by:

getReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

Overrides:

getReportOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport

getOutputDirectory

protected String getOutputDirectory()

Overrides:

getOutputDirectory in class ReportMojo

setReportOutputDirectory

public void setReportOutputDirectory(File reportOutputDirectory)

Specified by:

setReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

Overrides:

setReportOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport

getDescription

public String getDescription(Locale locale)

Specified by:

getDescription in interface org.apache.maven.reporting.MavenReport

Overrides:

getDescription in class ReportMojo

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface org.apache.maven.reporting.MavenReport

Overrides:

canGenerateReport in class ReportMojo

executeReport

protected void executeReport(Locale locale)
                      throws org.apache.maven.reporting.MavenReportException

Overrides:

executeReport in class ReportMojo

Throws:

org.apache.maven.reporting.MavenReportException

reportBody

protected void reportBody(ReportTimeReporter reporterWithResults,
                          org.revapi.API oldAPI,
                          org.revapi.API newAPI,
                          org.apache.maven.doxia.sink.Sink sink,
                          ResourceBundle messages)

Overrides:

reportBody in class ReportMojo

findRevapi

protected static org.apache.maven.model.Plugin findRevapi(org.apache.maven.project.MavenProject project)

getArtifacts

protected static String[] getArtifacts(org.codehaus.plexus.util.xml.Xpp3Dom config,
                                       String artifactTag)