Package 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:

  • Constructor Details

    • PmdRequest

      public PmdRequest()

  • Method Details

    • 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(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)

    • setShowPmdLog

      public void setShowPmdLog(boolean showPmdLog)

    • setColorizedLog

      public void setColorizedLog(boolean colorizedLog)

    • 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 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()

    • isShowPmdLog

      public boolean isShowPmdLog()

    • isColorizedLog

      public boolean isColorizedLog()

    • getLogLevel

      public String getLogLevel()

    • isDebugEnabled

      public boolean isDebugEnabled()

    • isSkipPmdError

      public boolean isSkipPmdError()

    • isIncludeXmlInSite

      public boolean isIncludeXmlInSite()

    • getReportOutputDirectory

      public String getReportOutputDirectory()

    • getExcludeFromFailureFile

      public String getExcludeFromFailureFile()