Class PmdRequest
- java.lang.Object
-
- org.apache.maven.plugins.pmd.exec.PmdRequest
-
- All Implemented Interfaces:
java.io.Serializable
public class PmdRequest extends java.lang.Object implements java.io.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 Description PmdRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addFiles(java.util.Collection<java.io.File> files)
java.lang.String
getAnalysisCacheLocation()
java.lang.String
getAuxClasspath()
java.lang.String
getBenchmarkOutputLocation()
java.lang.String
getExcludeFromFailureFile()
java.util.List<java.io.File>
getFiles()
java.lang.String
getFormat()
java.lang.String
getJavaExecutable()
java.lang.String
getLanguage()
java.lang.String
getLanguageVersion()
java.lang.String
getLogLevel()
int
getMinimumPriority()
java.lang.String
getOutputEncoding()
java.lang.String
getReportOutputDirectory()
java.lang.String
getRulesets()
java.lang.String
getSourceEncoding()
java.lang.String
getSuppressMarker()
java.lang.String
getTargetDirectory()
boolean
isColorizedLog()
boolean
isDebugEnabled()
boolean
isIncludeXmlInSite()
boolean
isShowPmdLog()
boolean
isSkipPmdError()
void
setAnalysisCacheLocation(java.lang.String analysisCacheLocation)
void
setAuxClasspath(java.lang.String auxClasspath)
void
setBenchmarkOutputLocation(java.lang.String benchmarkOutputLocation)
void
setColorizedLog(boolean colorizedLog)
void
setExcludeFromFailureFile(java.lang.String excludeFromFailureFile)
void
setFormat(java.lang.String format)
void
setIncludeXmlInSite(boolean includeXmlInSite)
void
setJavaExecutable(java.lang.String javaExecutable)
void
setLanguageAndVersion(java.lang.String language, java.lang.String targetJdk)
Configure language and language version.void
setLogLevel(java.lang.String logLevel)
void
setMinimumPriority(int minimumPriority)
void
setOutputEncoding(java.lang.String outputEncoding)
void
setReportOutputDirectory(java.lang.String reportOutputDirectory)
void
setRulesets(java.lang.String rulesets)
void
setShowPmdLog(boolean showPmdLog)
void
setSkipPmdError(boolean skipPmdError)
void
setSourceEncoding(java.lang.String sourceEncoding)
void
setSuppressMarker(java.lang.String suppressMarker)
void
setTargetDirectory(java.lang.String targetDirectory)
-
-
-
Method Detail
-
setLanguageAndVersion
public void setLanguageAndVersion(java.lang.String language, java.lang.String targetJdk)
Configure language and language version.- Parameters:
language
- the languagetargetJdk
- the language version, optional, can benull
-
setJavaExecutable
public void setJavaExecutable(java.lang.String javaExecutable)
-
setMinimumPriority
public void setMinimumPriority(int minimumPriority)
-
setAuxClasspath
public void setAuxClasspath(java.lang.String auxClasspath)
-
setSuppressMarker
public void setSuppressMarker(java.lang.String suppressMarker)
-
setAnalysisCacheLocation
public void setAnalysisCacheLocation(java.lang.String analysisCacheLocation)
-
setRulesets
public void setRulesets(java.lang.String rulesets)
-
setSourceEncoding
public void setSourceEncoding(java.lang.String sourceEncoding)
-
addFiles
public void addFiles(java.util.Collection<java.io.File> files)
-
setBenchmarkOutputLocation
public void setBenchmarkOutputLocation(java.lang.String benchmarkOutputLocation)
-
setTargetDirectory
public void setTargetDirectory(java.lang.String targetDirectory)
-
setOutputEncoding
public void setOutputEncoding(java.lang.String outputEncoding)
-
setFormat
public void setFormat(java.lang.String format)
-
setShowPmdLog
public void setShowPmdLog(boolean showPmdLog)
-
setColorizedLog
public void setColorizedLog(boolean colorizedLog)
-
setLogLevel
public void setLogLevel(java.lang.String logLevel)
-
setSkipPmdError
public void setSkipPmdError(boolean skipPmdError)
-
setIncludeXmlInSite
public void setIncludeXmlInSite(boolean includeXmlInSite)
-
setReportOutputDirectory
public void setReportOutputDirectory(java.lang.String reportOutputDirectory)
-
setExcludeFromFailureFile
public void setExcludeFromFailureFile(java.lang.String excludeFromFailureFile)
-
getJavaExecutable
public java.lang.String getJavaExecutable()
-
getLanguage
public java.lang.String getLanguage()
-
getLanguageVersion
public java.lang.String getLanguageVersion()
-
getMinimumPriority
public int getMinimumPriority()
-
getAuxClasspath
public java.lang.String getAuxClasspath()
-
getSuppressMarker
public java.lang.String getSuppressMarker()
-
getAnalysisCacheLocation
public java.lang.String getAnalysisCacheLocation()
-
getRulesets
public java.lang.String getRulesets()
-
getSourceEncoding
public java.lang.String getSourceEncoding()
-
getFiles
public java.util.List<java.io.File> getFiles()
-
getBenchmarkOutputLocation
public java.lang.String getBenchmarkOutputLocation()
-
getTargetDirectory
public java.lang.String getTargetDirectory()
-
getOutputEncoding
public java.lang.String getOutputEncoding()
-
getFormat
public java.lang.String getFormat()
-
isShowPmdLog
public boolean isShowPmdLog()
-
isColorizedLog
public boolean isColorizedLog()
-
getLogLevel
public java.lang.String getLogLevel()
-
isDebugEnabled
public boolean isDebugEnabled()
-
isSkipPmdError
public boolean isSkipPmdError()
-
isIncludeXmlInSite
public boolean isIncludeXmlInSite()
-
getReportOutputDirectory
public java.lang.String getReportOutputDirectory()
-
getExcludeFromFailureFile
public java.lang.String getExcludeFromFailureFile()
-
-