edu.umd.cs.findbugs.classfile

Interface IAnalysisEngine<DescriptorType,ResultType>

All Known Subinterfaces:

IClassAnalysisEngine<ResultType>, IMethodAnalysisEngine<ResultType>

All Known Implementing Classes:

AnalysisFactory, AssertionMethodsFactory, AssignedFieldMapFactory, BackwardTypeQualifierDataflowFactoryFactory, BlockTypeAnalysisFactory, CallListDataflowFactory, CFGFactory, ClassContextClassAnalysisEngine, ClassDataAnalysisEngine, ClassInfoAnalysisEngine, ClassNameAndSuperclassInfoAnalysisEngine, ClassNodeAnalysisEngine, ClassReaderAnalysisEngine, CompactLocationNumberingFactory, ConstantDataflowFactory, ConstantPoolGenFactory, DepthFirstSearchFactory, DominatorsAnalysisFactory, ExceptionSetFactoryFactory, FinallyDuplicatesInfoFactory, ForwardTypeQualifierDataflowFactoryFactory, IsNullValueDataflowFactory, JavaClassAnalysisEngine, LiveLocalStoreDataflowFactory, LoadDataflowFactory, LoadedFieldSetFactory, LockCheckerFactory, LockDataflowFactory, MethodBytecodeSetFactory, MethodFactory, MethodGenFactory, NonExceptionPostdominatorsAnalysisFactory, NonImplicitExceptionPostDominatorsAnalysisFactory, ObligationDataflowFactory, OpcodeStack.JumpInfoFactory, ParameterSignatureListFactory, RecomputableClassAnalysisEngine, ReturnPathDataflowFactory, ReturnPathTypeDataflowFactory, ReverseDepthFirstSearchFactory, StackMapAnalyzer.StackMapAnalysisFactory, StoreDataflowFactory, TypeDataflowFactory, UnconditionalValueDerefDataflowFactory, UnpackedCodeFactory, UsagesRequiringNonNullValuesFactory, ValueNumberDataflowFactory, ValueRangeAnalysisFactory

public interface IAnalysisEngine<DescriptorType,ResultType>

An engine for analyzing classes or methods.

Author:

David Hovemeyer

Method Summary

Modifier and Type	Method and Description
ResultType	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.

Method Detail

analyze

ResultType analyze(IAnalysisCache analysisCache,
                   DescriptorType descriptor)
            throws CheckedAnalysisException

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

Throws:

CheckedAnalysisException

registerWith

void registerWith(IAnalysisCache analysisCache)

Register the analysis engine with given analysis cache.

Parameters:

analysisCache - the analysis cache