Package rife.bld.extension

Class PmdOperation

java.lang.Object

rife.bld.operations.AbstractOperation<PmdOperation>

rife.bld.extension.PmdOperation

public class PmdOperation
extends AbstractOperation<PmdOperation>

Performs static code analysis with PMD.

Since:

1.0

Author:

Erik C. Thauvin

Constructor Summary

Constructors

Constructor	Description
PmdOperation()

Method Summary

Modifier and Type	Method	Description
PmdOperation	cache(File file)	Sets the location of the cache file for incremental analysis.
PmdOperation	cache(String cache)	Sets the location of the cache file for incremental analysis.
PmdOperation	cache(Path path)	Sets the location of the cache file for incremental analysis.
PmdOperation	collectFilesRecursively(boolean collectFilesRecursively)	When specified, any directory mentioned with inputPaths() will only be searched for files that are direct children.
List<LanguageVersion>	defaultLanguageVersions()	Returns the default language versions.
final PmdOperation	defaultLanguageVersions(Collection<LanguageVersion> languageVersions)	Sets the default language version to be used for all input files.
PmdOperation	defaultLanguageVersions(LanguageVersion... languageVersions)	Sets the default language version to be used for all input files.
PmdOperation	encoding(String encoding)	Specifies the character set encoding of the source code files.
PmdOperation	encoding(Charset encoding)	Specifies the character set encoding of the source code files.
List<Path>	excludes()	Returns the paths to exclude from the analysis.
PmdOperation	excludes(Path... paths)	Sets paths to exclude from the analysis.
final PmdOperation	excludes(Collection<Path> paths)	Sets paths to exclude from the analysis.
PmdOperation	excludesFiles(File... files)	Sets paths to exclude from the analysis.
final PmdOperation	excludesFiles(Collection<File> files)	Sets paths to exclude from the analysis.
PmdOperation	excludesStrings(String... excludes)	Sets paths to exclude from the analysis.
final PmdOperation	excludesStrings(Collection<String> excludes)	Sets paths to exclude from the analysis.
void	execute()	Performs the PMD code analysis operation.
PmdOperation	failOnError(boolean failOnError)	Sets whether the build will exit on recoverable errors.
PmdOperation	failOnViolation(boolean failOnViolation)	Sets whether the build will continue on violations.
PmdOperation	forceLanguageVersion(LanguageVersion languageVersion)	Forces a language to be used for all input files, irrespective of file names.
PmdOperation	fromProject(BaseProject project)	Configures a PMD operation from a BaseProject.
PmdOperation	ignoreFile(File file)	Sets the path to the file containing a list of files to ignore, one path per line.
PmdOperation	ignoreFile(String ignoreFile)	Sets the path to the file containing a list of files to ignore, one path per line.
PmdOperation	ignoreFile(Path path)	Sets the path to the file containing a list of files to ignore, one path per line.
PmdOperation	includeLineNumber(boolean includeLineNumber)	Enables or disables line number in source file URIs.
PmdOperation	incrementalAnalysis(boolean incrementalAnalysis)	Enables or disables incremental analysis.
List<Path>	inputPaths()	Returns paths to source files or directories containing source files to analyze.
PmdOperation	inputPaths(File... files)	Sets paths to source files or directories containing source files to analyze.
PmdOperation	inputPaths(String... inputPaths)	Sets paths to source files or directories containing source files to analyze.
PmdOperation	inputPaths(Path... paths)	Sets paths to source files or directories containing source files to analyze.
final PmdOperation	inputPaths(Collection<Path> paths)	Sets paths to source files or directories containing source files to analyze.
final PmdOperation	inputPathsFiles(Collection<File> files)	Sets paths to source files or directories containing source files to analyze.
PmdOperation	inputPathsStrings(Collection<String> inputPaths)	Sets paths to source files or directories containing source files to analyze.
PmdOperation	minimumPriority(RulePriority priority)	Sets the minimum priority threshold when loading Rules from RuleSets.
PmdAnalysisResults	performAnalysis(PMDConfiguration config)	Performs the PMD analysis with the given config.
String	prependAuxClasspath()	Returns the prepended classpath.
PmdOperation	prependAuxClasspath(String... classpaths)	Prepend the specified classpaths-like string to the current ClassLoader of the configuration.
List<Path>	relativizeRoots()	Returns paths to shorten paths that are output in the report.
PmdOperation	relativizeRoots(File... roots)	Adds several paths to shorten paths that are output in the report.
PmdOperation	relativizeRoots(String... roots)	Adds several paths to shorten paths that are output in the report.
PmdOperation	relativizeRoots(Path... roots)	Adds several paths to shorten paths that are output in the report.
final PmdOperation	relativizeRoots(Collection<Path> roots)	Adds several paths to shorten paths that are output in the report.
final PmdOperation	relativizeRootsFiles(Collection<File> roots)	Adds several paths to shorten paths that are output in the report.
final PmdOperation	relativizeRootsStrings(Collection<String> roots)	Adds several paths to shorten paths that are output in the report.
Path	reportFile()	Returns the path to the report file.
PmdOperation	reportFile(File file)	Sets the path to the report page.
PmdOperation	reportFile(String reportFile)	Sets the path to the report page.
PmdOperation	reportFile(Path path)	Sets the path to the report page.
PmdOperation	reportFormat(String format)	Sets the output format of the analysis report.
PmdOperation	reportProperties(Properties properties)	Sets the Report properties.
Set<String>	ruleSets()	Returns the rule set paths.
PmdOperation	ruleSets(String... ruleSets)	Sets rule set paths.
final PmdOperation	ruleSets(Collection<String> ruleSets)	Sets rule set paths.
final PmdOperation	ruleSets(JavaRules... ruleSets)	Sets rule set paths.
final PmdOperation	ruleSetsRules(Collection<JavaRules> ruleSets)	Sets rule set paths.
PmdOperation	showSuppressed(boolean showSuppressed)	Enables or disables adding the suppressed rule violations to the report.
PmdOperation	suppressedMarker(String marker)	Specifies the comment token that marks lines which should be ignored.
PmdOperation	threads(int threads)	Sets the number of threads to be used.
PmdOperation	uri(URI inputUri)	Sets the input URI to process for source code objects.

