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

Field Summary

Fields

Modifier and Type	Field	Description
static final Logger	LOGGER	The default logger.

Constructor Summary

Constructors

Constructor	Description
PmdOperation()

Method Summary

Modifier and Type	Method	Description
PmdOperation	cache(File cache)	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 cache)	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>... languageVersion)	Sets the default language version to be used for all input files.
PmdOperation	defaultLanguageVersions(LanguageVersion... languageVersion)	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(boolean clear, Path... excludes)	Sets paths to exclude from the analysis.
final PmdOperation	excludes(boolean clear, Collection<Path>... excludes)	Sets paths to exclude from the analysis.
PmdOperation	excludes(Path... excludes)	Sets paths to exclude from the analysis, replacing any previous entries.
final PmdOperation	excludes(Collection<Path>... excludes)	Sets paths to exclude from the analysis, replacing any previous entries.
PmdOperation	excludesFiles(boolean clear, File... excludes)	Sets paths to exclude from the analysis.
final PmdOperation	excludesFiles(boolean clear, Collection<File>... excludes)	Sets paths to exclude from the analysis.
PmdOperation	excludesFiles(File... excludes)	Sets paths to exclude from the analysis, replacing any previous entries.
final PmdOperation	excludesFiles(Collection<File>... excludes)	Sets paths to exclude from the analysis, replacing any previous entries.
PmdOperation	excludesStrings(boolean clear, String... excludes)	Sets paths to exclude from the analysis.
final PmdOperation	excludesStrings(boolean clear, Collection<String>... excludes)	Sets paths to exclude from the analysis.
PmdOperation	excludesStrings(String... excludes)	Sets paths to exclude from the analysis, replacing any previous entries.
final PmdOperation	excludesStrings(Collection<String>... excludes)	Sets paths to exclude from the analysis, replacing any previous entries.
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 ignoreFile)	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 ignoreFile)	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.
PMDConfiguration	initConfiguration(String commandName)	Creates a new initialized configuration.
List<Path>	inputPaths()	Returns paths to source files or directories containing source files to analyze.
PmdOperation	inputPaths(boolean clear, File... inputPath)	Sets paths to source files or directories containing source files to analyze.
PmdOperation	inputPaths(boolean clear, String... inputPath)	Sets paths to source files or directories containing source files to analyze.
PmdOperation	inputPaths(boolean clear, Path... inputPath)	Sets paths to source files or directories containing source files to analyze.
final PmdOperation	inputPaths(boolean clear, Collection<Path>... inputPath)	Sets paths to source files or directories containing source files to analyze.
PmdOperation	inputPaths(File... inputPath)	Sets paths to source files or directories containing source files to analyze, replacing any previous entries.
PmdOperation	inputPaths(String... inputPath)	Sets paths to source files or directories containing source files to analyze, replacing any previous entries.
PmdOperation	inputPaths(Path... inputPath)	Sets paths to source files or directories containing source files to analyze, replacing any previous entries.
final PmdOperation	inputPaths(Collection<Path>... inputPath)	Sets paths to source files or directories containing source files to analyze, replacing any previous entries.
final PmdOperation	inputPathsFiles(boolean clear, Collection<File>... inputPath)	Sets paths to source files or directories containing source files to analyze.
final PmdOperation	inputPathsFiles(Collection<File>... inputPath)	Sets paths to source files or directories containing source files to analyze, replacing any previous entries.
PmdOperation	inputPathsStrings(boolean clear, Collection<String> inputPath)	Sets paths to source files or directories containing source files to analyze.
PmdOperation	inputPathsStrings(Collection<String> inputPath)	Sets paths to source files or directories containing source files to analyze, replacing any previous entries.
PmdOperation	minimumPriority(RulePriority priority)	Sets the minimum priority threshold when loading Rules from RuleSets.
PmdAnalysisResults	performPmdAnalysis(String commandName, PMDConfiguration config)	Performs the PMD analysis with the given config.
String	prependAuxClasspath()	Returns the prepended classpath.
PmdOperation	prependAuxClasspath(String... classpath)	Prepend the specified classpath-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... relativeRoot)	Adds several paths to shorten paths that are output in the report.
PmdOperation	relativizeRoots(String... relativeRoot)	Adds several paths to shorten paths that are output in the report.
PmdOperation	relativizeRoots(Path... relativeRoot)	Adds several paths to shorten paths that are output in the report.
final PmdOperation	relativizeRoots(Collection<Path>... relativeRoot)	Adds several paths to shorten paths that are output in the report.
final PmdOperation	relativizeRootsFiles(Collection<File>... relativeRoot)	Adds several paths to shorten paths that are output in the report.
final PmdOperation	relativizeRootsStrings(Collection<String>... relativeRoot)	Adds several paths to shorten paths that are output in the report.
Path	reportFile()	Returns the path to the report file.
PmdOperation	reportFile(File reportFile)	Sets the path to the report page.
PmdOperation	reportFile(String reportFile)	Sets the path to the report page.
PmdOperation	reportFile(Path reportFile)	Sets the path to the report page.
PmdOperation	reportFormat(String reportFormat)	Sets the output format of the analysis report.
PmdOperation	reportProperties(Properties reportProperties)	Sets the Report properties.
Set<String>	ruleSets()	Returns the rule set paths.
PmdOperation	ruleSets(boolean clear, String... ruleSet)	Sets rule set paths.
final PmdOperation	ruleSets(boolean clear, Collection<String>... ruleSet)	Sets rule set paths.
final PmdOperation	ruleSets(boolean clear, JavaRules... ruleSet)	Sets rule set paths.
PmdOperation	ruleSets(String... ruleSet)	Sets new rule set paths, replacing any previous entries.
final PmdOperation	ruleSets(Collection<String>... ruleSet)	Sets new rule set paths, replacing any previous entries.
final PmdOperation	ruleSets(JavaRules... ruleSet)	Sets new rule set paths, replacing any previous entries.
final PmdOperation	ruleSetsRules(boolean clear, Collection<JavaRules>... ruleSet)	Sets rule set paths.
final PmdOperation	ruleSetsRules(Collection<JavaRules>... ruleSet)	Sets new rule set paths, replacing any previous entries.
PmdOperation	showSuppressed(boolean showSuppressed)	Enables or disables adding the suppressed rule violations to the report.
PmdOperation	suppressedMarker(String suppressedMarker)	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

