Package org.apache.maven.plugins.checkstyle

Class CheckstyleAggregateReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport

org.apache.maven.plugins.checkstyle.CheckstyleAggregateReport

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="checkstyle-aggregate",
      aggregator=true,
      requiresDependencyResolution=COMPILE,
      threadSafe=true)
public class CheckstyleAggregateReport
extends AbstractCheckstyleReport

A reporting task that performs Checkstyle analysis and generates an aggregate HTML report on the violations that Checkstyle finds in a multi-module reactor build.

Field Summary

Fields inherited from class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport

cacheFile, checkstyleExecutor, configLocation, consoleOutput, excludes, failsOnError, headerLocation, includeResources, includes, includeTestResources, includeTestSourceDirectory, JAVA_FILES, locator, propertiesLocation, propertyExpansion, resourceExcludes, resourceIncludes, resources, skip, stringOutputStream, suppressionsFileExpression, suppressionsLocation, testResources

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	Description
CheckstyleAggregateReport()

Method Summary

Modifier and Type	Method	Description
boolean	canGenerateReport()
protected CheckstyleExecutorRequest	createRequest()	Create the Checkstyle executor request.
String	getOutputName()

Methods inherited from class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport

executeReport, getConsoleListener, getDescription, getI18nString, getListener, getName, getProject, getReactorProjects, getSourceDirectories, getTestSourceDirectories

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

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

getOutputPath

Constructor Details

CheckstyleAggregateReport

public CheckstyleAggregateReport()

Method Details

createRequest

protected CheckstyleExecutorRequest createRequest()
                                           throws org.apache.maven.reporting.MavenReportException

Create the Checkstyle executor request.

Specified by:

createRequest in class AbstractCheckstyleReport

Returns:

The executor request.

Throws:

org.apache.maven.reporting.MavenReportException - If something goes wrong during creation.

getOutputName

public String getOutputName()

canGenerateReport

public boolean canGenerateReport()

Specified by:

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

Overrides:

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