Methods inherited from class rife.bld.operations.AbstractOperation

executeOnce, executeOnce, silent, silent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PmdOperation

public PmdOperation()

Method Details

execute

public void execute()
             throws Exception

Performs the PMD code analysis operation.

Specified by:

execute in class AbstractOperation<PmdOperation>

Throws:

Exception - if the analysis fails to execute

ExitStatusException - if violations or errors occur and failOnViolation or failOnError is true

cache

public PmdOperation cache(@NonNull
 Path path)

Sets the location of the cache file for incremental analysis.

Parameters:

path - the cache file path

Returns:

this operation

Throws:

NullPointerException - if path is null

See Also:

• cache(File)
• cache(String)

cache

public PmdOperation cache(@NonNull
 File file)

Sets the location of the cache file for incremental analysis.

Parameters:

file - the cache file

Returns:

this operation

Throws:

NullPointerException - if file is null

See Also:

• cache(Path)
• cache(String)

cache

public PmdOperation cache(@NonNull
 String cache)

Sets the location of the cache file for incremental analysis.

Parameters:

cache - the cache file path

Returns:

this operation

Throws:

NullPointerException - if cache is null

IllegalArgumentException - if cache is empty

See Also:

• cache(Path)
• cache(File)

collectFilesRecursively

public PmdOperation collectFilesRecursively(boolean collectFilesRecursively)

When specified, any directory mentioned with inputPaths() will only be searched for files that are direct children. By default, subdirectories are recursively included.

Parameters:

collectFilesRecursively - whether to collect files recursively or not

Returns:

this operation

Since:

1.3.0

defaultLanguageVersions

public PmdOperation defaultLanguageVersions(@NonNull
 LanguageVersion... languageVersions)

Sets the default language version to be used for all input files.

Parameters:

languageVersions - one or more language versions

Returns:

this operation

Throws:

NullPointerException - if languageVersions is null

IllegalArgumentException - if languageVersions is empty, or contains null elements

See Also:

• defaultLanguageVersions(Collection)
• defaultLanguageVersions()

defaultLanguageVersions

public final PmdOperation defaultLanguageVersions(@NonNull
 Collection<LanguageVersion> languageVersions)

Sets the default language version to be used for all input files.

Parameters:

languageVersions - a collection of language versions

Returns:

this operation

Throws:

NullPointerException - if languageVersions is null

IllegalArgumentException - if languageVersions is empty, or contains null elements

See Also:

• defaultLanguageVersions(LanguageVersion...)
• defaultLanguageVersions()

defaultLanguageVersions

public List<LanguageVersion> defaultLanguageVersions()

Returns the default language versions.

Returns:

the language versions

See Also:

