|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.maven.plugin.AbstractMojo org.apache.maven.reporting.AbstractMavenReport org.apache.maven.plugin.checkstyle.AbstractCheckstyleReport
public abstract class AbstractCheckstyleReport
Base abstract class for Checkstyle reports.
Field Summary | |
---|---|
protected CheckstyleExecutor |
checkstyleExecutor
|
protected CheckstyleRssGenerator |
checkstyleRssGenerator
CheckstyleRssGenerator. |
protected org.codehaus.plexus.resource.ResourceManager |
locator
|
static String |
PLUGIN_RESOURCES
|
protected org.apache.maven.project.MavenProject |
project
The Maven Project Object. |
protected org.apache.maven.doxia.tools.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 com.puppycrawl.tools.checkstyle.DefaultLogger |
getConsoleListener()
Creates and returns the console listener. |
String |
getDescription(Locale locale)
|
protected com.puppycrawl.tools.checkstyle.api.AuditListener |
getListener()
Creates and returns the report generation listener. |
String |
getName(Locale locale)
|
protected String |
getOutputDirectory()
|
protected org.apache.maven.project.MavenProject |
getProject()
|
protected org.apache.maven.doxia.siterenderer.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 |
---|
public static final String PLUGIN_RESOURCES
protected boolean skip
protected org.apache.maven.doxia.tools.SiteTool siteTool
protected org.apache.maven.project.MavenProject project
protected org.codehaus.plexus.resource.ResourceManager locator
protected CheckstyleRssGenerator checkstyleRssGenerator
protected CheckstyleExecutor checkstyleExecutor
protected ByteArrayOutputStream stringOutputStream
Constructor Detail |
---|
public AbstractCheckstyleReport()
Method Detail |
---|
public String getName(Locale locale)
public String getDescription(Locale locale)
protected String getOutputDirectory()
getOutputDirectory
in class org.apache.maven.reporting.AbstractMavenReport
protected org.apache.maven.project.MavenProject getProject()
getProject
in class org.apache.maven.reporting.AbstractMavenReport
protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
getSiteRenderer
in class org.apache.maven.reporting.AbstractMavenReport
public void executeReport(Locale locale) throws org.apache.maven.reporting.MavenReportException
executeReport
in class org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.reporting.MavenReportException
protected abstract CheckstyleExecutorRequest createRequest() throws org.apache.maven.reporting.MavenReportException
org.apache.maven.reporting.MavenReportException
- If something goes wrong during creation.protected com.puppycrawl.tools.checkstyle.api.AuditListener getListener() throws org.apache.maven.reporting.MavenReportException
org.apache.maven.reporting.MavenReportException
- If something goes wrong.protected com.puppycrawl.tools.checkstyle.DefaultLogger getConsoleListener() throws org.apache.maven.reporting.MavenReportException
org.apache.maven.reporting.MavenReportException
- If something goes wrong.public void setReportOutputDirectory(File reportOutputDirectory)
setReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
setReportOutputDirectory
in class org.apache.maven.reporting.AbstractMavenReport
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |