org.apache.maven.plugin.checkstyle
Class CheckstyleReport

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

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.reporting.MavenReport, org.apache.maven.plugin.Mojo

public class CheckstyleReport

extends org.apache.maven.reporting.AbstractMavenReport

Perform a Checkstyle analysis, and generate a report on violations.

Author:

Emmanuel Venisse, Vincent Siveton, Joakim Erdfelt

Field Summary

protected org.apache.maven.doxia.tools.SiteTool

siteTool 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

CheckstyleReport()

Method Summary

boolean	canGenerateReport()
void	executeReport(Locale locale)
String	getDescription(Locale locale)
String	getName(Locale locale)
protected String	getOutputDirectory()
String	getOutputName()
protected org.apache.maven.project.MavenProject	getProject()
protected org.codehaus.doxia.site.renderer.SiteRenderer	getSiteRenderer()
void	setReportOutputDirectory(File reportOutputDirectory)

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

closeReport, execute, generate, getCategoryName, getReportOutputDirectory, getSink, 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

Field Detail

siteTool

protected org.apache.maven.doxia.tools.SiteTool siteTool

SiteTool.

Since:

2.2

Constructor Detail

CheckstyleReport

public CheckstyleReport()

Method Detail

getName

public String getName(Locale locale)

See Also:

MavenReport.getName(java.util.Locale)

getDescription

public String getDescription(Locale locale)

See Also:

MavenReport.getDescription(java.util.Locale)

getOutputDirectory

protected String getOutputDirectory()

See Also:

AbstractMavenReport.getOutputDirectory()

getProject

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

See Also:

AbstractMavenReport.getProject()

getSiteRenderer

protected org.codehaus.doxia.site.renderer.SiteRenderer getSiteRenderer()

See Also:

AbstractMavenReport.getSiteRenderer()

executeReport

public void executeReport(Locale locale)
                   throws org.apache.maven.reporting.MavenReportException

Throws:

org.apache.maven.reporting.MavenReportException

See Also:

AbstractMavenReport.executeReport(java.util.Locale)

getOutputName

public String getOutputName()

See Also:

MavenReport.getOutputName()

canGenerateReport

public boolean canGenerateReport()

See Also:

AbstractMavenReport.canGenerateReport()

setReportOutputDirectory

public void setReportOutputDirectory(File reportOutputDirectory)

See Also:

AbstractMavenReport.setReportOutputDirectory(java.io.File)