Interface ClassVisitor
- All Known Implementing Classes:
ClassWriter
public interface ClassVisitor
A visitor to visit a Java class. The methods of this interface must be called
in the following order: visit (visitField |
visitMethod | visitInnerClass)* visitEnd.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Visits the header of the class.void
visitEnd()
Visits the end of the class.void
visitField
(int access, String name, String desc, Object value) Visits a field of the class.void
visitInnerClass
(String name, String outerName, String innerName, int access) Visits information about an inner class.visitMethod
(int access, String name, String desc, String[] exceptions) Visits a method of the class.
-
Method Details
-
visit
Visits the header of the class.- Parameters:
access
- the class's access flags (seeConstants
). This parameter also indicates if the class is deprecated.name
- the internal name of the class (seegetInternalName
).superName
- the internal of name of the super class (seegetInternalName
). For interfaces, the super class isObject
. May be null, but only for thejava.lang.Object
class.interfaces
- the internal names of the class's interfaces (seegetInternalName
). May be null.sourceFile
- the name of the source file from which this class was compiled. May be null.
-
visitInnerClass
Visits information about an inner class. This inner class is not necessarily a member of the class being visited.- Parameters:
name
- the internal name of an inner class (seegetInternalName
).outerName
- the internal name of the class to which the inner class belongs (seegetInternalName
). May be null.innerName
- the (simple) name of the inner class inside its enclosing class. May be null for anonymous inner classes.access
- the access flags of the inner class as originally declared in the enclosing class.
-
visitField
Visits a field of the class.- Parameters:
access
- the field's access flags (seeConstants
). This parameter also indicates if the field is synthetic and/or deprecated.name
- the field's name.desc
- the field's descriptor (seeType
).value
- the field's initial value. This parameter, which may be null if the field does not have an initial value, must be anInteger
, aFloat
, aLong
, aDouble
or aString
.
-
visitMethod
Visits a method of the class. This method must return a newCodeVisitor
instance (or null) each time it is called, i.e., it should not return a previously returned visitor.- Parameters:
access
- the method's access flags (seeConstants
). This parameter also indicates if the method is synthetic and/or deprecated.name
- the method's name.desc
- the method's descriptor (seeType
).exceptions
- the internal names of the method's exception classes (seegetInternalName
). May be null.- Returns:
- an object to visit the byte code of the method, or null if this class visitor is not interested in visiting the code of this method.
-
visitEnd
void visitEnd()Visits the end of the class. This method, which is the last one to be called, is used to inform the visitor that all the fields and methods of the class have been visited.
-