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
-
Feldübersicht
Von Klasse geerbte Felder org.apache.maven.plugins.pmd.AbstractPmdReport
aggregate, excludeFromFailureFile, filesToProcess, format, includeTests, includeXmlInSite, reactorProjects, session, showPmdLog, skipEmptyReport, targetDirectory
Von Klasse geerbte Felder org.apache.maven.reporting.AbstractMavenReport
localRepository, outputDirectory, project, remoteRepositories, siteRenderer, siteTool
Von Schnittstelle geerbte Felder org.apache.maven.reporting.MavenReport
CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE
Von Schnittstelle geerbte Felder org.apache.maven.plugin.Mojo
ROLE
-
Konstruktorübersicht
-
Methodenübersicht
Modifizierer und TypMethodeBeschreibungboolean
final net.sourceforge.pmd.renderers.Renderer
Veraltet.void
executeReport
(Locale locale) getDescription
(Locale locale) protected String
getI18nString
(Locale locale, String key) protected String
getLocationTemp
(String name, int position) Convenience method to get the location of the specified file name.void
setRulesets
(String[] rulesets) Configures the PMD rulesets to be used directly.Von Klasse geerbte Methoden org.apache.maven.plugins.pmd.AbstractPmdReport
constructXRefLocation, determineCurrentRootLogLevel, getAggregatedProjects, getFilesToProcess, getProject, getToolchain, isAggregator, isXml
Von Klasse geerbte Methoden org.apache.maven.reporting.AbstractMavenReport
closeReport, execute, generate, generate, generate, getCategoryName, getInputEncoding, getOutputDirectory, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, isExternalReport, setReportOutputDirectory
Von Klasse geerbte Methoden org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
-
Konstruktordetails
-
PmdReport
public PmdReport()
-
-
Methodendetails
-
getName
-
getDescription
-
getI18nString
- Parameter:
locale
- The localekey
- The key to search for- Gibt zurück:
- The text appropriate for the locale.
-
setRulesets
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:
-
executeReport
- Angegeben von:
executeReport
in Klasseorg.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 Schnittstelleorg.apache.maven.reporting.MavenReport
- Setzt außer Kraft:
canGenerateReport
in KlasseAbstractPmdReport
-
getLocationTemp
Convenience method to get the location of the specified file name.- Parameter:
name
- the name of the file whose location is to be resolvedposition
- position in the list of rulesets (1-based)- Gibt zurück:
- a String that contains the absolute file name of the file
-
getOutputName
-
createRenderer
@Deprecated public final net.sourceforge.pmd.renderers.Renderer createRenderer() throws org.apache.maven.reporting.MavenReportExceptionVeraltet.UsePmdExecutor.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
-
PmdExecutor.createRenderer(String, String)
instead.