mockit.asm.classes.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.classes;
import javax.annotation.*;
import mockit.asm.*;
import mockit.asm.fields.*;
import mockit.asm.jvmConstants.*;
import mockit.asm.methods.*;
import mockit.asm.types.*;
/**
* A visitor to visit a Java class, in the following order:
* visit (visitAnnotation)* (visitInnerClass | visitField | visitMethod)* visitEnd.
*/
public class ClassVisitor extends BaseWriter
{
protected ClassVisitor() {}
/**
* Visits the header of the class.
*
* @param version the class version
* @param access the class's access flags (see {@link Access})
* @param name the internal name of the class
* @param additionalInfo additional class information
*/
public void visit(int version, int access, @Nonnull String name, @Nonnull ClassInfo additionalInfo) {}
/**
* Visits information about an inner class, which 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; null for not member classes
* @param innerName the (simple) name of the inner class inside its enclosing class; 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})
* @param name the field's name
* @param desc the field's descriptor (see {@link JavaType})
* @param signature the field's signature; null when the field's type does not use generic types
* @param value the field's initial value; null when the field does not have an initial value; otherwise, 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})
* @param name the method's name
* @param desc the method's descriptor (see {@link JavaType})
* @param signature the method's signature, 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; }
}