Package edu.umd.cs.findbugs.classfile.engine.bcel

Class JavaClassAnalysisEngine

java.lang.Object

edu.umd.cs.findbugs.classfile.engine.bcel.JavaClassAnalysisEngine

All Implemented Interfaces:

IAnalysisEngine<ClassDescriptor,org.apache.bcel.classfile.JavaClass>, IClassAnalysisEngine<org.apache.bcel.classfile.JavaClass>

public class JavaClassAnalysisEngine
extends Object
implements IClassAnalysisEngine<org.apache.bcel.classfile.JavaClass>

Analysis engine to produce a BCEL JavaClass object for a named class.

Author:

David Hovemeyer

Constructor Summary

Constructors

Constructor	Description
JavaClassAnalysisEngine()

Method Summary

Modifier and Type	Method	Description
org.apache.bcel.classfile.JavaClass	analyze(IAnalysisCache analysisCache, ClassDescriptor descriptor)	Perform an analysis on class or method named by given descriptor.
boolean	canRecompute()	Return true if analysis results produced by this analysis engine can be recomputed.
void	registerWith(IAnalysisCache analysisCache)	Register the analysis engine with given analysis cache.

Methods inherited from class java.lang.Object

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

Constructor Details

JavaClassAnalysisEngine

public JavaClassAnalysisEngine()

Method Details

analyze

public org.apache.bcel.classfile.JavaClass analyze(IAnalysisCache analysisCache,
 ClassDescriptor descriptor)
                                            throws CheckedAnalysisException

Description copied from interface: IAnalysisEngine

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

Specified by:

analyze in interface IAnalysisEngine<ClassDescriptor,org.apache.bcel.classfile.JavaClass>

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

Throws:

CheckedAnalysisException

registerWith

public void registerWith(IAnalysisCache analysisCache)

Description copied from interface: IAnalysisEngine

Register the analysis engine with given analysis cache.

Specified by:

registerWith in interface IAnalysisEngine<ClassDescriptor,org.apache.bcel.classfile.JavaClass>

Parameters:

analysisCache - the analysis cache

canRecompute

public boolean canRecompute()

Description copied from interface: IClassAnalysisEngine

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

Specified by:

canRecompute in interface IClassAnalysisEngine<org.apache.bcel.classfile.JavaClass>

Returns:

true if analysis results produced by this engine can be recomputed, false if for some reason the analysis results must be retained indefinitely