Field Details

LOGGER

public static final Logger LOGGER

The default logger.

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

cache

public PmdOperation cache(Path cache)

Sets the location of the cache file for incremental analysis.

Parameters:

cache - the cache file path

Returns:

this operation

Since:

1.0

See Also:

• cache(File)
• cache(String)

cache

public PmdOperation cache(File cache)

Sets the location of the cache file for incremental analysis.

Parameters:

cache - the cache file

Returns:

this operation

Since:

1.0

See Also:

• cache(Path)
• cache(String)

cache

public PmdOperation cache(String cache)

Sets the location of the cache file for incremental analysis.

Parameters:

cache - the cache file path

Returns:

this operation

Since:

1.0

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(LanguageVersion... languageVersion)

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

Parameters:

languageVersion - one or more language versions

Returns:

this operation

Since:

1.0

See Also:

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

defaultLanguageVersions

@SafeVarargs
public final PmdOperation defaultLanguageVersions(Collection<LanguageVersion>... languageVersion)

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

Parameters:

languageVersion - a collection of language versions

Returns:

this operation

Since:

1.0

See Also:

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

defaultLanguageVersions

public List<LanguageVersion> defaultLanguageVersions()

Returns the default language versions.

Returns:

the language versions

Since:

1.0

See Also:

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

encoding

