Package net.sourceforge.pmd

Class PMDConfiguration

java.lang.Object

net.sourceforge.pmd.AbstractConfiguration

net.sourceforge.pmd.PMDConfiguration

public class PMDConfiguration
extends AbstractConfiguration

This class contains the details for the runtime configuration of PMD. There are several aspects to the configuration of PMD.

The aspects related to generic PMD behavior:

• Suppress marker is used in source files to suppress a RuleViolation, defaults to PMD.SUPPRESS_MARKER. getSuppressMarker()
• The number of threads to create when invoking on multiple files, defaults one thread per available processor. getThreads()
• A ClassLoader to use when loading classes during Rule processing (e.g. during type resolution), defaults to ClassLoader of the Configuration class. getClassLoader()
• A means to configure a ClassLoader using a prepended classpath String, instead of directly setting it programmatically. prependClasspath(String)
• A LanguageVersionDiscoverer instance, which defaults to using the default LanguageVersion of each Language. Means are provided to change the LanguageVersion for each Language. getLanguageVersionDiscoverer()

The aspects related to Rules and Source files are:

• A comma separated list of RuleSets URIs. getRuleSets()
• A minimum priority threshold when loading Rules from RuleSets, defaults to RulePriority.LOW. getMinimumPriority()
• The character encoding of source files, defaults to the system default as returned by System.getProperty("file.encoding"). AbstractConfiguration.getSourceEncoding()
• A comma separated list of input paths to process for source files. This may include files, directories, archives (e.g. ZIP files), etc. getInputPaths()
• A flag which controls, whether RuleSetFactoryCompatibility filter should be used or not: #isRuleSetFactoryCompatibilityEnabled;

• The renderer format to use for Reports. getReportFormat()
• The file to which the Report should render. getReportFile()
• An indicator of whether to use File short names in Reports, defaults to false. isReportShortNames()
• The initialization properties to use when creating a Renderer instance. getReportProperties()
• An indicator of whether to show suppressed Rule violations in Reports. isShowSuppressedViolations()

The aspects related to special PMD behavior are:

• An indicator of whether PMD should log debug information. AbstractConfiguration.isDebug()
• An indicator of whether PMD should perform stress testing behaviors, such as randomizing the order of file processing. isStressTest()
• An indicator of whether PMD should log benchmarking information. isBenchmark()

Constructor Summary

Constructors

Constructor	Description
PMDConfiguration()

Method Summary

Modifier and Type	Method	Description
Renderer	createRenderer()	Create a Renderer instance based upon the configured reporting options.
Renderer	createRenderer(boolean withReportWriter)	Create a Renderer instance based upon the configured reporting options.
AnalysisCache	getAnalysisCache()	Retrieves the currently used analysis cache.
java.lang.ClassLoader	getClassLoader()	Get the ClassLoader being used by PMD when processing Rules.
java.lang.String	getInputFilePath()
java.lang.String	getInputPaths()	Get the comma separated list of input paths to process for source files.
java.lang.String	getInputUri()	Get the input URI to process for source code objects.
LanguageVersionDiscoverer	getLanguageVersionDiscoverer()	Get the LanguageVersionDiscoverer, used to determine the LanguageVersion of a source file.
LanguageVersion	getLanguageVersionOfFile(java.lang.String fileName)	Get the LanguageVersion of the source file with given name.
RulePriority	getMinimumPriority()	Get the minimum priority threshold when loading Rules from RuleSets.
java.lang.String	getReportFile()	Get the file to which the report should render.
java.lang.String	getReportFormat()	Get the report format.
java.util.Properties	getReportProperties()	Get the Report properties.
java.lang.String	getRuleSets()	Get the comma separated list of RuleSet URIs.
java.lang.String	getSuppressMarker()	Get the suppress marker.
int	getThreads()	Get the number of threads to use when processing Rules.
boolean	isBenchmark()	Return the benchmark indicator.
boolean	isFailOnViolation()	Whether PMD should exit with status 4 (the default behavior, true) if violations are found or just with 0 (to not break the build, e.g.).
boolean	isReportShortNames()	Get whether to use File short names in Reports.
boolean	isRuleSetFactoryCompatibilityEnabled()	Checks if the rule set factory compatibility feature is enabled.
boolean	isShowSuppressedViolations()	Get whether the report should show suppressed violations.
boolean	isStressTest()	Return the stress test indicator.
void	prependClasspath(java.lang.String classpath)	Prepend the specified classpath like string to the current ClassLoader of the configuration.
void	setAnalysisCache(AnalysisCache cache)	Sets the analysis cache to be used.
void	setAnalysisCacheLocation(java.lang.String cacheLocation)	Sets the location of the analysis cache to be used.
void	setBenchmark(boolean benchmark)	Set the benchmark indicator.
void	setClassLoader(java.lang.ClassLoader classLoader)	Set the ClassLoader being used by PMD when processing Rules.
void	setDefaultLanguageVersion(LanguageVersion languageVersion)	Set the given LanguageVersion as the current default for it's Language.
void	setDefaultLanguageVersions(java.util.List<LanguageVersion> languageVersions)	Set the given LanguageVersions as the current default for their Languages.
void	setFailOnViolation(boolean failOnViolation)	Sets whether PMD should exit with status 4 (the default behavior, true) if violations are found or just with 0 (to not break the build, e.g.).
void	setInputFilePath(java.lang.String inputFilePath)	The input file path points to a single file, which contains a comma-separated list of source file names to process.
void	setInputPaths(java.lang.String inputPaths)	Set the comma separated list of input paths to process for source files.
void	setInputUri(java.lang.String inputUri)	Set the input URI to process for source code objects.
void	setMinimumPriority(RulePriority minimumPriority)	Set the minimum priority threshold when loading Rules from RuleSets.
void	setReportFile(java.lang.String reportFile)	Set the file to which the report should render.
void	setReportFormat(java.lang.String reportFormat)	Set the report format.
void	setReportProperties(java.util.Properties reportProperties)	Set the Report properties.
void	setReportShortNames(boolean reportShortNames)	Set whether to use File short names in Reports.
void	setRuleSetFactoryCompatibilityEnabled(boolean ruleSetFactoryCompatibilityEnabled)	Sets the rule set factory compatibility feature enabled/disabled.
void	setRuleSets(java.lang.String ruleSets)	Set the comma separated list of RuleSet URIs.
void	setShowSuppressedViolations(boolean showSuppressedViolations)	Set whether the report should show suppressed violations.
void	setStressTest(boolean stressTest)	Set the stress test indicator.
void	setSuppressMarker(java.lang.String suppressMarker)	Set the suppress marker.
void	setThreads(int threads)	Set the number of threads to use when processing Rules.

