org.pfsw.tools.cda.core.dependency.analyzer

Class ClassFileAnalyzer

java.lang.Object

org.apache.bcel.classfile.EmptyVisitor

org.pfsw.tools.cda.core.dependency.analyzer.AClassFileAnalyzer

org.pfsw.tools.cda.core.dependency.analyzer.ClassFileAnalyzer

All Implemented Interfaces:

org.apache.bcel.classfile.Visitor

public class ClassFileAnalyzer
extends AClassFileAnalyzer

Extracts all dependency details from a single class file into the underlying model (i.e. ClassInformation). For each class to be analyzed a new ClassFileAnalyzer instance must be used.

class is not thread-safe!

Constructor Summary

Constructors

Constructor and Description
ClassFileAnalyzer(IClassSpace aClassSpace) Initialize the new instance with a class space.

Method Summary

Modifier and Type	Method and Description
protected ClassInformation	addDependency(java.lang.String className, org.pfsw.odem.DependencyClassification classification)
protected void	addDependencyFromSignature(java.lang.String signature, org.pfsw.odem.DependencyClassification classification) Scans over the given string and adds all fully qualified class names.
protected ClassInformation	addInterfaceName(java.lang.String className, org.pfsw.odem.DependencyClassification classification)
protected ClassInformation	addSuperClassName(java.lang.String className)
protected void	doAnalyze(ClassInformation classInfo) Analyze the given class in the context of the analyzer's current workset.
protected GenericClassContainer	findContainerFor(ClassInformation classInfo)
protected IClassSpace	getClassSpace()
protected GenericClassContainer	getCurrentContainer() Returns the container of the class that currently gets analyzed.
protected java.util.List<int[]>	getIdRegistry()
protected SignatureExaminer	getSignatureExaminer()
protected void	handleElementValue(org.apache.bcel.classfile.ElementValue elementValue)
boolean	isAnnotationType(org.apache.bcel.classfile.JavaClass javaClass) Returns true if definitely represents an annotation type
boolean	isClassType(org.apache.bcel.classfile.JavaClass javaClass) Returns true if definitely represents a class type
boolean	isEnumType(org.apache.bcel.classfile.JavaClass javaClass) Returns true if definitely represents an enum type
boolean	isInterfaceType(org.apache.bcel.classfile.JavaClass javaClass) Returns true if definitely represents an interface type
protected void	notifyAboutMethodInvocation(MethodInvocationInformation invocationInfo)
protected void	prepareAndAddClassName(java.lang.String className) Checks if the given className is an array signature and handles it appropriately.
protected void	registerDefaultCodeAnalyzers()
protected boolean	registerID(int nameIndex, int typeIndex) Checks if the ID for the given two values is already registered.
protected void	setClassSpace(IClassSpace newValue)
protected void	setIdRegistry(java.util.List<int[]> idRegistry)
java.lang.String	toString()
void	visitAnnotationDefault(org.apache.bcel.classfile.AnnotationDefault annotationDefault)
void	visitAnnotationEntry(org.apache.bcel.classfile.AnnotationEntry annotation)
void	visitConstantClass(org.apache.bcel.classfile.ConstantClass classRef)
void	visitConstantNameAndType(org.apache.bcel.classfile.ConstantNameAndType nameAndType)
void	visitField(org.apache.bcel.classfile.Field field)
void	visitJavaClass(org.apache.bcel.classfile.JavaClass javaClass)
void	visitLocalVariable(org.apache.bcel.classfile.LocalVariable localVar)
void	visitLocalVariableTable(org.apache.bcel.classfile.LocalVariableTable localVarsTable)
void	visitLocalVariableTypeTable(org.apache.bcel.classfile.LocalVariableTypeTable varTypeTable)
void	visitMethod(org.apache.bcel.classfile.Method method)
void	visitParameterAnnotationEntry(org.apache.bcel.classfile.ParameterAnnotationEntry paramAnnotationEntry)
void	visitSignature(org.apache.bcel.classfile.Signature signature)

Methods inherited from class org.pfsw.tools.cda.core.dependency.analyzer.AClassFileAnalyzer

