org.netbeans.insane.scanner
Interface Visitor

All Known Implementing Classes:
CountingVisitor, SimpleXmlVisitor

public interface Visitor

A visitor interface that is called by the engine during the heap scan.


Method Summary
 void visitArrayReference(ObjectMap map, java.lang.Object from, java.lang.Object to, int index)
          A new reference to target object was found.
 void visitClass(java.lang.Class cls)
          A new type was found.
 void visitObject(ObjectMap map, java.lang.Object object)
          A new object instance was found.
 void visitObjectReference(ObjectMap map, java.lang.Object from, java.lang.Object to, java.lang.reflect.Field ref)
          A reference from object from to object to was found as the contents of the field ref.
 void visitStaticReference(ObjectMap map, java.lang.Object to, java.lang.reflect.Field ref)
          A new reference static reference to target object was found.
 

Method Detail

visitClass

void visitClass(java.lang.Class cls)
A new type was found. It is guaranteed to be reported before first instance of given class. It is also guaranteed that all superclasses and interfaces will be reported before a subclass.

Parameters:
cls - the new type found.

visitObject

void visitObject(ObjectMap map,
                 java.lang.Object object)
A new object instance was found. It is guaranteed to be reported before first reference sourced from or targetted to this instance. It is also guaranteed that the instance's class will be reported before the instance.

Parameters:
map - The ObjectMap containing this object.
object - the reported instance.

visitObjectReference

void visitObjectReference(ObjectMap map,
                          java.lang.Object from,
                          java.lang.Object to,
                          java.lang.reflect.Field ref)
A reference from object from to object to was found as the contents of the field ref. It is guaranteed that both from and to objects will be reported before the reference.

Parameters:
map - The ObjectMap containing the objects.
from - The object from which the reference sources.
to - The object to which the reference points.
ref - The representation of the reference. Describes the class the referring field is declared in, and how it is named.

visitArrayReference

void visitArrayReference(ObjectMap map,
                         java.lang.Object from,
                         java.lang.Object to,
                         int index)
A new reference to target object was found. The object to is referenced by index-th slot of the array from It is guaranteed that both from and to objects will be reported before the reference.

Parameters:
map - The ObjectMap containing the objects.
from - The object from which the reference sources.
to - The object to which the reference points.
index - The array index of the to reference in from array.

visitStaticReference

void visitStaticReference(ObjectMap map,
                          java.lang.Object to,
                          java.lang.reflect.Field ref)
A new reference static reference to target object was found. It is guaranteed that the to object will be reported before the reference.

Parameters:
map - The ObjectMap containing the object.
to - The object to which the reference points.
ref - The representation of the reference. Describes the class the referring field is declared in, and how it is named.