Methods inherited from class net.sourceforge.pmd.AbstractConfiguration

getSourceEncoding, isDebug, setDebug, setSourceEncoding

Methods inherited from class java.lang.Object

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

Constructor Detail

PMDConfiguration

public PMDConfiguration()

Method Detail

getSuppressMarker

public java.lang.String getSuppressMarker()

Get the suppress marker. This is the source level marker used to indicate a RuleViolation should be suppressed.

Returns:

The suppress marker.

setSuppressMarker

public void setSuppressMarker(java.lang.String suppressMarker)

Set the suppress marker.

Parameters:

suppressMarker - The suppress marker to use.

getThreads

public int getThreads()

Get the number of threads to use when processing Rules.

Returns:

The number of threads.

setThreads

public void setThreads(int threads)

Set the number of threads to use when processing Rules.

Parameters:

threads - The number of threads.

getClassLoader

public java.lang.ClassLoader getClassLoader()

Get the ClassLoader being used by PMD when processing Rules.

Returns:

The ClassLoader being used

setClassLoader

public void setClassLoader(java.lang.ClassLoader classLoader)

Set the ClassLoader being used by PMD when processing Rules. Setting a value of null will cause the default ClassLoader to be used.

Parameters:

classLoader - The ClassLoader to use

prependClasspath

public void prependClasspath(java.lang.String classpath)
                      throws java.io.IOException

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 - The prepended classpath.

Throws:

java.io.IOException - if the given classpath is invalid (e.g. does not exist)

See Also:

setClassLoader(ClassLoader), ClasspathClassLoader

getLanguageVersionDiscoverer

public LanguageVersionDiscoverer getLanguageVersionDiscoverer()

Get the LanguageVersionDiscoverer, used to determine the LanguageVersion of a source file.

Returns:

The LanguageVersionDiscoverer.

setDefaultLanguageVersion

public void setDefaultLanguageVersion(LanguageVersion languageVersion)

Set the given LanguageVersion as the current default for it's Language.

Parameters:

languageVersion - the LanguageVersion

setDefaultLanguageVersions

public void setDefaultLanguageVersions(java.util.List<LanguageVersion> languageVersions)

Set the given LanguageVersions as the current default for their Languages.

Parameters:

languageVersions - The LanguageVersions.

getLanguageVersionOfFile

public LanguageVersion getLanguageVersionOfFile(java.lang.String fileName)

Get the LanguageVersion of the source file with given name. This depends on the fileName extension, and the java version.

For compatibility with older code that does not always pass in a correct filename, unrecognized files are assumed to be java files.

Parameters:

fileName - Name of the file, can be absolute, or simple.

Returns:

the LanguageVersion

getRuleSets

public java.lang.String getRuleSets()

Get the comma separated list of RuleSet URIs.

Returns:

The RuleSet URIs.

setRuleSets

public void setRuleSets(java.lang.String ruleSets)

Set the comma separated list of RuleSet URIs.

Parameters:

ruleSets - the rulesets to set

getMinimumPriority

public RulePriority getMinimumPriority()

Get the minimum priority threshold when loading Rules from RuleSets.

Returns:

The minimum priority threshold.

setMinimumPriority

public void setMinimumPriority(RulePriority minimumPriority)

Set the minimum priority threshold when loading Rules from RuleSets.

Parameters:

minimumPriority - The minimum priority.

getInputPaths

public java.lang.String getInputPaths()

Get the comma separated list of input paths to process for source files.

Returns:

