org.apache.maven.plugins.checkstyle

Class AbstractCheckstyleReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport

All Implemented Interfaces:

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

Direct Known Subclasses:

CheckstyleAggregateReport, CheckstyleReport

public abstract class AbstractCheckstyleReport
extends org.apache.maven.reporting.AbstractMavenReport

Base abstract class for Checkstyle reports.

Version:

$Id$

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	cacheFile Specifies the cache file used to speed up Checkstyle on successive runs.
protected CheckstyleExecutor	checkstyleExecutor
protected CheckstyleRssGenerator	checkstyleRssGenerator CheckstyleRssGenerator.
protected java.lang.String	configLocation Specifies the location of the XML configuration to use.
protected boolean	consoleOutput Output errors to console.
private boolean	enableFilesSummary Specifies if the Files summary should be enabled or not.
private boolean	enableRSS Specifies if the RSS should be enabled or not.
private boolean	enableRulesSummary Specifies if the Rules summary should be enabled or not.
private boolean	enableSeveritySummary Specifies if the Severity summary should be enabled or not.
protected java.lang.String	encoding The file encoding to use when reading the source files.
protected java.lang.String	excludes Specifies the names filter of the source files to be excluded for Checkstyle.
protected boolean	failsOnError Specifies if the build should fail upon a violation.
protected java.lang.String	headerLocation Specifies the location of the License file (a.k.a.
protected boolean	includeResources Specifies whether to include the resource directories in the check.
protected java.lang.String	includes Specifies the names filter of the source files to be used for Checkstyle.
protected boolean	includeTestResources Specifies whether to include the test resource directories in the check.
protected boolean	includeTestSourceDirectory Include or not the test source directory/directories to be used for Checkstyle.
protected static java.lang.String	JAVA_FILES
private boolean	linkXRef Link the violation line numbers to the source xref.
protected org.codehaus.plexus.resource.ResourceManager	locator
private boolean	omitIgnoredModules Specifies whether modules with a configured severity of ignore should be omitted during Checkstyle invocation.
private java.io.File	outputFile Specifies the path and filename to save the Checkstyle output.
private java.lang.String	outputFileFormat Specifies the format of the output to be used when writing to the output file.
private org.apache.maven.plugin.descriptor.PluginDescriptor	plugin The Plugin Descriptor
static java.lang.String	PLUGIN_RESOURCES
protected java.lang.String	propertiesLocation Specifies the location of the properties file.
protected java.lang.String	propertyExpansion Allows for specifying raw property expansion information.
protected java.lang.String	resourceExcludes Specifies the names filter of the resource files to be excluded for Checkstyle.
protected java.lang.String	resourceIncludes Specifies the names filter of the resource files to be used for Checkstyle.
protected java.util.List<org.apache.maven.model.Resource>	resources Specifies the location of the resources to be used for Checkstyle.
protected org.apache.maven.doxia.tools.SiteTool	siteTool SiteTool.
protected boolean	skip Skip entire check.
private java.util.List<java.lang.String>	sourceDirectories Specifies the location of the source directories to be used for Checkstyle.
private java.io.File	sourceDirectory Deprecated. instead use sourceDirectories. For version 3.0.0, this parameter is only defined to break the build if you use it!
protected java.io.ByteArrayOutputStream	stringOutputStream
protected java.lang.String	suppressionsFileExpression The key to be used in the properties for the suppressions file.
protected java.lang.String	suppressionsLocation Specifies the location of the suppressions XML file to use.
protected java.util.List<org.apache.maven.model.Resource>	testResources Specifies the location of the test resources to be used for Checkstyle.
private java.util.List<java.lang.String>	testSourceDirectories Specifies the location of the test source directories to be used for Checkstyle.
private java.io.File	testSourceDirectory Deprecated. instead use testSourceDirectories. For version 3.0.0, this parameter is only defined to break the build if you use it!
private java.util.List<java.lang.String>	treeWalkerNames When using custom treeWalkers, specify their names here so the checks inside the treeWalker end up the the rule-summary.
private java.io.File	useFile If null, the Checkstyle plugin will display violations on stdout.
private java.io.File	xrefLocation Location of the Xrefs to link to.

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 and Description
AbstractCheckstyleReport()

Method Summary

Modifier and Type	Method and Description
private void	checkDeprecatedParameterUsage(java.lang.Object parameter, java.lang.String name, java.lang.String replacement)
private java.util.List<org.apache.maven.artifact.Artifact>	collectArtifacts(java.lang.String hint)
protected abstract CheckstyleExecutorRequest	createRequest() Create the Checkstyle executor request.
void	executeReport(java.util.Locale locale)
private void	generateMainReport(CheckstyleResults results, java.util.ResourceBundle bundle)
private void	generateReportStatics()
private static java.util.ResourceBundle	getBundle(java.util.Locale locale)
private java.util.List<org.apache.maven.artifact.Artifact>	getCheckstylePluginDependenciesAsArtifacts(java.util.Map<java.lang.String,org.apache.maven.model.Plugin> plugins, java.lang.String hint)
protected com.puppycrawl.tools.checkstyle.DefaultLogger	getConsoleListener() Creates and returns the console listener.
private java.lang.String	getCopyright()
java.lang.String	getDescription(java.util.Locale locale)
protected com.puppycrawl.tools.checkstyle.api.AuditListener	getListener() Creates and returns the report generation listener.
java.lang.String	getName(java.util.Locale locale)
private java.io.OutputStream	getOutputStream(java.io.File file)
protected java.util.List<java.io.File>	getSourceDirectories()
protected java.util.List<java.io.File>	getTestSourceDirectories()

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

canGenerateReport, closeReport, execute, generate, generate, generate, getCategoryName, getInputEncoding, getOutputDirectory, getOutputEncoding, getProject, 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

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

getOutputName

Field Detail

PLUGIN_RESOURCES

public static final java.lang.String PLUGIN_RESOURCES

See Also:

Constant Field Values

JAVA_FILES

protected static final java.lang.String JAVA_FILES

See Also:

Constant Field Values

cacheFile

@Parameter(defaultValue="${project.build.directory}/checkstyle-cachefile")
protected java.lang.String cacheFile

Specifies the cache file used to speed up Checkstyle on successive runs.

configLocation

@Parameter(property="checkstyle.config.location",
           defaultValue="sun_checks.xml")
protected java.lang.String configLocation

Specifies the location of the XML configuration to use.

Potential values are a filesystem path, a URL, or a classpath resource. This parameter expects that the contents of the location conform to the xml format (Checkstyle Checker module) configuration of rulesets.

This parameter is resolved as resource, URL, then file. If successfully resolved, the contents of the configuration is copied into the ${project.build.directory}/checkstyle-configuration.xml file before being passed to Checkstyle as a configuration.

There are 2 predefined rulesets included in Maven Checkstyle Plugin:

• sun_checks.xml: Sun Checks.
• google_checks.xml: Google Checks.

consoleOutput

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

Output errors to console.

encoding

@Parameter(property="encoding",
           defaultValue="${project.build.sourceEncoding}")
protected java.lang.String encoding

The file encoding to use when reading the source files. If the property project.build.sourceEncoding is not set, the platform default encoding is used. Note: This parameter always overrides the property charset from Checkstyle's TreeWalker module.

Since:

2.2

failsOnError

@Parameter(defaultValue="false")
protected boolean failsOnError

Specifies if the build should fail upon a violation.

headerLocation

@Parameter(property="checkstyle.header.file",
           defaultValue="LICENSE.txt")
protected java.lang.String headerLocation

Specifies the location of the License file (a.k.a. the header file) that can be used by Checkstyle to verify that source code has the correct license header.

You need to use ${checkstyle.header.file} in your Checkstyle xml configuration to reference the name of this header file.

For instance:

 <module name="RegexpHeader">
   <property name="headerFile" value="${checkstyle.header.file}"/>
 </module>
 

Since:

2.0-beta-2

skip

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

Skip entire check.

Since:

2.2

outputFile

@Parameter(property="checkstyle.output.file",
           defaultValue="${project.build.directory}/checkstyle-result.xml")
private java.io.File outputFile

Specifies the path and filename to save the Checkstyle output. The format of the output file is determined by the outputFileFormat parameter.

propertiesLocation

@Parameter(property="checkstyle.properties.location")
protected java.lang.String propertiesLocation

Specifies the location of the properties file.

This parameter is resolved as URL, File then resource. If successfully resolved, the contents of the properties location is copied into the ${project.build.directory}/checkstyle-checker.properties file before being passed to Checkstyle for loading.

The contents of the propertiesLocation will be made available to Checkstyle for specifying values for parameters within the xml configuration (specified in the configLocation parameter).

Since:

2.0-beta-2

propertyExpansion

@Parameter
protected java.lang.String propertyExpansion

Allows for specifying raw property expansion information.

resources

@Parameter(defaultValue="${project.resources}",
           readonly=true)
protected java.util.List<org.apache.maven.model.Resource> resources

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

Since:

2.10

testResources

@Parameter(defaultValue="${project.testResources}",
           readonly=true)
protected java.util.List<org.apache.maven.model.Resource> testResources

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

Since:

2.11

includes

@Parameter(property="checkstyle.includes",
           defaultValue="**\\/*.java",
           required=true)
protected java.lang.String includes

Specifies the names filter of the source files to be used for Checkstyle.

excludes

@Parameter(property="checkstyle.excludes")
protected java.lang.String excludes

Specifies the names filter of the source files to be excluded for Checkstyle.

resourceIncludes

@Parameter(property="checkstyle.resourceIncludes",
           defaultValue="**/*.properties",
           required=true)
protected java.lang.String resourceIncludes

Specifies the names filter of the resource files to be used for Checkstyle.

Since:

2.11

resourceExcludes

@Parameter(property="checkstyle.resourceExcludes")
protected java.lang.String resourceExcludes

Specifies the names filter of the resource files to be excluded for Checkstyle.

Since:

2.11

includeResources

@Parameter(property="checkstyle.includeResources",
           defaultValue="true",
           required=true)
protected boolean includeResources

Specifies whether to include the resource directories in the check.

Since:

2.11

includeTestResources

@Parameter(property="checkstyle.includeTestResources",
           defaultValue="true",
           required=true)
protected boolean includeTestResources

Specifies whether to include the test resource directories in the check.

Since:

2.11

sourceDirectory

@Deprecated
 @Parameter
private java.io.File sourceDirectory

Deprecated. instead use sourceDirectories. For version 3.0.0, this parameter is only defined to break the build if you use it!

Specifies the location of the source directory to be used for Checkstyle.

sourceDirectories

@Parameter
private java.util.List<java.lang.String> sourceDirectories

Specifies the location of the source directories to be used for Checkstyle. Default value is ${project.compileSourceRoots}.

Since:

2.13

testSourceDirectory

@Parameter
 @Deprecated
private java.io.File testSourceDirectory

Deprecated. instead use testSourceDirectories. For version 3.0.0, this parameter is only defined to break the build if you use it!

Specifies the location of the test source directory to be used for Checkstyle.

Since:

2.2

testSourceDirectories

@Parameter
private java.util.List<java.lang.String> testSourceDirectories

Specifies the location of the test source directories to be used for Checkstyle. Default value is ${project.testCompileSourceRoots}.

Since:

2.13

includeTestSourceDirectory

@Parameter(defaultValue="false")
protected boolean includeTestSourceDirectory

Include or not the test source directory/directories to be used for Checkstyle.

Since:

2.2

suppressionsFileExpression

@Parameter(property="checkstyle.suppression.expression",
           defaultValue="checkstyle.suppressions.file")
protected java.lang.String suppressionsFileExpression

The key to be used in the properties for the suppressions file.

Since:

2.1

suppressionsLocation

@Parameter(property="checkstyle.suppressions.location")
protected java.lang.String suppressionsLocation

Specifies the location of the suppressions XML file to use.

This parameter is resolved as resource, URL, then file. If successfully resolved, the contents of the suppressions XML is copied into the ${project.build.directory}/checkstyle-supressions.xml file before being passed to Checkstyle for loading.

See suppressionsFileExpression for the property that will be made available to your Checkstyle configuration.

Since:

2.0-beta-2

useFile

@Parameter
private java.io.File useFile

If null, the Checkstyle plugin will display violations on stdout. Otherwise, a text file will be created with the violations.

outputFileFormat

@Parameter(property="checkstyle.output.format",
           defaultValue="xml")
private java.lang.String outputFileFormat

Specifies the format of the output to be used when writing to the output file. Valid values are "plain" and "xml".

enableRulesSummary

@Parameter(property="checkstyle.enable.rules.summary",
           defaultValue="true")
private boolean enableRulesSummary

Specifies if the Rules summary should be enabled or not.

enableSeveritySummary

@Parameter(property="checkstyle.enable.severity.summary",
           defaultValue="true")
private boolean enableSeveritySummary

Specifies if the Severity summary should be enabled or not.

enableFilesSummary

@Parameter(property="checkstyle.enable.files.summary",
           defaultValue="true")
private boolean enableFilesSummary

Specifies if the Files summary should be enabled or not.

enableRSS

@Parameter(property="checkstyle.enable.rss",
           defaultValue="true")
private boolean enableRSS

Specifies if the RSS should be enabled or not.

siteTool

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

SiteTool.

Since:

2.2

plugin

@Parameter(defaultValue="${plugin}",
           readonly=true,
           required=true)
private org.apache.maven.plugin.descriptor.PluginDescriptor plugin

The Plugin Descriptor

linkXRef

@Parameter(property="linkXRef",
           defaultValue="true")
private boolean linkXRef

Link the violation line numbers to the source xref. Will link automatically if Maven JXR plugin is being used.

Since:

2.1

xrefLocation

@Parameter(defaultValue="${project.reporting.outputDirectory}/xref")
private java.io.File xrefLocation

Location of the Xrefs to link to.

treeWalkerNames

@Parameter
private java.util.List<java.lang.String> treeWalkerNames

When using custom treeWalkers, specify their names here so the checks inside the treeWalker end up the the rule-summary.

Since:

2.11

omitIgnoredModules

@Parameter(defaultValue="false")
private boolean omitIgnoredModules

Specifies whether modules with a configured severity of ignore should be omitted during Checkstyle invocation.

Since:

3.0.0

locator

@Component
protected org.codehaus.plexus.resource.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 java.io.ByteArrayOutputStream stringOutputStream

Constructor Detail

AbstractCheckstyleReport

public AbstractCheckstyleReport()

Method Detail

getName

public java.lang.String getName(java.util.Locale locale)

getDescription

public java.lang.String getDescription(java.util.Locale locale)

executeReport

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

Specified by:

executeReport in class org.apache.maven.reporting.AbstractMavenReport

Throws:

org.apache.maven.reporting.MavenReportException

checkDeprecatedParameterUsage

private void checkDeprecatedParameterUsage(java.lang.Object parameter,
                                           java.lang.String name,
                                           java.lang.String replacement)
                                    throws org.apache.maven.reporting.MavenReportException

Throws:

org.apache.maven.reporting.MavenReportException

createRequest

protected abstract CheckstyleExecutorRequest createRequest()
                                                    throws org.apache.maven.reporting.MavenReportException

Create the Checkstyle executor request.

Returns:

The executor request.

Throws:

org.apache.maven.reporting.MavenReportException - If something goes wrong during creation.

collectArtifacts

private java.util.List<org.apache.maven.artifact.Artifact> collectArtifacts(java.lang.String hint)

getCheckstylePluginDependenciesAsArtifacts

private java.util.List<org.apache.maven.artifact.Artifact> getCheckstylePluginDependenciesAsArtifacts(java.util.Map<java.lang.String,org.apache.maven.model.Plugin> plugins,
                                                                                                      java.lang.String hint)

getListener

protected com.puppycrawl.tools.checkstyle.api.AuditListener getListener()
                                                                 throws org.apache.maven.reporting.MavenReportException

Creates and returns the report generation listener.

Returns:

The audit listener.

Throws:

org.apache.maven.reporting.MavenReportException - If something goes wrong.

getOutputStream

private java.io.OutputStream getOutputStream(java.io.File file)
                                      throws org.apache.maven.reporting.MavenReportException

Throws:

org.apache.maven.reporting.MavenReportException

getConsoleListener

protected com.puppycrawl.tools.checkstyle.DefaultLogger getConsoleListener()
                                                                    throws org.apache.maven.reporting.MavenReportException

Creates and returns the console listener.

Returns:

The console listener.

Throws:

org.apache.maven.reporting.MavenReportException - If something goes wrong.

generateReportStatics

private void generateReportStatics()
                            throws org.apache.maven.reporting.MavenReportException

Throws:

org.apache.maven.reporting.MavenReportException

getCopyright

private java.lang.String getCopyright()

generateMainReport

private void generateMainReport(CheckstyleResults results,
                                java.util.ResourceBundle bundle)

getBundle

private static java.util.ResourceBundle getBundle(java.util.Locale locale)

getSourceDirectories

protected java.util.List<java.io.File> getSourceDirectories()

getTestSourceDirectories

protected java.util.List<java.io.File> getTestSourceDirectories()