org.apache.maven.plugins.pmd.exec

Class PmdRequest

java.lang.Object

org.apache.maven.plugins.pmd.exec.PmdRequest

All Implemented Interfaces:

Serializable

public class PmdRequest
extends Object
implements Serializable

Data object to store all configuration options needed to execute PMD as a separate process.

This class is intended to be serialized and read back.

Some properties might be optional and can be null.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PmdRequest()

Method Summary

Modifier and Type	Method and Description
void	addFiles(Collection<File> files)
String	getAnalysisCacheLocation()
String	getAuxClasspath()
String	getBenchmarkOutputLocation()
String	getExcludeFromFailureFile()
List<File>	getFiles()
String	getFormat()
String	getJavaExecutable()
String	getLanguage()
String	getLanguageVersion()
String	getLogLevel()
int	getMinimumPriority()
String	getOutputEncoding()
String	getReportOutputDirectory()
List<String>	getRulesets()
String	getSourceEncoding()
String	getSuppressMarker()
String	getTargetDirectory()
boolean	isDebugEnabled()
boolean	isIncludeXmlInSite()
boolean	isSkipPmdError()
void	setAnalysisCacheLocation(String analysisCacheLocation)
void	setAuxClasspath(String auxClasspath)
void	setBenchmarkOutputLocation(String benchmarkOutputLocation)
void	setExcludeFromFailureFile(String excludeFromFailureFile)
void	setFormat(String format)
void	setIncludeXmlInSite(boolean includeXmlInSite)
void	setJavaExecutable(String javaExecutable)
void	setLanguageAndVersion(String language, String targetJdk) Configure language and language version.
void	setLogLevel(String logLevel)
void	setMinimumPriority(int minimumPriority)
void	setOutputEncoding(String outputEncoding)
void	setReportOutputDirectory(String reportOutputDirectory)
void	setRulesets(List<String> rulesets)
void	setSkipPmdError(boolean skipPmdError)
void	setSourceEncoding(String sourceEncoding)
void	setSuppressMarker(String suppressMarker)
void	setTargetDirectory(String targetDirectory)

Methods inherited from class java.lang.Object

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

Constructor Detail

PmdRequest

public PmdRequest()

Method Detail

setLanguageAndVersion

public void setLanguageAndVersion(String language,
                                  String targetJdk)

Configure language and language version.

Parameters:

language - the language

targetJdk - the language version, optional, can be null

setJavaExecutable

public void setJavaExecutable(String javaExecutable)

setMinimumPriority

public void setMinimumPriority(int minimumPriority)

setAuxClasspath

public void setAuxClasspath(String auxClasspath)

setSuppressMarker

public void setSuppressMarker(String suppressMarker)

setAnalysisCacheLocation

public void setAnalysisCacheLocation(String analysisCacheLocation)

setRulesets

public void setRulesets(List<String> rulesets)

setSourceEncoding

public void setSourceEncoding(String sourceEncoding)

addFiles

public void addFiles(Collection<File> files)

setBenchmarkOutputLocation

public void setBenchmarkOutputLocation(String benchmarkOutputLocation)

setTargetDirectory

public void setTargetDirectory(String targetDirectory)

setOutputEncoding

public void setOutputEncoding(String outputEncoding)

setFormat

public void setFormat(String format)

setLogLevel

public void setLogLevel(String logLevel)

setSkipPmdError

public void setSkipPmdError(boolean skipPmdError)

setIncludeXmlInSite

public void setIncludeXmlInSite(boolean includeXmlInSite)

setReportOutputDirectory

public void setReportOutputDirectory(String reportOutputDirectory)

setExcludeFromFailureFile

public void setExcludeFromFailureFile(String excludeFromFailureFile)

getJavaExecutable

public String getJavaExecutable()

getLanguage

public String getLanguage()

getLanguageVersion

public String getLanguageVersion()

getMinimumPriority

public int getMinimumPriority()

getAuxClasspath

public String getAuxClasspath()

getSuppressMarker

public String getSuppressMarker()

getAnalysisCacheLocation

public String getAnalysisCacheLocation()

getRulesets

public List<String> getRulesets()

getSourceEncoding

public String getSourceEncoding()

getFiles

public List<File> getFiles()

getBenchmarkOutputLocation

public String getBenchmarkOutputLocation()

getTargetDirectory

public String getTargetDirectory()

getOutputEncoding

public String getOutputEncoding()

getFormat

public String getFormat()

getLogLevel

public String getLogLevel()

isDebugEnabled

public boolean isDebugEnabled()

isSkipPmdError

public boolean isSkipPmdError()

isIncludeXmlInSite

public boolean isIncludeXmlInSite()

getReportOutputDirectory

public String getReportOutputDirectory()

getExcludeFromFailureFile

public String getExcludeFromFailureFile()