public PmdOperation encoding(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

Since:

1.0

See Also:

• encoding(Charset)

encoding

public PmdOperation encoding(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

Since:

1.0

See Also:

• encoding(String)

excludes

public PmdOperation excludes(Path... excludes)

Sets paths to exclude from the analysis, replacing any previous entries.

Parameters:

excludes - one or more paths to exclude

Returns:

this operation

Since:

1.0

See Also:

• excludes(boolean, Path...)
• excludes(Collection...)
• excludes()

excludes

@SafeVarargs
public final PmdOperation excludes(Collection<Path>... excludes)

Sets paths to exclude from the analysis, replacing any previous entries.

Parameters:

excludes - paths to exclude

Returns:

this operation

Since:

1.0

See Also:

• excludes(boolean, Collection...)
• excludes(Path...)
• excludes()

excludes

public List<Path> excludes()

Returns the paths to exclude from the analysis.

Returns:

the exclude paths

Since:

1.0

See Also:

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

excludes

public PmdOperation excludes(boolean clear,
 Path... excludes)

Sets paths to exclude from the analysis.

Parameters:

clear - whether to clear existing entries before adding the new ones

excludes - one or more paths to exclude

Returns:

this operation

Since:

1.5.0

See Also:

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

excludes

@SafeVarargs
public final PmdOperation excludes(boolean clear,
 Collection<Path>... excludes)

Sets paths to exclude from the analysis.

Parameters:

clear - whether to clear existing entries before adding the new ones

excludes - paths to exclude

Returns:

this operation

Since:

1.5.0

See Also:

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

excludesFiles

@SafeVarargs
public final PmdOperation excludesFiles(Collection<File>... excludes)

Sets paths to exclude from the analysis, replacing any previous entries.

Parameters:

excludes - a collection of paths to exclude

Returns:

this operation

Since:

1.2.0

See Also:

• excludesFiles(boolean, Collection...)
• excludesFiles(File...)
• excludes(Path...)

excludesFiles

public PmdOperation excludesFiles(File... excludes)

Sets paths to exclude from the analysis, replacing any previous entries.

Parameters:

excludes - one or more paths to exclude

Returns:

this operation

Since:

1.2.0

See Also:

• excludesFiles(boolean, File...)
• excludesFiles(Collection...)
• excludes(Path...)

excludesFiles

public PmdOperation excludesFiles(boolean clear,
 File... excludes)

Sets paths to exclude from the analysis.

Parameters:

clear - whether to clear existing entries before adding the new ones

excludes - one or more paths to exclude

Returns:

this operation

Since:

1.5.0

See Also:

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

excludesFiles

@SafeVarargs
public final PmdOperation excludesFiles(boolean clear,
 Collection<File>... excludes)

Sets paths to exclude from the analysis.

Parameters:

clear - whether to clear existing entries before adding the new ones

excludes - a collection of paths to exclude

Returns:

this operation

Since:

1.5.0

See Also:

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

excludesStrings

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

Sets paths to exclude from the analysis, replacing any previous entries.

Parameters:

excludes - a collection of paths to exclude

Returns:

this operation

Since:

1.2.0

See Also:

• excludesStrings(boolean, Collection...)
• excludesStrings(String...)
• excludes(Path...)

excludesStrings

public PmdOperation excludesStrings(String... excludes)

Sets paths to exclude from the analysis, replacing any previous entries.

Parameters:

excludes - one or more paths to exclude

Returns:

this operation

Since:

1.2.0

See Also:

• excludesStrings(boolean, String...)
• excludesStrings(Collection...)
• excludes(Path...)

excludesStrings

public PmdOperation excludesStrings(boolean clear,
 String... excludes)

Sets paths to exclude from the analysis.

Parameters:

clear - whether to clear existing entries before adding the new ones

excludes - one or more paths to exclude

Returns:

this operation

Since:

1.5.0

See Also:

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

excludesStrings

@SafeVarargs
public final PmdOperation excludesStrings(boolean clear,
 Collection<String>... excludes)

Sets paths to exclude from the analysis.

Parameters:

clear - whether to clear existing entries before adding the new ones

excludes - a collection of paths to exclude

Returns:

this operation

Since:

1.5.0

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

Since:

1.0

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

Since:

1.0

See Also:

• failOnError(boolean)

forceLanguageVersion

public PmdOperation forceLanguageVersion(LanguageVersion languageVersion)

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

Parameters:

languageVersion - the language version

Returns:

this operation

Since:

1.0

fromProject

public PmdOperation fromProject(BaseProject project)

Configures a PMD operation from a BaseProject.

The defaults are:

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

Parameters:

project - the project

Returns:

this operation

Since:

1.0

ignoreFile

public PmdOperation ignoreFile(Path 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

Since:

1.0

See Also:

• ignoreFile(File)
• ignoreFile(String)

ignoreFile

public PmdOperation ignoreFile(File ignoreFile)

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

Parameters:

ignoreFile - the ignore file

Returns:

this operation

Since:

1.0

See Also:

• ignoreFile(Path)
• ignoreFile(String)

ignoreFile

public PmdOperation ignoreFile(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

Since:

1.0

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

Since:

1.0

incrementalAnalysis

public PmdOperation incrementalAnalysis(boolean incrementalAnalysis)

Enables or disables incremental analysis.

Parameters:

incrementalAnalysis - whether to enable incremental analysis

Returns:

this operation

Since:

1.0

initConfiguration

public PMDConfiguration initConfiguration(String commandName)

Creates a new initialized configuration.

Parameters:

commandName - the command name

Returns:

a fully configured PMDConfiguration

Since:

1.0

inputPaths

public PmdOperation inputPaths(Path... inputPath)

Sets paths to source files or directories containing source files to analyze, replacing any previous entries.

Parameters:

inputPath - one or more paths

Returns:

this operation

Since:

1.0

See Also:

• inputPaths(boolean, Path...)
• inputPaths(Collection...)
• inputPaths()

inputPaths

public PmdOperation inputPaths(File... inputPath)

Sets paths to source files or directories containing source files to analyze, replacing any previous entries.

Parameters:

inputPath - one or more paths

Returns:

this operation

Since:

1.0

See Also:

• inputPaths(boolean, File...)
• inputPathsFiles(Collection...)
• inputPaths(Path...)
• inputPaths()

inputPaths

public PmdOperation inputPaths(String... inputPath)

Sets paths to source files or directories containing source files to analyze, replacing any previous entries.

Parameters:

inputPath - one or more paths

Returns:

this operation

Since:

1.0

See Also:

• inputPaths(boolean, String...)
• inputPathsStrings(Collection)
• inputPaths(Path...)
• inputPaths()

inputPaths

@SafeVarargs
public final PmdOperation inputPaths(Collection<Path>... inputPath)

Sets paths to source files or directories containing source files to analyze, replacing any previous entries.

Parameters:

inputPath - a collection of input paths

Returns:

this operation

Since:

1.0

See Also:

• inputPaths(boolean, Collection...)
• inputPaths(Path...)
• inputPaths()

inputPaths

public List<Path> inputPaths()

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

Returns:

the input paths

Since:

1.0

See Also:

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

inputPaths

public PmdOperation inputPaths(boolean clear,
 Path... inputPath)

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

Parameters:

clear - whether to clear existing entries before adding the new ones

inputPath - one or more paths

Returns:

this operation

Since:

1.5.0

See Also:

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

inputPaths

public PmdOperation inputPaths(boolean clear,
 File... inputPath)

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

Parameters:

clear - whether to clear existing entries before adding the new ones

inputPath - one or more paths

Returns:

this operation

Since:

1.5.0

See Also:

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

inputPaths

public PmdOperation inputPaths(boolean clear,
 String... inputPath)

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

Parameters:

clear - whether to clear existing entries before adding the new ones

inputPath - one or more paths

Returns:

this operation

Since:

1.5.0

See Also:

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

inputPaths

@SafeVarargs
public final PmdOperation inputPaths(boolean clear,
 Collection<Path>... inputPath)

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

Parameters:

clear - whether to clear existing entries before adding the new ones

inputPath - a collection of input paths

Returns:

this operation

Since:

1.5.0

See Also:

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

inputPathsFiles

@SafeVarargs
public final PmdOperation inputPathsFiles(Collection<File>... inputPath)

Sets paths to source files or directories containing source files to analyze, replacing any previous entries.

Parameters:

inputPath - a collection of input paths

Returns:

this operation

Since:

1.0

See Also:

• inputPathsFiles(boolean, Collection...)
• inputPaths(File...)
• inputPaths(Path...)
• inputPaths()

inputPathsFiles

@SafeVarargs
public final PmdOperation inputPathsFiles(boolean clear,
 Collection<File>... inputPath)

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

Parameters:

clear - whether to clear existing entries before adding the new ones

inputPath - a collection of input paths

Returns:

this operation

Since:

1.5.0

See Also:

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

inputPathsStrings

public PmdOperation inputPathsStrings(Collection<String> inputPath)

Sets paths to source files or directories containing source files to analyze, replacing any previous entries.

Parameters:

inputPath - a collection of input paths

Returns:

this operation

Since:

1.0

See Also:

• inputPathsStrings(boolean, Collection)
• inputPaths(String...)
• inputPaths(Path...)
• inputPaths()

inputPathsStrings

public PmdOperation inputPathsStrings(boolean clear,
 Collection<String> inputPath)

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

Parameters:

clear - whether to clear existing entries before adding the new ones

inputPath - a collection of input paths

Returns:

this operation

Since:

1.5.0

See Also:

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

minimumPriority

public PmdOperation minimumPriority(RulePriority priority)

Sets the minimum priority threshold when loading Rules from RuleSets.

Parameters:

priority - the minimum rule priority

Returns:

this operation

Since:

1.0

performPmdAnalysis

public PmdAnalysisResults performPmdAnalysis(String commandName,
 PMDConfiguration config)
                                      throws ExitStatusException

Performs the PMD analysis with the given config.

Parameters:

commandName - the command name

config - the configuration

Returns:

the analysis results

Throws:

ExitStatusException - if an error occurs

Since:

1.0

prependAuxClasspath

public PmdOperation prependAuxClasspath(String... classpath)

Prepend the specified classpath-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 classpath 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 classpath.

Parameters:

classpath - one or more classpath entries

Returns:

this operation

Since:

1.0

See Also:

• prependAuxClasspath()

prependAuxClasspath

public String prependAuxClasspath()

Returns the prepended classpath.

Returns:

the classpath

Since:

1.0

See Also:

• prependAuxClasspath(String...)

relativizeRoots

public PmdOperation relativizeRoots(Path... relativeRoot)

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

Parameters:

relativeRoot - one or more relative root paths

Returns:

this operation

Since:

1.0

See Also:

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

relativizeRoots

public PmdOperation relativizeRoots(File... relativeRoot)

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

Parameters:

relativeRoot - one or more relative root paths

Returns:

this operation

Since:

1.0

See Also:

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

relativizeRoots

public PmdOperation relativizeRoots(String... relativeRoot)

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

Parameters:

relativeRoot - one or more relative root paths

Returns:

this operation

Since:

1.0

See Also:

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

relativizeRoots

@SafeVarargs
public final PmdOperation relativizeRoots(Collection<Path>... relativeRoot)

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

Parameters:

relativeRoot - a collection of relative root paths

Returns:

this operation

Since:

1.0

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

Since:

1.0

See Also:

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

relativizeRootsFiles

@SafeVarargs
public final PmdOperation relativizeRootsFiles(Collection<File>... relativeRoot)

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

Parameters:

relativeRoot - a collection of relative root paths

Returns:

this operation

Since:

1.0

See Also:

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

relativizeRootsStrings

@SafeVarargs
public final PmdOperation relativizeRootsStrings(Collection<String>... relativeRoot)

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

Parameters:

relativeRoot - a collection of relative root paths

Returns:

this operation

Since:

1.0

See Also:

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

reportFile

public PmdOperation reportFile(Path reportFile)

Sets the path to the report page.

Parameters:

reportFile - the report file path

Returns:

this operation

Since:

1.0

See Also:

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

reportFile

public PmdOperation reportFile(File reportFile)

Sets the path to the report page.

Parameters:

reportFile - the report file

Returns:

this operation

Since:

1.0

See Also:

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

reportFile

public PmdOperation reportFile(String reportFile)

Sets the path to the report page.

Parameters:

reportFile - the report file path

Returns:

this operation

Since:

1.0

See Also:

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

reportFile

public Path reportFile()

Returns the path to the report file.

Returns:

the report file path

Since:

1.0

See Also:

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

reportFormat

public PmdOperation reportFormat(String reportFormat)

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

Parameters:

reportFormat - the report format

Returns:

this operation

Since:

1.0

reportProperties

public PmdOperation reportProperties(Properties reportProperties)

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

Parameters:

reportProperties - the report properties

Returns:

this operation

Since:

1.0

ruleSets

public PmdOperation ruleSets(String... ruleSet)

Sets new rule set paths, replacing any previous entries.

Parameters:

ruleSet - one or more rule set paths

Returns:

this operation

Since:

1.0

See Also:

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

ruleSets

@SafeVarargs
public final PmdOperation ruleSets(Collection<String>... ruleSet)

Sets new rule set paths, replacing any previous entries.

Parameters:

ruleSet - one or more rule set paths

Returns:

this operation

Since:

1.0

See Also:

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

ruleSets

public final PmdOperation ruleSets(JavaRules... ruleSet)

Sets new rule set paths, replacing any previous entries.

Parameters:

ruleSet - a collection of rule set paths

Returns:

this operation

Since:

1.5.0

See Also:

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

ruleSets

public Set<String> ruleSets()

Returns the rule set paths.

Returns:

the rule sets

Since:

1.0

See Also:

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

ruleSets

public PmdOperation ruleSets(boolean clear,
 String... ruleSet)

Sets rule set paths.

Parameters:

clear - whether to clear existing entries before adding the new ones

ruleSet - one or more rule set paths

Returns:

this operation

Since:

1.5.0

See Also:

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

ruleSets

@SafeVarargs
public final PmdOperation ruleSets(boolean clear,
 Collection<String>... ruleSet)

Sets rule set paths.

Parameters:

clear - whether to clear existing entries before adding the new ones

ruleSet - one or more rule set paths

Returns:

this operation

Since:

1.5.0

See Also:

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

ruleSets

public final PmdOperation ruleSets(boolean clear,
 JavaRules... ruleSet)

Sets rule set paths.

Parameters:

clear - whether to clear existing entries before adding the new ones

ruleSet - a collection of rule set paths

Returns:

this operation

Since:

1.5.0

See Also:

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

ruleSetsRules

@SafeVarargs
public final PmdOperation ruleSetsRules(Collection<JavaRules>... ruleSet)

Sets new rule set paths, replacing any previous entries.

Parameters:

ruleSet - a collection of rule set paths

Returns:

this operation

Since:

1.5.0

See Also:

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

ruleSetsRules

@SafeVarargs
public final PmdOperation ruleSetsRules(boolean clear,
 Collection<JavaRules>... ruleSet)

Sets rule set paths.

Parameters:

clear - whether to clear existing entries before adding the new ones

ruleSet - a collection of rule set paths

Returns:

this operation

Since:

1.5.0

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

Since:

1.0

suppressedMarker

public PmdOperation suppressedMarker(String suppressedMarker)

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

Parameters:

suppressedMarker - the suppressed marker token

Returns:

this operation

Since:

1.0

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

Since:

1.0

uri

public PmdOperation uri(URI inputUri)

Sets the input URI to process for source code objects.

Parameters:

inputUri - the input URI

Returns:

this operation

Since:

1.0