Package org.apache.maven.plugins.pmd

Klasse PmdReport

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.plugins.pmd.AbstractPmdReport
org.apache.maven.plugins.pmd.PmdReport
Alle implementierten Schnittstellen:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport
Bekannte direkte Unterklassen:
AggregatorPmdReport
@Mojo(name="pmd", threadSafe=true, requiresDependencyResolution=TEST) public class PmdReport extends AbstractPmdReport
Creates a PMD site report based on the rulesets and configuration set in the plugin. It can also generate a pmd output file aside from the site report in any of the following formats: xml, csv or txt.
Seit:
2.0
Version:
$Id$
Autor:
Brett Porter

  • Konstruktordetails

    • PmdReport

      public PmdReport()

  • Methodendetails

    • getName

      public String getName(Locale locale)

    • getDescription

      public String getDescription(Locale locale)

    • getI18nString

      protected String getI18nString(Locale locale, String key)
      Parameter:
      locale - The locale
      key - The key to search for
      Gibt zurück:
      The text appropriate for the locale.

    • setRulesets

      public void setRulesets(String[] rulesets)
      Configures the PMD rulesets to be used directly. Note: Usually the rulesets are configured via the property.
      Parameter:
      rulesets - the PMD rulesets to be used.
      Siehe auch:
      • rulesets

    • executeReport

      public void executeReport(Locale locale) throws org.apache.maven.reporting.MavenReportException
      Angegeben von:
      executeReport in Klasse org.apache.maven.reporting.AbstractMavenReport
      Löst aus:
      org.apache.maven.reporting.MavenReportException

    • canGenerateReport

      public boolean canGenerateReport()
      Beschreibung aus Klasse kopiert: AbstractPmdReport
      Angegeben von:
      canGenerateReport in Schnittstelle org.apache.maven.reporting.MavenReport
      Setzt außer Kraft:
      canGenerateReport in Klasse AbstractPmdReport

    • getLocationTemp

      protected String getLocationTemp(String name, int position)
      Convenience method to get the location of the specified file name.
      Parameter:
      name - the name of the file whose location is to be resolved
      position - position in the list of rulesets (1-based)
      Gibt zurück:
      a String that contains the absolute file name of the file

    • getOutputName

      public String getOutputName()

    • createRenderer

      @Deprecated public final net.sourceforge.pmd.renderers.Renderer createRenderer() throws org.apache.maven.reporting.MavenReportException
      Veraltet.
      Use PmdExecutor.createRenderer(String, String) instead.
      Create and return the correct renderer for the output type.
      Gibt zurück:
      the renderer based on the configured output
      Löst aus:
      org.apache.maven.reporting.MavenReportException - if no renderer found for the output type