Package net.sourceforge.pmd.cache
Class AbstractAnalysisCache
- java.lang.Object
-
- net.sourceforge.pmd.cache.AbstractAnalysisCache
-
- All Implemented Interfaces:
AnalysisCache
,ThreadSafeReportListener
- Direct Known Subclasses:
FileAnalysisCache
public abstract class AbstractAnalysisCache extends java.lang.Object implements AnalysisCache
Abstract implementation of the analysis cache. Handles all operations, except for persistence.
-
-
Field Summary
Fields Modifier and Type Field Description protected long
auxClassPathChecksum
protected long
executionClassPathChecksum
protected java.util.concurrent.ConcurrentMap<java.lang.String,AnalysisResult>
fileResultsCache
protected static java.util.logging.Logger
LOG
protected java.lang.String
pmdVersion
protected CachedRuleMapper
ruleMapper
protected long
rulesetChecksum
protected java.util.concurrent.ConcurrentMap<java.lang.String,AnalysisResult>
updatedResultsCache
-
Constructor Summary
Constructors Constructor Description AbstractAnalysisCache()
Creates a new empty cache
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
analysisFailed(java.io.File sourceFile)
Notifies the cache that analysis of the given file has failed and should not be cached.protected abstract boolean
cacheExists()
Returns true if the cache exists.void
checkValidity(RuleSets ruleSets, java.lang.ClassLoader auxclassPathClassLoader)
Checks if the cache is valid for the configured rulesets and class loader.java.util.List<RuleViolation>
getCachedViolations(java.io.File sourceFile)
Retrieves cached violations for the given file.boolean
isUpToDate(java.io.File sourceFile)
Checks 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 java.util.logging.Logger LOG
-
pmdVersion
protected final java.lang.String pmdVersion
-
fileResultsCache
protected final java.util.concurrent.ConcurrentMap<java.lang.String,AnalysisResult> fileResultsCache
-
updatedResultsCache
protected final java.util.concurrent.ConcurrentMap<java.lang.String,AnalysisResult> updatedResultsCache
-
ruleMapper
protected final CachedRuleMapper ruleMapper
-
rulesetChecksum
protected long rulesetChecksum
-
auxClassPathChecksum
protected long auxClassPathChecksum
-
executionClassPathChecksum
protected long executionClassPathChecksum
-
-
Method Detail
-
isUpToDate
public boolean isUpToDate(java.io.File sourceFile)
Description copied from interface:AnalysisCache
Checks if a given file is up to date in the cache and can be skipped from analysis. Regardless of the return value of this method, each call adds the parameter to the updated cache, which allowsThreadSafeReportListener.ruleViolationAdded(RuleViolation)
to add a rule violation to the file. TODO is this really best behaviour? This side-effects seems counter-intuitive.- Specified by:
isUpToDate
in interfaceAnalysisCache
- Parameters:
sourceFile
- The file to check in the cache- Returns:
- True if the cache is a hit, false otherwise
-
getCachedViolations
public java.util.List<RuleViolation> getCachedViolations(java.io.File sourceFile)
Description copied from interface:AnalysisCache
Retrieves cached violations for the given file. Make sure to callAnalysisCache.isUpToDate(File)
first.- Specified by:
getCachedViolations
in interfaceAnalysisCache
- Parameters:
sourceFile
- The file to check in the cache- Returns:
- The list of cached violations.
-
analysisFailed
public void analysisFailed(java.io.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 interfaceAnalysisCache
- Parameters:
sourceFile
- The file whose analysis failed
-
cacheExists
protected abstract boolean cacheExists()
Returns true if the cache exists. If so, normal cache validity checks will be performed. Otherwise, the cache is necessarily invalid (e.g. on a first run).
-
checkValidity
public void checkValidity(RuleSets ruleSets, java.lang.ClassLoader auxclassPathClassLoader)
Description copied from interface:AnalysisCache
Checks if the cache is valid for the configured rulesets and class loader. If the provided rulesets and classpath don't match those of the cache, the cache is invalidated. This needs to be called before analysis, as it conditions the good behaviour ofAnalysisCache.isUpToDate(File)
.- Specified by:
checkValidity
in interfaceAnalysisCache
- Parameters:
ruleSets
- The rulesets configured for this analysis.auxclassPathClassLoader
- The class loader for auxclasspath 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 interfaceThreadSafeReportListener
- 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 interfaceThreadSafeReportListener
- Parameters:
metric
- the metric
-
-