A comma separated list.

setInputPaths

public void setInputPaths(java.lang.String inputPaths)

Set the comma separated list of input paths to process for source files.

Parameters:

inputPaths - The comma separated list.

getInputFilePath

public java.lang.String getInputFilePath()

setInputFilePath

public void setInputFilePath(java.lang.String inputFilePath)

The input file path points to a single file, which contains a comma-separated list of source file names to process.

Parameters:

inputFilePath - path to the file

getInputUri

public java.lang.String getInputUri()

Get the input URI to process for source code objects.

Returns:

URI

setInputUri

public void setInputUri(java.lang.String inputUri)

Set the input URI to process for source code objects.

Parameters:

inputUri - a single URI

isReportShortNames

public boolean isReportShortNames()

Get whether to use File short names in Reports.

Returns:

true when using short names in reports.

setReportShortNames

public void setReportShortNames(boolean reportShortNames)

Set whether to use File short names in Reports.

Parameters:

reportShortNames - true when using short names in reports.

createRenderer

public Renderer createRenderer()

Create a Renderer instance based upon the configured reporting options. No writer is created.

Returns:

renderer

createRenderer

public Renderer createRenderer(boolean withReportWriter)

Create a Renderer instance based upon the configured reporting options. If withReportWriter then we'll configure it with a writer for the reportFile specified.

Parameters:

withReportWriter - whether to configure a writer or not

Returns:

A Renderer instance.

getReportFormat

public java.lang.String getReportFormat()

Get the report format.

Returns:

The report format.

setReportFormat

public void setReportFormat(java.lang.String reportFormat)

Set the report format. This should be a name of a Renderer.

Parameters:

reportFormat - The report format.

See Also:

Renderer

getReportFile

public java.lang.String getReportFile()

Get the file to which the report should render.

Returns:

The file to which to render.

setReportFile

public void setReportFile(java.lang.String reportFile)

Set the file to which the report should render.

Parameters:

reportFile - the file to set

isShowSuppressedViolations

public boolean isShowSuppressedViolations()

Get whether the report should show suppressed violations.

Returns:

true if showing suppressed violations, false otherwise.

setShowSuppressedViolations

public void setShowSuppressedViolations(boolean showSuppressedViolations)

Set whether the report should show suppressed violations.

Parameters:

showSuppressedViolations - true if showing suppressed violations, false otherwise.

getReportProperties

public java.util.Properties getReportProperties()

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

Returns:

The report properties.

setReportProperties

public void setReportProperties(java.util.Properties reportProperties)

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

Parameters:

reportProperties - The Report properties to set.

isStressTest

public boolean isStressTest()

Return the stress test indicator. If this value is true then PMD will randomize the order of file processing to attempt to shake out bugs.

Returns:

true if stress test is enbaled, false otherwise.

setStressTest

public void setStressTest(boolean stressTest)

Set the stress test indicator.

Parameters:

stressTest - The stree test indicator to set.

See Also:

isStressTest()

isBenchmark

public boolean isBenchmark()

Return the benchmark indicator. If this value is true then PMD will log benchmark information.

Returns:

true if benchmark logging is enbaled, false otherwise.

setBenchmark

public void setBenchmark(boolean benchmark)

Set the benchmark indicator.

Parameters:

benchmark - The benchmark indicator to set.

See Also:

isBenchmark()

isFailOnViolation

public boolean isFailOnViolation()

Whether PMD should exit with status 4 (the default behavior, true) if violations are found or just with 0 (to not break the build, e.g.).

Returns:

failOnViolation

setFailOnViolation

public void setFailOnViolation(boolean failOnViolation)

Sets whether PMD should exit with status 4 (the default behavior, true) if violations are found or just with 0 (to not break the build, e.g.).

Parameters:

failOnViolation - failOnViolation

isRuleSetFactoryCompatibilityEnabled

public boolean isRuleSetFactoryCompatibilityEnabled()

Checks if the rule set factory compatibility feature is enabled.

Returns:

true, if the rule set factory compatibility feature is enabled

See Also:

RuleSetFactoryCompatibility

setRuleSetFactoryCompatibilityEnabled

public void setRuleSetFactoryCompatibilityEnabled(boolean ruleSetFactoryCompatibilityEnabled)

Sets the rule set factory compatibility feature enabled/disabled.

Parameters:

ruleSetFactoryCompatibilityEnabled - true if the feature should be enabled

See Also:

RuleSetFactoryCompatibility

getAnalysisCache

public AnalysisCache getAnalysisCache()

Retrieves the currently used analysis cache. Will never be null.

Returns:

The currently used analysis cache. Never null.

setAnalysisCache

public void setAnalysisCache(AnalysisCache cache)

Sets the analysis cache to be used. Setting a value of null will cause a Noop AnalysisCache to be used.

Parameters:

cache - The analysis cache to be used.

setAnalysisCacheLocation

public void setAnalysisCacheLocation(java.lang.String cacheLocation)

Sets the location of the analysis cache to be used. This will automatically configure and appropriate AnalysisCache implementation.

Parameters:

cacheLocation - The location of the analysis cache to be used.