Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | PROPERTY | CONSTR | METHOD DETAIL: FIELD | PROPERTY | CONSTR | METHOD

org.ajoberstar.gradle.pmd
[Groovy] Class PMDConvention

java.lang.Object
  org.ajoberstar.gradle.pmd.PMDConvention

class PMDConvention
extends java.lang.Object

Convention specifying defaults for the PMD plugin.

Authors:
Andrew Oberstar
Version:
0.1.0
See Also:
PMDPlugin
Since:
0.1.0

Property Summary
java.lang.String reportsDirName

Location of the html report
java.lang.String resultsDirName

Location of the xml results
java.util.Set rulesets

Paths to ruleset files.
 
Constructor Summary
PMDConvention(org.gradle.api.Project project)

Creates a convention instance tied to the specified project.
 
Method Summary
java.io.File getReportsDir()

Gets the directory to be used for Findbugs reports.

java.io.File getResultsDir()

Gets the directory to be used for Findbugs results.

void rulesets(java.lang.String rulesets)

Adds a ruleset file path to the set.
 
Methods inherited from class java.lang.Object
java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()
 

Property Detail

reportsDirName

java.lang.String reportsDirName
Location of the html report

resultsDirName

java.lang.String resultsDirName
Location of the xml results

rulesets

java.util.Set rulesets
Paths to ruleset files.

 
Constructor Detail

PMDConvention

PMDConvention(org.gradle.api.Project project)
Creates a convention instance tied to the specified project. Defaults the resultsDirName and reportsDirName to "pmd"
Parameters:
project

 
Method Detail

getReportsDir

java.io.File getReportsDir()
Gets the directory to be used for Findbugs reports. This is determined using the resultsDirName property, evaluated relative to the project's build directory.
Returns:
the reports dir for Findbugs

getResultsDir

java.io.File getResultsDir()
Gets the directory to be used for Findbugs results. This is determined using the resultsDirName property, evaluated relative to the project's build directory.
Returns:
the results dir for Findbugs

rulesets

void rulesets(java.lang.String rulesets)
Adds a ruleset file path to the set.
Parameters:
rulesets - the ruleset path to add

 

Groovy Documentation