Package org.apache.maven.plugins.checkstyle

Class AbstractCheckstyleReport

    • Field Detail

      • PLUGIN_RESOURCES

        public static final java.lang.String PLUGIN_RESOURCES
        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.

      • 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

      • 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<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<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

      • 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

      • locator

        @Component
protected org.codehaus.plexus.resource.ResourceManager locator

      • stringOutputStream

        protected java.io.ByteArrayOutputStream stringOutputStream

    • Constructor Detail

      • AbstractCheckstyleReport

        public AbstractCheckstyleReport()