addCodeAnalyzers, analyze, analyzeCodeOfMethod, calculateHashIfNecessary, findClassForNameIndex, futil, getClassToAnalyze, getConstantPool, getCurrentClass, getLogger, getMethodCodeAnalyzers, getMethodInvocationListener, initCodeAnalyzers, isCalculatingHashesEnabled, makeNamedTypeID, parse, registerListeners, setCalculatingHashesEnabled, setClassToAnalyze, setCurrentClass, visitParsedClass

Methods inherited from class org.apache.bcel.classfile.EmptyVisitor

visitAnnotation, visitBootstrapMethods, visitCode, visitCodeException, visitConstantDouble, visitConstantDynamic, visitConstantFieldref, visitConstantFloat, visitConstantInteger, visitConstantInterfaceMethodref, visitConstantInvokeDynamic, visitConstantLong, visitConstantMethodHandle, visitConstantMethodref, visitConstantMethodType, visitConstantModule, visitConstantPackage, visitConstantPool, visitConstantString, visitConstantUtf8, visitConstantValue, visitDeprecated, visitEnclosingMethod, visitExceptionTable, visitInnerClass, visitInnerClasses, visitLineNumber, visitLineNumberTable, visitMethodParameter, visitMethodParameters, visitModule, visitModuleExports, visitModuleMainClass, visitModuleOpens, visitModulePackages, visitModuleProvides, visitModuleRequires, visitNestHost, visitNestMembers, visitParameterAnnotation, visitSourceFile, visitStackMap, visitStackMapEntry, visitSynthetic, visitUnknown

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassFileAnalyzer

public ClassFileAnalyzer(IClassSpace aClassSpace)

Initialize the new instance with a class space.

Method Detail

visitJavaClass

public void visitJavaClass(org.apache.bcel.classfile.JavaClass javaClass)

Specified by:

visitJavaClass in interface org.apache.bcel.classfile.Visitor

Overrides:

visitJavaClass in class org.apache.bcel.classfile.EmptyVisitor

visitConstantClass

public void visitConstantClass(org.apache.bcel.classfile.ConstantClass classRef)

Specified by:

visitConstantClass in interface org.apache.bcel.classfile.Visitor

Overrides:

visitConstantClass in class org.apache.bcel.classfile.EmptyVisitor

visitField

public void visitField(org.apache.bcel.classfile.Field field)

Specified by:

visitField in interface org.apache.bcel.classfile.Visitor

Overrides:

visitField in class org.apache.bcel.classfile.EmptyVisitor

visitConstantNameAndType

public void visitConstantNameAndType(org.apache.bcel.classfile.ConstantNameAndType nameAndType)

Specified by:

visitConstantNameAndType in interface org.apache.bcel.classfile.Visitor

Overrides:

visitConstantNameAndType in class org.apache.bcel.classfile.EmptyVisitor

visitLocalVariable

public void visitLocalVariable(org.apache.bcel.classfile.LocalVariable localVar)

Specified by:

visitLocalVariable in interface org.apache.bcel.classfile.Visitor

Overrides:

visitLocalVariable in class org.apache.bcel.classfile.EmptyVisitor

visitLocalVariableTable

public void visitLocalVariableTable(org.apache.bcel.classfile.LocalVariableTable localVarsTable)

Specified by:

visitLocalVariableTable in interface org.apache.bcel.classfile.Visitor

Overrides:

visitLocalVariableTable in class org.apache.bcel.classfile.EmptyVisitor

visitAnnotationEntry

public void visitAnnotationEntry(org.apache.bcel.classfile.AnnotationEntry annotation)

Specified by:

visitAnnotationEntry in interface org.apache.bcel.classfile.Visitor

Overrides:

visitAnnotationEntry in class org.apache.bcel.classfile.EmptyVisitor

visitAnnotationDefault

public void visitAnnotationDefault(org.apache.bcel.classfile.AnnotationDefault annotationDefault)

Specified by:

visitAnnotationDefault in interface org.apache.bcel.classfile.Visitor

Overrides:

visitAnnotationDefault in class org.apache.bcel.classfile.EmptyVisitor

