Package net.sourceforge.pmd.processor

Class AbstractPMDProcessor

java.lang.Object

net.sourceforge.pmd.processor.AbstractPMDProcessor

Direct Known Subclasses:

MonoThreadProcessor, MultiThreadProcessor

public abstract class AbstractPMDProcessor
extends Object

Author:

Romain Pelisse <belaran@gmail.com>

Field Summary

Fields

Modifier and Type	Field	Description
protected PMDConfiguration	configuration

Constructor Summary

Constructors

Constructor	Description
AbstractPMDProcessor(PMDConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
protected abstract void	collectReports(List<Renderer> renderers)
protected RuleSets	createRuleSets(RuleSetFactory factory, Report report)	Create instances for each rule defined in the ruleset(s) in the configuration.
protected String	filenameFrom(DataSource dataSource)	Deprecated. this method will be removed.
void	processFiles(RuleSetFactory ruleSetFactory, List<DataSource> files, RuleContext ctx, List<Renderer> renderers)
void	renderReports(List<Renderer> renderers, Report report)
protected abstract void	runAnalysis(PmdRunnable runnable)

Methods inherited from class java.lang.Object

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

Field Detail

configuration

protected final PMDConfiguration configuration

Constructor Detail

AbstractPMDProcessor

public AbstractPMDProcessor(PMDConfiguration configuration)

Method Detail

renderReports

public void renderReports(List<Renderer> renderers,
                          Report report)

filenameFrom

@Deprecated
protected String filenameFrom(DataSource dataSource)

Deprecated.

this method will be removed. It was once used to determine a short filename for the file being analyzed, so that shortnames can be reported. But the logic has been moved to the renderers.

createRuleSets

protected RuleSets createRuleSets(RuleSetFactory factory,
                                  Report report)

Create instances for each rule defined in the ruleset(s) in the configuration. Please note, that the returned instances must not be used by different threads. Each thread must create its own copy of the rules.

Parameters:

factory - The factory used to create the configured rule sets

report - The base report on which to report any configuration errors

Returns:

the rules within a rulesets

processFiles

public void processFiles(RuleSetFactory ruleSetFactory,
                         List<DataSource> files,
                         RuleContext ctx,
                         List<Renderer> renderers)

runAnalysis

protected abstract void runAnalysis(PmdRunnable runnable)

collectReports

protected abstract void collectReports(List<Renderer> renderers)