• defaultLanguageVersions(LanguageVersion...)
• defaultLanguageVersions(Collection)

encoding

public PmdOperation encoding(@NonNull
 String encoding)

Specifies the character set encoding of the source code files. The default is UTF-8.

The valid values are the standard character sets of Charset.

Parameters:

encoding - the encoding name

Returns:

this operation

Throws:

NullPointerException - if encoding is null

IllegalArgumentException - if encoding is empty

See Also:

• encoding(Charset)

encoding

public PmdOperation encoding(@NonNull
 Charset encoding)

Specifies the character set encoding of the source code files. The default is UTF-8.

The valid values are the standard character sets of Charset.

Parameters:

encoding - the charset

Returns:

this operation

Throws:

NullPointerException - if encoding is null

See Also:

• encoding(String)

excludes

public List<Path> excludes()

Returns the paths to exclude from the analysis.

Returns:

the exclude paths

See Also:

• excludes(Path...)
• excludes(Collection)

excludes

public PmdOperation excludes(@NonNull
 Path... paths)

Sets paths to exclude from the analysis.

Parameters:

paths - one or more paths to exclude

Returns:

this operation

Throws:

NullPointerException - if paths is null

IllegalArgumentException - if paths is empty, or contains null elements

See Also:

• excludes(Collection)
• excludes()

excludes

public final PmdOperation excludes(@NonNull
 Collection<Path> paths)

Sets paths to exclude from the analysis.

Parameters:

paths - paths to exclude

Returns:

this operation

Throws:

NullPointerException - if paths is null

IllegalArgumentException - if paths is empty, or contains null elements

See Also:

• excludes(Path...)
• excludes()

excludesFiles

public PmdOperation excludesFiles(@NonNull
 File... files)

Sets paths to exclude from the analysis.

Parameters:

files - one or more paths to exclude

Returns:

this operation

Throws:

NullPointerException - if files is null

IllegalArgumentException - if files is empty, or contains null elements

Since:

1.2

See Also:

• excludesFiles(Collection)
• excludes(Path...)

excludesFiles

public final PmdOperation excludesFiles(@NonNull
 Collection<File> files)

Sets paths to exclude from the analysis.

Parameters:

files - a collection of paths to exclude

Returns:

this operation

Throws:

NullPointerException - if files is null

IllegalArgumentException - if files is empty, or contains null elements

Since:

1.2

See Also:

• excludesFiles(File...)
• excludes(Path...)

excludesStrings

public PmdOperation excludesStrings(@NonNull
 String... excludes)

Sets paths to exclude from the analysis.

Parameters:

excludes - one or more paths to exclude

Returns:

this operation

Throws:

NullPointerException - if excludes is null

IllegalArgumentException - if excludes is empty, or contains null or empty elements

Since:

1.2

See Also:

• excludesStrings(Collection)
• excludes(Path...)

excludesStrings

public final PmdOperation excludesStrings(@NonNull
 Collection<String> excludes)

Sets paths to exclude from the analysis.

Parameters:

excludes - a collection of paths to exclude

Returns:

this operation

Throws:

NullPointerException - if excludes is null

IllegalArgumentException - if excludes is empty, or contains null or empty elements

Since:

1.2

See Also:

• excludesStrings(String...)
• excludes(Path...)

failOnError

public PmdOperation failOnError(boolean failOnError)

Sets whether the build will exit on recoverable errors.

Default is: true

Note: If only violations are found, see failOnViolation

Parameters:

failOnError - whether to exit and fail the build if recoverable errors occurred

Returns:

this operation

See Also:

• failOnViolation(boolean)

failOnViolation

public PmdOperation failOnViolation(boolean failOnViolation)

Sets whether the build will continue on violations.

Note: If additionally recoverable errors occurred, see failOnError

Parameters:

failOnViolation - whether to exit and fail the build if violations are found

Returns:

this operation

See Also:

• failOnError(boolean)

forceLanguageVersion

public PmdOperation forceLanguageVersion(@NonNull
 LanguageVersion languageVersion)

Forces a language to be used for all input files, irrespective of file names.

Parameters:

languageVersion - the language version

Returns:

this operation

Throws:

NullPointerException - if languageVersion is null

fromProject

public PmdOperation fromProject(@NonNull
 BaseProject project)

Configures a PMD operation from a BaseProject.

The defaults are:

