CheckstyleReport (Apache Maven Checkstyle Plugin 3.1.2 API)

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:

ContextEnabled, Mojo, MavenMultiPageReport, 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, checkstyleRssGenerator, configLocation, consoleOutput, encoding, excludes, failsOnError, headerLocation, includeResources, includes, includeTestResources, includeTestSourceDirectory, JAVA_FILES, locator, PLUGIN_RESOURCES, propertiesLocation, propertyExpansion, resourceExcludes, resourceIncludes, resources, siteTool, skip, stringOutputStream, suppressionsFileExpression, suppressionsLocation, testResources
- Fields inherited from class org.apache.maven.reporting.AbstractMavenReport
  outputDirectory, 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

CheckstyleReport()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`canGenerateReport()`
`protected CheckstyleExecutorRequest`	`createRequest()`	Create the Checkstyle executor request.
`java.lang.String`	`getOutputName()`
`protected MavenProject`	`getProject()`

Methods inherited from class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
executeReport, getConsoleListener, getDescription, 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 MavenProject getProject()
```
    Overrides:
    
    getProject in class AbstractMavenReport
  - createRequest
```
protected CheckstyleExecutorRequest createRequest()
                                           throws MavenReportException
```
    Create the Checkstyle executor request.
    
    Specified by:
    
    createRequest in class AbstractCheckstyleReport
    
    Returns:
    
    The executor request.
    
    Throws:
    
    MavenReportException - If something goes wrong during creation.
  - getOutputName
```
public java.lang.String getOutputName()
```
  - canGenerateReport
```
public boolean canGenerateReport()
```
    Specified by:
    
    canGenerateReport in interface MavenReport
    
    Overrides:
    
    canGenerateReport in class AbstractMavenReport