mockit.asm.ClassVisitor Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jmockit Show documentation
Show all versions of jmockit Show documentation
JMockit is a Java toolkit for automated developer testing.
It contains mocking/faking APIs and a code coverage tool, supporting both JUnit and TestNG.
The mocking APIs allow all kinds of Java code, without testability restrictions, to be tested
in isolation from selected dependencies.
package mockit.asm;
import javax.annotation.*;
/**
* A visitor to visit a Java class. The methods of this class must be called in the following order:
* visit [visitSource] [visitOuterClass] (visitAnnotation)*
* (visitInnerClass | visitField | visitMethod)* visitEnd.
*/
public class ClassVisitor extends BaseWriter
{
/**
* Constructs a new Class Visitor.
*/
protected ClassVisitor() {}
/**
* Visits the header of the class.
*
* @param version the class version.
* @param access the class's access flags (see {@link Access}). This parameter also indicates if the class is
* deprecated.
* @param name the internal name of the class.
* @param signature the signature of this class. May be null if the class is not a generic one, and does
* not extend or implement generic classes or interfaces.
* @param superName the internal name of the super class.
* For interfaces, the super class is {@link Object}. May be null, but only for the
* {@link Object} class.
* @param interfaces the internal names of the class's interfaces.
*/
public void visit(
int version, int access, @Nonnull String name, @Nullable String signature, @Nullable String superName, @Nullable String[] interfaces
) {}
/**
* Visits the source of the class.
*
* @param source the name of the source file from which the class was compiled. May be null.
*/
public void visitSource(@Nullable String source) {}
/**
* Visits the enclosing class of the class. This method must be called only if the class has an enclosing class.
*
* @param owner internal name of the enclosing class of the class.
* @param name the name of the method that contains the class, or null if the class is not enclosed in a
* method of its enclosing class.
* @param desc the descriptor of the method that contains the class, or null if the class is not enclosed
* in a method of its enclosing class.
*/
public void visitOuterClass(@Nonnull String owner, @Nullable String name, @Nullable String desc) {}
/**
* Visits information about an inner class. This inner class is not necessarily a member of the class being visited.
*
* @param name the internal name of an inner class.
* @param outerName the internal name of the class to which the inner class belongs. May be null for not
* member classes.
* @param innerName the (simple) name of the inner class inside its enclosing class. May be null for
* anonymous inner classes.
* @param access the access flags of the inner class as originally declared in the enclosing class.
*/
public void visitInnerClass(@Nonnull String name, @Nullable String outerName, @Nullable String innerName, int access) {}
/**
* Visits a field of the class.
*
* @param access the field's access flags (see {@link Access}).
* This parameter also indicates if the field is synthetic and/or deprecated.
* @param name the field's name.
* @param desc the field's descriptor (see {@link JavaType}).
* @param signature the field's signature. May be null if the field's type does not use generic types.
* @param value the field's initial value. This parameter, which may be null if the field does not have
* an initial value, must be an {@link Integer}, a {@link Float}, a {@link Long}, a {@link Double}
* or a {@link String} (for int, float, long or String fields
* respectively). This parameter is only used for static fields. Its value is ignored for non
* static fields, which must be initialized through bytecode instructions in constructors or
* methods.
* @return a visitor to visit field annotations and attributes, or null if this class visitor is not
* interested in visiting these annotations and attributes.
*/
@Nullable
public FieldVisitor visitField(
int access, @Nonnull String name, @Nonnull String desc, @Nullable String signature, @Nullable Object value
) {
return null;
}
/**
* Visits a method of the class. This method must return a new {@link MethodVisitor} instance (or
* null) each time it is called, i.e., it should not return a previously returned visitor.
*
* @param access the method's access flags (see {@link Opcodes}). This parameter also indicates if the method is
* synthetic and/or deprecated.
* @param name the method's name.
* @param desc the method's descriptor (see {@link JavaType}).
* @param signature the method's signature. May be null if the method parameters, return type and
* exceptions do not use generic types.
* @param exceptions the internal names of the method's exception classes.
* @return 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.
*/
@Nullable
public MethodVisitor visitMethod(
int access, @Nonnull String name, @Nonnull String desc, @Nullable String signature, @Nullable String[] exceptions
) {
return null;
}
/**
* Returns the bytecode of the class that was built with this class visitor.
*/
public byte[] toByteArray() { return null; }
}