visitParameterAnnotationEntry

public void visitParameterAnnotationEntry(org.apache.bcel.classfile.ParameterAnnotationEntry paramAnnotationEntry)

Specified by:

visitParameterAnnotationEntry in interface org.apache.bcel.classfile.Visitor

Overrides:

visitParameterAnnotationEntry in class org.apache.bcel.classfile.EmptyVisitor

visitMethod

public void visitMethod(org.apache.bcel.classfile.Method method)

Specified by:

visitMethod in interface org.apache.bcel.classfile.Visitor

Overrides:

visitMethod in class org.apache.bcel.classfile.EmptyVisitor

visitLocalVariableTypeTable

public void visitLocalVariableTypeTable(org.apache.bcel.classfile.LocalVariableTypeTable varTypeTable)

Specified by:

visitLocalVariableTypeTable in interface org.apache.bcel.classfile.Visitor

Overrides:

visitLocalVariableTypeTable in class org.apache.bcel.classfile.EmptyVisitor

visitSignature

public void visitSignature(org.apache.bcel.classfile.Signature signature)

Specified by:

visitSignature in interface org.apache.bcel.classfile.Visitor

Overrides:

visitSignature in class org.apache.bcel.classfile.EmptyVisitor

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

doAnalyze

protected void doAnalyze(ClassInformation classInfo)

Analyze the given class in the context of the analyzer's current workset. As a result the classInfo object contains all directly referred classes.

Specified by:

doAnalyze in class AClassFileAnalyzer

handleElementValue

protected void handleElementValue(org.apache.bcel.classfile.ElementValue elementValue)

isClassType

public final boolean isClassType(org.apache.bcel.classfile.JavaClass javaClass)

Returns true if definitely represents a class type

isInterfaceType

public final boolean isInterfaceType(org.apache.bcel.classfile.JavaClass javaClass)

Returns true if definitely represents an interface type

isAnnotationType

public final boolean isAnnotationType(org.apache.bcel.classfile.JavaClass javaClass)

Returns true if definitely represents an annotation type

isEnumType

public final boolean isEnumType(org.apache.bcel.classfile.JavaClass javaClass)

Returns true if definitely represents an enum type

prepareAndAddClassName

protected void prepareAndAddClassName(java.lang.String className)

Checks if the given className is an array signature and handles it appropriately. Otherwise the given className is directly added.

addDependencyFromSignature

protected void addDependencyFromSignature(java.lang.String signature,
                                          org.pfsw.odem.DependencyClassification classification)

Scans over the given string and adds all fully qualified class names. Special indicators like '[' for arrays or 'L', ';', '>' will be skipped.

addSuperClassName

protected ClassInformation addSuperClassName(java.lang.String className)

addInterfaceName

protected ClassInformation addInterfaceName(java.lang.String className,
                                            org.pfsw.odem.DependencyClassification classification)

addDependency

protected ClassInformation addDependency(java.lang.String className,
                                         org.pfsw.odem.DependencyClassification classification)

findContainerFor

protected GenericClassContainer findContainerFor(ClassInformation classInfo)

getCurrentContainer

protected GenericClassContainer getCurrentContainer()

Returns the container of the class that currently gets analyzed.

registerID

protected boolean registerID(int nameIndex,
                             int typeIndex)

Checks if the ID for the given two values is already registered. If so it returns false. If not it adds a new ID derived from the two given values to the registry and returns true.

notifyAboutMethodInvocation

protected void notifyAboutMethodInvocation(MethodInvocationInformation invocationInfo)

Overrides:

notifyAboutMethodInvocation in class AClassFileAnalyzer

registerDefaultCodeAnalyzers

protected void registerDefaultCodeAnalyzers()

getSignatureExaminer

protected SignatureExaminer getSignatureExaminer()

getClassSpace

protected IClassSpace getClassSpace()

setClassSpace

protected void setClassSpace(IClassSpace newValue)

getIdRegistry

protected java.util.List<int[]> getIdRegistry()

setIdRegistry

protected void setIdRegistry(java.util.List<int[]> idRegistry)