• cache=build/pmd/pmd-cache, if not already set
• encoding=UTF-8
• incrementalAnalysis=true
• inputPaths=[src/main, src/test], if not already set
• reportFile=build/pmd/pmd-report.txt, if not already set
• reportFormat=text
• rulePriority=LOW
• ruleSets=JavaRules.QUICK_START, if not already set
• suppressedMarker=NOPMD
• threads=1

Parameters:

project - the project

Returns:

this operation

Throws:

NullPointerException - if project is null

ignoreFile

public PmdOperation ignoreFile(@NonNull
 Path path)

Sets the path to the file containing a list of files to ignore, one path per line.

Parameters:

path - the ignore file path

Returns:

this operation

Throws:

NullPointerException - if path is null

See Also:

• ignoreFile(File)
• ignoreFile(String)

ignoreFile

public PmdOperation ignoreFile(@NonNull
 File file)

Sets the path to the file containing a list of files to ignore, one path per line.

Parameters:

file - the ignore file

Returns:

this operation

Throws:

NullPointerException - if file is null

See Also:

• ignoreFile(Path)
• ignoreFile(String)

ignoreFile

public PmdOperation ignoreFile(@NonNull
 String ignoreFile)

Sets the path to the file containing a list of files to ignore, one path per line.

Parameters:

ignoreFile - the ignore file path

Returns:

this operation

Throws:

NullPointerException - if ignoreFile is null

IllegalArgumentException - if ignoreFile is empty

See Also:

• ignoreFile(Path)
• ignoreFile(File)

includeLineNumber

public PmdOperation includeLineNumber(boolean includeLineNumber)

Enables or disables line number in source file URIs.

While clicking on the URI works in IntelliJ IDEA, Visual Studio Code, etc.; it might not in terminal emulators.

Default: true

Parameters:

includeLineNumber - whether to include the line number in source file URIs

Returns:

this operation

incrementalAnalysis

public PmdOperation incrementalAnalysis(boolean incrementalAnalysis)

Enables or disables incremental analysis.

Parameters:

incrementalAnalysis - whether to enable incremental analysis

Returns:

this operation

inputPaths

public List<Path> inputPaths()

Returns paths to source files or directories containing source files to analyze.

Returns:

the input paths

See Also:

• inputPaths(Path...)
• inputPaths(Collection)

inputPaths

public PmdOperation inputPaths(@NonNull
 Path... paths)

Sets paths to source files or directories containing source files to analyze.

Parameters:

paths - one or more paths

Returns:

this operation

Throws:

NullPointerException - if paths is null

IllegalArgumentException - if paths is empty, or contains null elements

See Also:

• inputPaths(Collection)
• inputPaths()

inputPaths

public PmdOperation inputPaths(@NonNull
 File... files)

Sets paths to source files or directories containing source files to analyze.

Parameters:

files - one or more paths

Returns:

this operation

Throws:

NullPointerException - if files is null

IllegalArgumentException - if files is empty, or contains null elements

See Also:

• inputPathsFiles(Collection)
• inputPaths(Path...)
• inputPaths()

inputPaths

public PmdOperation inputPaths(@NonNull
 String... inputPaths)

Sets paths to source files or directories containing source files to analyze.

Parameters:

inputPaths - one or more paths

Returns:

this operation

Throws:

NullPointerException - if inputPaths is null

IllegalArgumentException - if inputPaths is empty, or contains null or empty elements

See Also:

• inputPathsStrings(Collection)
• inputPaths(Path...)
• inputPaths()

inputPaths

public final PmdOperation inputPaths(@NonNull
 Collection<Path> paths)

Sets paths to source files or directories containing source files to analyze.

Parameters:

paths - a collection of input paths

Returns:

this operation

Throws:

NullPointerException - if paths is null

IllegalArgumentException - if paths is empty, or contains null elements

See Also:

• inputPaths(Path...)
• inputPaths()

inputPathsFiles

public final PmdOperation inputPathsFiles(@NonNull
 Collection<File> files)

Sets paths to source files or directories containing source files to analyze.

Parameters:

files - a collection of input paths

Returns:

this operation

Throws:

NullPointerException - if files is null

IllegalArgumentException - if files is empty, or contains null elements

See Also:

• inputPaths(File...)
• inputPaths(Path...)
• inputPaths()

inputPathsStrings

public PmdOperation inputPathsStrings(@NonNull
 Collection<String> inputPaths)

Sets paths to source files or directories containing source files to analyze.

Parameters:

inputPaths - a collection of input paths

Returns:

this operation

Throws:

NullPointerException - if inputPaths is null

IllegalArgumentException - if inputPaths is empty, or contains null or empty elements

See Also:

