org.apache.maven.plugin.jxr

Class AggregatorJxrReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.apache.maven.plugin.jxr.AbstractJxrReport

org.apache.maven.plugin.jxr.JxrReport

org.apache.maven.plugin.jxr.AggregatorJxrReport

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="aggregate",
      aggregator=true)
 @Execute(phase=COMPILE)
public class AggregatorJxrReport
extends JxrReport

Generates a combined JXR report in an aggregating project.

Since:

2.3

Field Summary

Fields inherited from class org.apache.maven.plugin.jxr.AbstractJxrReport

skip

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

locale, mojoExecution, outputDirectory, outputFormat, outputTimestamp, project, reactorProjects, remoteProjectRepositories, repoSession, siteDirectory, siteRenderer, siteTool

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 and Description
AggregatorJxrReport()

Method Summary

Modifier and Type	Method and Description
protected boolean	isAggregate() Is the current report aggregated?

Methods inherited from class org.apache.maven.plugin.jxr.JxrReport

getDescription, getJavadocLocation, getName, getOutputName, getPluginReportOutputDirectory, getSourceRoots, getSourceRoots

Methods inherited from class org.apache.maven.plugin.jxr.AbstractJxrReport

canGenerateReport, constructSourceDirs, executeReport, getBundle, getMojoExecution, getProject, getReactorProjects, getSession, init, isExternalReport, pruneSourceDirs

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

closeReport, constructXrefLocation, execute, generate, generate, getCategoryName, getInputEncoding, getLocale, getOutputDirectory, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, getXrefLocation, 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

getOutputPath

Constructor Detail

AggregatorJxrReport

public AggregatorJxrReport()

Method Detail

isAggregate

protected boolean isAggregate()

Description copied from class: AbstractJxrReport

Is the current report aggregated?

Overrides:

isAggregate in class AbstractJxrReport

Returns:

true if aggregate, false otherwise