AbstractCheckstyleReport (Maven Checkstyle Plugin 2.10 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.maven.plugin.checkstyle
Class AbstractCheckstyleReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          org.apache.maven.plugin.checkstyle.AbstractCheckstyleReport

All Implemented Interfaces:: ContextEnabled, Mojo, MavenMultiPageReport, MavenReport

Direct Known Subclasses:: CheckstyleAggregateReport, CheckstyleReport

public abstract class AbstractCheckstyleReport
extends AbstractMavenReport
extends AbstractMavenReport

Base abstract class for Checkstyle reports.

Since:: 2.8
Version:: $Id: AbstractCheckstyleReport.java 1429852 2013-01-07 15:44:18Z dennisl $

Field Summary
`protected CheckstyleExecutor`	`checkstyleExecutor`
`protected CheckstyleRssGenerator`	`checkstyleRssGenerator` CheckstyleRssGenerator.
`protected static String`	`JAVA_FILES`
`protected ResourceManager`	`locator`
`static String`	`PLUGIN_RESOURCES`
`protected MavenProject`	`project` The Maven Project Object.
`protected List<Resource>`	`resources` Specifies the location of the resources to be used for Checkstyle.
`protected SiteTool`	`siteTool` SiteTool.
`protected boolean`	`skip` Skip entire check.
`protected ByteArrayOutputStream`	`stringOutputStream`

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
`AbstractCheckstyleReport()`

Method Summary
`protected abstract CheckstyleExecutorRequest`	`createRequest()` Create the Checkstyle executor request.
`void`	`executeReport(Locale locale)`
`protected DefaultLogger`	`getConsoleListener()` Creates and returns the console listener.
`String`	`getDescription(Locale locale)`
`protected AuditListener`	`getListener()` Creates and returns the report generation listener.
`String`	`getName(Locale locale)`
`protected String`	`getOutputDirectory()`
`protected MavenProject`	`getProject()`
`protected Renderer`	`getSiteRenderer()`
`void`	`setReportOutputDirectory(File reportOutputDirectory)`

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
`canGenerateReport, closeReport, execute, generate, generate, generate, getCategoryName, getReportOutputDirectory, getSink, getSinkFactory, 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`

Methods inherited from interface org.apache.maven.reporting.MavenReport
`getOutputName`

Field Detail

PLUGIN_RESOURCES

public static final String PLUGIN_RESOURCES

See Also:: Constant Field Values

JAVA_FILES

protected static final String JAVA_FILES

See Also:: Constant Field Values

skip

@Parameter(property="checkstyle.skip",
           defaultValue="false")
protected boolean skip

Skip entire check.

Since:: 2.2

resources

@Parameter(defaultValue="${project.resources}",
           readonly=true)
protected List<Resource> resources

Specifies the location of the resources to be used for Checkstyle.

Since:: 2.10

siteTool

@Component(role=org.apache.maven.doxia.tools.SiteTool.class)
protected SiteTool siteTool

SiteTool.

Since:: 2.2

project

@Component
protected MavenProject project

The Maven Project Object.

locator

@Component
protected ResourceManager locator

checkstyleRssGenerator

@Component(role=CheckstyleRssGenerator.class,
           hint="default")
protected CheckstyleRssGenerator checkstyleRssGenerator

CheckstyleRssGenerator.

Since:: 2.4

checkstyleExecutor

@Component(role=CheckstyleExecutor.class,
           hint="default")
protected CheckstyleExecutor checkstyleExecutor

Since:: 2.5

stringOutputStream

protected ByteArrayOutputStream stringOutputStream

Constructor Detail

AbstractCheckstyleReport

public AbstractCheckstyleReport()

Method Detail

getName

public String getName(Locale locale)

getDescription

public String getDescription(Locale locale)

getOutputDirectory

protected String getOutputDirectory()

Specified by:: getOutputDirectory in class AbstractMavenReport

getProject

protected MavenProject getProject()

Specified by:: getProject in class AbstractMavenReport

getSiteRenderer

protected Renderer getSiteRenderer()

Specified by:: getSiteRenderer in class AbstractMavenReport

executeReport

public void executeReport(Locale locale)
                   throws MavenReportException

Specified by:: executeReport in class AbstractMavenReport

Throws:: MavenReportException

createRequest

protected abstract CheckstyleExecutorRequest createRequest()
                                                    throws MavenReportException

Create the Checkstyle executor request.

Returns:: The executor request.
Throws:: MavenReportException - If something goes wrong during creation.

getListener

protected AuditListener getListener()
                             throws MavenReportException

Creates and returns the report generation listener.

Returns:: The audit listener.
Throws:: MavenReportException - If something goes wrong.

getConsoleListener

protected DefaultLogger getConsoleListener()
                                    throws MavenReportException

Creates and returns the console listener.

Returns:: The console listener.
Throws:: MavenReportException - If something goes wrong.

setReportOutputDirectory

public void setReportOutputDirectory(File reportOutputDirectory)

Specified by:: setReportOutputDirectory in interface MavenReport
Overrides:: setReportOutputDirectory in class AbstractMavenReport