public abstract class AbstractCheckstyleReport extends AbstractMavenReport
Modifier and Type | Field and Description |
---|---|
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 |
protected List<Resource> |
testResources
Specifies the location of the test resources to be used for Checkstyle.
|
CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE
Constructor and Description |
---|
AbstractCheckstyleReport() |
Modifier and Type | Method and Description |
---|---|
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) |
canGenerateReport, closeReport, execute, generate, generate, generate, getCategoryName, getReportOutputDirectory, getSink, getSinkFactory, isExternalReport
getLog, getPluginContext, setLog, setPluginContext
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getOutputName
public static final String PLUGIN_RESOURCES
protected static final String JAVA_FILES
@Parameter(property="checkstyle.skip", defaultValue="false") protected boolean skip
@Parameter(defaultValue="${project.resources}", readonly=true) protected List<Resource> resources
@Parameter(defaultValue="${project.testResources}", readonly=true) protected List<Resource> testResources
@Component(role=org.apache.maven.doxia.tools.SiteTool.class) protected SiteTool siteTool
@Component protected MavenProject project
@Component protected ResourceManager locator
@Component(role=CheckstyleRssGenerator.class, hint="default") protected CheckstyleRssGenerator checkstyleRssGenerator
@Component(role=CheckstyleExecutor.class, hint="default") protected CheckstyleExecutor checkstyleExecutor
protected ByteArrayOutputStream stringOutputStream
protected String getOutputDirectory()
getOutputDirectory
in class AbstractMavenReport
protected MavenProject getProject()
getProject
in class AbstractMavenReport
protected Renderer getSiteRenderer()
getSiteRenderer
in class AbstractMavenReport
public void executeReport(Locale locale) throws MavenReportException
executeReport
in class AbstractMavenReport
MavenReportException
protected abstract CheckstyleExecutorRequest createRequest() throws MavenReportException
MavenReportException
- If something goes wrong during creation.protected AuditListener getListener() throws MavenReportException
MavenReportException
- If something goes wrong.protected DefaultLogger getConsoleListener() throws MavenReportException
MavenReportException
- If something goes wrong.public void setReportOutputDirectory(File reportOutputDirectory)
setReportOutputDirectory
in interface MavenReport
setReportOutputDirectory
in class AbstractMavenReport
Copyright © 2005-2013 The Apache Software Foundation. All Rights Reserved.