edu.umd.cs.findbugs.classfile

Interface IAnalysisEngine<DescriptorType>

public interface IAnalysisEngine<DescriptorType>

An engine for analyzing classes or methods.

Author: David Hovemeyer

Method Summary
Object	analyze(IAnalysisCache analysisCache, DescriptorType descriptor) Perform an analysis on class or method named by given descriptor.
void	registerWith(IAnalysisCache analysisCache) Register the analysis engine with given analysis cache.
boolean	retainAnalysisResults() Return true if analysis results produced by this analysis engine should be retained indefinitely.

Method Detail

analyze

public Object analyze(IAnalysisCache analysisCache, DescriptorType descriptor)

Perform an analysis on class or method named by given descriptor.

Parameters: analysisCache the analysis cache descriptor the descriptor of the class or method to be analyzed

Returns: the result of the analysis of the class or method

registerWith

public void registerWith(IAnalysisCache analysisCache)

Parameters: analysisCache the analysis cache

Return true if analysis results produced by this analysis engine should be retained indefinitely. Unless some correctness criterion prevents analysis results from being recomputing, analysis engines should return false (allowing the cache to be kept to a manageable size).

Returns: true if analysis results produced by this engine should be retained indefinitely, false if they may be recomputed as needed

Interface IAnalysisEngine<DescriptorType>

Method Detail

analyze

registerWith

retainAnalysisResults