net.sourceforge.cobertura.instrument.pass2

Class BuildClassMapClassVisitor

java.lang.Object

org.objectweb.asm.ClassVisitor

net.sourceforge.cobertura.instrument.AbstractFindTouchPointsClassInstrumenter

net.sourceforge.cobertura.instrument.pass2.BuildClassMapClassVisitor

public class BuildClassMapClassVisitor
extends AbstractFindTouchPointsClassInstrumenter

Analyzes given class. Builds ClassMap that represents any touch-points and other important information for instrumentation.

This instrumenter (ClassVisitor) does not change the bytecode of the class. It makes only analyzys and fills ClassMap.

Author:

piotr.tabor@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
private ClassMap	classMap ClassMap for the currently analyzed class.
private java.util.Set<java.lang.String>	ignoredMethods
private boolean	toInstrument It's flag that signals if the class should be instrumented by cobertura.
private BuildClassMapTouchPointListener	touchPointListener Information about important 'events' (instructions) are sent into the listener that is internally responsible for modifying the classMap content.

Fields inherited from class net.sourceforge.cobertura.instrument.AbstractFindTouchPointsClassInstrumenter

duplicatedLinesMap, eventIdGenerator, lineIdGenerator

Fields inherited from class org.objectweb.asm.ClassVisitor

api, cv

Constructor Summary

Constructors

Constructor and Description
BuildClassMapClassVisitor(org.objectweb.asm.ClassVisitor cv, java.util.Collection<java.util.regex.Pattern> ignoreRegexes, java.util.Map<java.lang.Integer,java.util.Map<java.lang.Integer,java.lang.Integer>> duplicatedLinesMap, java.util.Set<java.lang.String> ignoredMethods)

Method Summary

Modifier and Type	Method and Description
ClassMap	getClassMap() Returns classMap build for the analyzed map.
boolean	shouldBeInstrumented() It's flag that signals if the class should be instrumented by Cobertura.
void	visit(int version, int access, java.lang.String name, java.lang.String signature, java.lang.String parent, java.lang.String[] interfaces) Stores in classMap information of className and if the class should be instrumented (shouldBeInstrumented())
org.objectweb.asm.AnnotationVisitor	visitAnnotation(java.lang.String name, boolean arg1)
org.objectweb.asm.MethodVisitor	visitMethod(int access, java.lang.String name, java.lang.String desc, java.lang.String signature, java.lang.String[] exceptions) Analyzes given method and stores information about all found important places into classMap
void	visitSource(java.lang.String file, java.lang.String debug) Stores in classMap information of source filename

Methods inherited from class net.sourceforge.cobertura.instrument.AbstractFindTouchPointsClassInstrumenter

getIgnoreRegexp, setIgnoreRegexp

Methods inherited from class org.objectweb.asm.ClassVisitor

visitAttribute, visitEnd, visitField, visitInnerClass, visitOuterClass, visitTypeAnnotation

Methods inherited from class java.lang.Object

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

Field Detail

classMap

private final ClassMap classMap

ClassMap for the currently analyzed class.

touchPointListener

private final BuildClassMapTouchPointListener touchPointListener

Information about important 'events' (instructions) are sent into the listener that is internally responsible for modifying the classMap content.

toInstrument

private boolean toInstrument

It's flag that signals if the class should be instrumented by cobertura. After analyzing the class you can check the field using shouldBeInstrumented().

ignoredMethods

private final java.util.Set<java.lang.String> ignoredMethods

Constructor Detail

BuildClassMapClassVisitor

public BuildClassMapClassVisitor(org.objectweb.asm.ClassVisitor cv,
                                 java.util.Collection<java.util.regex.Pattern> ignoreRegexes,
                                 java.util.Map<java.lang.Integer,java.util.Map<java.lang.Integer,java.lang.Integer>> duplicatedLinesMap,
                                 java.util.Set<java.lang.String> ignoredMethods)

Parameters:

cv - - a listener for code-instrumentation events

ignoreRegexp - - list of patters of method calls that should be ignored from line-coverage-measurement

duplicatedLinesMap - - map of found duplicates in the class. You should use DetectDuplicatedCodeClassVisitor to find the duplicated lines.

Method Detail

visitAnnotation

public org.objectweb.asm.AnnotationVisitor visitAnnotation(java.lang.String name,
                                                           boolean arg1)

Overrides:

visitAnnotation in class org.objectweb.asm.ClassVisitor

visit

public void visit(int version,
                  int access,
                  java.lang.String name,
                  java.lang.String signature,
                  java.lang.String parent,
                  java.lang.String[] interfaces)

Stores in classMap information of className and if the class should be instrumented (shouldBeInstrumented())

Overrides:

visit in class org.objectweb.asm.ClassVisitor

visitSource

public void visitSource(java.lang.String file,
                        java.lang.String debug)

Stores in classMap information of source filename

Overrides:

visitSource in class org.objectweb.asm.ClassVisitor

visitMethod

public org.objectweb.asm.MethodVisitor visitMethod(int access,
                                                   java.lang.String name,
                                                   java.lang.String desc,
                                                   java.lang.String signature,
                                                   java.lang.String[] exceptions)

Analyzes given method and stores information about all found important places into classMap

Overrides:

visitMethod in class org.objectweb.asm.ClassVisitor

getClassMap

public ClassMap getClassMap()

Returns classMap build for the analyzed map. The classmap is filled after running the analyzer (ClassReader.accept(ClassVisitor, int)).

Returns:

the classmap.

shouldBeInstrumented

public boolean shouldBeInstrumented()

It's flag that signals if the class should be instrumented by Cobertura.