• inputPaths(String...)
• inputPaths(Path...)
• inputPaths()

minimumPriority

public PmdOperation minimumPriority(@NonNull
 RulePriority priority)

Sets the minimum priority threshold when loading Rules from RuleSets.

Parameters:

priority - the minimum rule priority

Returns:

this operation

Throws:

NullPointerException - if priority is null

performAnalysis

public PmdAnalysisResults performAnalysis(@NonNull
 PMDConfiguration config)
                                   throws ExitStatusException

Performs the PMD analysis with the given config.

Parameters:

config - the configuration

Returns:

the analysis results

Throws:

NullPointerException - if config is null

ExitStatusException - if violations or errors occur and failOnViolation or failOnError is true

prependAuxClasspath

public PmdOperation prependAuxClasspath(@NonNull
 String... classpaths)

Prepend the specified classpaths-like string to the current ClassLoader of the configuration. If no ClassLoader is currently configured, the ClassLoader used to load the PMDConfiguration class will be used as the parent ClassLoader of the created ClassLoader.

If the classpaths String looks like a URL to a file (i.e., starts with file://) the file will be read with each line representing an entry on the classpaths.

Parameters:

classpaths - one or more classpaths entries

Returns:

this operation

Throws:

NullPointerException - if classpaths is null

IllegalArgumentException - if classpaths is empty, or contains null elements

See Also:

• prependAuxClasspath()

prependAuxClasspath

public String prependAuxClasspath()

Returns the prepended classpath.

Returns:

the classpath

See Also:

• prependAuxClasspath(String...)

relativizeRoots

public PmdOperation relativizeRoots(@NonNull
 Path... roots)

Adds several paths to shorten paths that are output in the report.

Parameters:

roots - one or more relative root paths

Returns:

this operation

Throws:

NullPointerException - if roots is null

IllegalArgumentException - if roots is empty, or contains null elements

See Also:

• relativizeRoots(Collection)
• relativizeRoots()

relativizeRoots

public PmdOperation relativizeRoots(@NonNull
 File... roots)

Adds several paths to shorten paths that are output in the report.

Parameters:

roots - one or more relative root paths

Returns:

this operation

Throws:

NullPointerException - if roots is null

IllegalArgumentException - if roots is empty, or contains null orvelements

See Also:

• relativizeRootsFiles(Collection)
• relativizeRoots(Path...)
• relativizeRoots()

relativizeRoots

public PmdOperation relativizeRoots(@NonNull
 String... roots)

Adds several paths to shorten paths that are output in the report.

Parameters:

roots - one or more relative root paths

Returns:

this operation

Throws:

NullPointerException - if roots is null

IllegalArgumentException - if roots is empty, or contains null or empty elements

See Also:

• relativizeRootsStrings(Collection)
• relativizeRoots(Path...)
• relativizeRoots()

relativizeRoots

public final PmdOperation relativizeRoots(@NonNull
 Collection<Path> roots)

Adds several paths to shorten paths that are output in the report.

Parameters:

roots - a collection of relative root paths

Returns:

this operation

Throws:

NullPointerException - if roots is null

IllegalArgumentException - if roots is empty, or contains null elements

See Also:

• relativizeRoots(Path...)
• relativizeRoots()

relativizeRoots

public List<Path> relativizeRoots()

Returns paths to shorten paths that are output in the report.

Returns:

the relative root paths

See Also:

• relativizeRoots(Path...)
• relativizeRoots(Collection)

relativizeRootsFiles

public final PmdOperation relativizeRootsFiles(@NonNull
 Collection<File> roots)

Adds several paths to shorten paths that are output in the report.

Parameters:

roots - a collection of relative root paths

Returns:

this operation

Throws:

NullPointerException - if roots is null

IllegalArgumentException - if roots is empty, or contains null elements

See Also:

• relativizeRoots(File...)
• relativizeRoots(Path...)
• relativizeRoots()

relativizeRootsStrings

public final PmdOperation relativizeRootsStrings(@NonNull
 Collection<String> roots)

Adds several paths to shorten paths that are output in the report.

Parameters:

roots - a collection of relative root paths

Returns:

this operation

Throws:

NullPointerException - if roots is null

IllegalArgumentException - if roots is empty, or contains null or empty elements

See Also:

• relativizeRoots(String...)
• relativizeRoots(Path...)
• relativizeRoots()

reportFile

public PmdOperation reportFile(@NonNull
 Path path)

Sets the path to the report page.

Parameters:

path - the report file path

Returns:

this operation

Throws:

NullPointerException - if path is null

See Also:

• reportFile(File)
• reportFile(String)
• reportFile()

reportFile

public PmdOperation reportFile(@NonNull
 File file)

Sets the path to the report page.

Parameters:

file - the report file

Returns:

this operation

Throws:

NullPointerException - if file is null

See Also:

• reportFile(Path)
• reportFile(String)
• reportFile()

reportFile

public PmdOperation reportFile(@NonNull
 String reportFile)

Sets the path to the report page.

Parameters:

reportFile - the report file path

Returns:

this operation

Throws:

NullPointerException - if reportFile is null

IllegalArgumentException - if reportFile is empty

See Also:

• reportFile(Path)
• reportFile(File)
• reportFile()

reportFile

public Path reportFile()

Returns the path to the report file.

Returns:

the report file path

See Also:

• reportFile(Path)
• reportFile(File)
• reportFile(String)

reportFormat

public PmdOperation reportFormat(@NonNull
 String format)

Sets the output format of the analysis report. The default is text.

Parameters:

format - the report format

Returns:

this operation

Throws:

NullPointerException - if format is null

IllegalArgumentException - if format is empty

reportProperties

public PmdOperation reportProperties(@NonNull
 Properties properties)

Sets the Report properties. These are used to create the Renderer.

Parameters:

properties - the report properties

Returns:

this operation

Throws:

NullPointerException - if properties is null

ruleSets

public Set<String> ruleSets()

Returns the rule set paths.

Returns:

the rule sets

See Also:

• ruleSets(String...)
• ruleSets(Collection)
• ruleSets(JavaRules...)
• ruleSetsRules(Collection)

ruleSets

public PmdOperation ruleSets(@NonNull
 String... ruleSets)

Sets rule set paths.

Parameters:

ruleSets - one or more rule set paths

Returns:

this operation

Throws:

NullPointerException - if ruleSets is null

IllegalArgumentException - if ruleSets is empty, or contains null or empty elements

See Also:

• ruleSets(Collection)
• ruleSets(JavaRules...)
• ruleSetsRules(Collection)
• ruleSets()

ruleSets

public final PmdOperation ruleSets(@NonNull
 Collection<String> ruleSets)

Sets rule set paths.

Parameters:

ruleSets - a collection of rule set paths

Returns:

this operation

Throws:

NullPointerException - if ruleSets is null

IllegalArgumentException - if ruleSets is empty, or contains null or empty elements

See Also:

• ruleSets(String...)
• ruleSets(JavaRules...)
• ruleSetsRules(Collection)
• ruleSets()

ruleSets

public final PmdOperation ruleSets(@NonNull
 JavaRules... ruleSets)

Sets rule set paths.

Parameters:

ruleSets - one or more rule sets

Returns:

this operation

Throws:

NullPointerException - if ruleSets is null

IllegalArgumentException - if ruleSets is empty, or contains null elements

Since:

1.5

See Also:

• ruleSets(String...)
• ruleSets(Collection)
• ruleSetsRules(Collection)
• ruleSets()

ruleSetsRules

public final PmdOperation ruleSetsRules(@NonNull
 Collection<JavaRules> ruleSets)

Sets rule set paths.

Parameters:

ruleSets - a collection of rule sets

Returns:

this operation

Throws:

NullPointerException - if ruleSets is null

IllegalArgumentException - if ruleSets is empty, or contains null elements

Since:

1.5

See Also:

• ruleSets(String...)
• ruleSets(Collection)
• ruleSets(JavaRules...)
• ruleSets()

showSuppressed

public PmdOperation showSuppressed(boolean showSuppressed)

Enables or disables adding the suppressed rule violations to the report.

Parameters:

showSuppressed - whether to add suppressed violations to the report

Returns:

this operation

suppressedMarker

public PmdOperation suppressedMarker(@NonNull
 String marker)

Specifies the comment token that marks lines which should be ignored. The default is NOPMD.

Parameters:

marker - the suppressed marker token

Returns:

this operation

Throws:

NullPointerException - if marker is null

IllegalArgumentException - if marker is empty

threads

public PmdOperation threads(int threads)

Sets the number of threads to be used. The default is 1.

Parameters:

threads - the number of threads

Returns:

this operation

uri

public PmdOperation uri(@NonNull
 URI inputUri)

Sets the input URI to process for source code objects.

Parameters:

inputUri - the input URI

Returns:

this operation

Throws:

NullPointerException - if inputUri is null