org.apache.maven.plugins.checkstyle

Class CheckstyleReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport

org.apache.maven.plugins.checkstyle.CheckstyleReport

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

A reporting task that performs Checkstyle analysis and generates an HTML report on any violations that Checkstyle finds.

Author:

Emmanuel Venisse, Vincent Siveton, Joakim Erdfelt

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

localRepository, outputDirectory, project, remoteRepositories, 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
CheckstyleReport()

Method Summary

Modifier and Type	Method and Description
boolean	canGenerateReport()
protected CheckstyleExecutorRequest	createRequest() Create the Checkstyle executor request.
String	getOutputName()
protected org.apache.maven.project.MavenProject	getProject()

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

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

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

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

Constructor Detail

CheckstyleReport

public CheckstyleReport()

Method Detail

getProject

protected org.apache.maven.project.MavenProject getProject()

Overrides:

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

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