net.sourceforge.pmd.cache

Class AbstractAnalysisCache

java.lang.Object

net.sourceforge.pmd.cache.AbstractAnalysisCache

All Implemented Interfaces:

AnalysisCache, ReportListener, ThreadSafeReportListener

Direct Known Subclasses:

FileAnalysisCache

public abstract class AbstractAnalysisCache
extends Object
implements AnalysisCache

Abstract implementation of the analysis cache. Handles all operations, except for persistence.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	classpathChecksum
protected ConcurrentMap<String,AnalysisResult>	fileResultsCache
protected static Logger	LOG
protected String	pmdVersion
protected CachedRuleMapper	ruleMapper
protected long	rulesetChecksum
protected ConcurrentMap<String,AnalysisResult>	updatedResultsCache

Constructor Summary

Constructors

Constructor and Description
AbstractAnalysisCache() Creates a new empty cache

Method Summary

Methods

Modifier and Type	Method and Description
void	analysisFailed(File sourceFile) Notifies the cache that analysis of the given file has failed and should not be cached
void	checkValidity(RuleSets ruleSets, ClassLoader classLoader) Checks if the cache is valid for the configured rulesets and class loader.
List<RuleViolation>	getCachedViolations(File sourceFile) Retrieves cached violations for the given file.
boolean	isUpToDate(File sourceFile) Check if a given file is up to date in the cache and can be skipped from analysis
void	metricAdded(Metric metric) A new metric point has been reported.
void	ruleViolationAdded(RuleViolation ruleViolation) A new violation has been found.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.pmd.cache.AnalysisCache

persist

Field Detail

LOG

protected static final Logger LOG

pmdVersion

protected final String pmdVersion

fileResultsCache

protected final ConcurrentMap<String,AnalysisResult> fileResultsCache

updatedResultsCache

protected final ConcurrentMap<String,AnalysisResult> updatedResultsCache

rulesetChecksum

protected long rulesetChecksum

classpathChecksum

protected long classpathChecksum

ruleMapper

protected final CachedRuleMapper ruleMapper

Constructor Detail

AbstractAnalysisCache

public AbstractAnalysisCache()

Creates a new empty cache

Method Detail

isUpToDate

public boolean isUpToDate(File sourceFile)

Description copied from interface: AnalysisCache

Check if a given file is up to date in the cache and can be skipped from analysis

Specified by:

isUpToDate in interface AnalysisCache

Parameters:

sourceFile - The file to check in the cache

Returns:

True if the cache is a hit, false otherwise

getCachedViolations

public List<RuleViolation> getCachedViolations(File sourceFile)

Description copied from interface: AnalysisCache

Retrieves cached violations for the given file. Make sure to call AnalysisCache.isUpToDate(File) first.

Specified by:

getCachedViolations in interface AnalysisCache

Parameters:

sourceFile - The file to check in the cache

Returns:

The list of cached violations.

analysisFailed

public void analysisFailed(File sourceFile)

Description copied from interface: AnalysisCache

Notifies the cache that analysis of the given file has failed and should not be cached

Specified by:

analysisFailed in interface AnalysisCache

Parameters:

sourceFile - The file whose analysis failed

checkValidity

public void checkValidity(RuleSets ruleSets,
                 ClassLoader classLoader)

Description copied from interface: AnalysisCache

Checks if the cache is valid for the configured rulesets and class loader.

Specified by:

checkValidity in interface AnalysisCache

Parameters:

ruleSets - The rulesets configured for this analysis.

classLoader - The class loader configured for this analysis.

ruleViolationAdded

public void ruleViolationAdded(RuleViolation ruleViolation)

Description copied from interface: ThreadSafeReportListener

A new violation has been found.

Specified by:

ruleViolationAdded in interface ReportListener

Specified by:

ruleViolationAdded in interface ThreadSafeReportListener

Parameters:

ruleViolation - the found violation.

metricAdded

public void metricAdded(Metric metric)

Description copied from interface: ThreadSafeReportListener

A new metric point has been reported.

Specified by:

metricAdded in interface ReportListener

Specified by:

metricAdded in interface ThreadSafeReportListener

Parameters:

metric - the metric