edu.umd.cs.findbugs.ba.ch
Interface InheritanceGraphVisitor

All Known Implementing Classes:

AbstractMethodAnnotationAccumulator, OverriddenMethodsVisitor, ParameterAnnotationAccumulator

public interface InheritanceGraphVisitor

Visitor interface for traversals of the inheritance graph.

Author:

David Hovemeyer

See Also:

Subtypes2

Method Summary

boolean	visitClass(ClassDescriptor classDescriptor, XClass xclass) Visit a class vertex in the inheritance graph.
boolean	visitEdge(ClassDescriptor sourceDesc, XClass source, ClassDescriptor targetDesc, XClass target) Visit an inheritance edge in the inheritance graph.

Method Detail

visitClass

boolean visitClass(ClassDescriptor classDescriptor,
                   @CheckForNull
                   XClass xclass)

Visit a class vertex in the inheritance graph.

Parameters:

classDescriptor - ClassDescriptor of the class vertex

xclass - XClass object containing information about the class; null if class cannot be resolved

Returns:

true if traversal should continue, false otherwise

visitEdge

boolean visitEdge(ClassDescriptor sourceDesc,
                  XClass source,
                  ClassDescriptor targetDesc,
                  @CheckForNull
                  XClass target)

Visit an inheritance edge in the inheritance graph.

Parameters:

sourceDesc - ClassDescriptor of the source class (subtype)

source - XClass object containing information about source class

targetDesc - ClassDescriptor of the target class (supertype)

target - XClass object containing information about target class; null if class cannot be resolved

Returns:

true if traversal should continue, false otherwise