Package org.objectweb.asm.util

Class Printer

java.lang.Object

org.objectweb.asm.util.Printer

Direct Known Subclasses:

ASMifier, Textifier

public abstract class Printer
extends Object

An abstract converter from visit events to text.

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	api	The ASM API version implemented by this class.
static final String[]	HANDLE_TAG	The names of the tag field values for Handle.
static final String[]	OPCODES	The names of the Java Virtual Machine opcodes.
protected final StringBuilder	stringBuilder	The builder used to build strings in the various visit methods.
final List<Object>	text	The text to be printed.
static final String[]	TYPES	The names of the operand values of the MethodVisitor.visitIntInsn(int, int) method when opcode is NEWARRAY.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Printer(int api)	Constructs a new Printer.

Method Summary

Modifier and Type	Method	Description
static void	appendString(StringBuilder stringBuilder, String string)	Appends a quoted string to the given string builder.
List<Object>	getText()	Returns the text constructed by this visitor.
void	print(PrintWriter printWriter)	Prints the text constructed by this visitor.
abstract void	visit(int version, int access, String name, String signature, String superName, String[] interfaces)	Class header.
abstract void	visit(String name, Object value)	Annotation value.
Printer	visitAnnotableParameterCount(int parameterCount, boolean visible)	Number of method parameters that can have annotations.
abstract Printer	visitAnnotation(String name, String descriptor)	Nested annotation value.
abstract Printer	visitAnnotationDefault()	Method default annotation.
abstract void	visitAnnotationEnd()	Annotation end.
abstract Printer	visitArray(String name)	Annotation array value.
abstract Printer	visitClassAnnotation(String descriptor, boolean visible)	Class annotation.
abstract void	visitClassAttribute(Attribute attribute)	Class attribute.
abstract void	visitClassEnd()	Class end.
Printer	visitClassTypeAnnotation(int typeRef, TypePath typePath, String descriptor, boolean visible)	Class type annotation.
abstract void	visitCode()	Method start.
abstract void	visitEnum(String name, String descriptor, String value)	Annotation enum value.
void	visitExport(String packaze, int access, String... modules)	Module export.
abstract Printer	visitField(int access, String name, String descriptor, String signature, Object value)	Class field.
abstract Printer	visitFieldAnnotation(String descriptor, boolean visible)	Field annotation.
abstract void	visitFieldAttribute(Attribute attribute)	Field attribute.
abstract void	visitFieldEnd()	Field end.
abstract void	visitFieldInsn(int opcode, String owner, String name, String descriptor)	Method instruction.
Printer	visitFieldTypeAnnotation(int typeRef, TypePath typePath, String descriptor, boolean visible)	Field type annotation.
abstract void	visitFrame(int type, int numLocal, Object[] local, int numStack, Object[] stack)	Method stack frame.
abstract void	visitIincInsn(int varIndex, int increment)	Method instruction.
abstract void	visitInnerClass(String name, String outerName, String innerName, int access)	Class inner name.
abstract void	visitInsn(int opcode)	Method instruction.
Printer	visitInsnAnnotation(int typeRef, TypePath typePath, String descriptor, boolean visible)	Instruction type annotation.
abstract void	visitIntInsn(int opcode, int operand)	Method instruction.
abstract void	visitInvokeDynamicInsn(String name, String descriptor, Handle bootstrapMethodHandle, Object... bootstrapMethodArguments)	Method instruction.
abstract void	visitJumpInsn(int opcode, Label label)	Method jump instruction.
abstract void	visitLabel(Label label)	Method label.
abstract void	visitLdcInsn(Object value)	Method instruction.
abstract void	visitLineNumber(int line, Label start)	Method debug info.
abstract void	visitLocalVariable(String name, String descriptor, String signature, Label start, Label end, int index)	Method debug info.
Printer	visitLocalVariableAnnotation(int typeRef, TypePath typePath, Label[] start, Label[] end, int[] index, String descriptor, boolean visible)	Local variable type annotation.
abstract void	visitLookupSwitchInsn(Label dflt, int[] keys, Label[] labels)	Method instruction.
void	visitMainClass(String mainClass)	Module main class.
abstract void	visitMaxs(int maxStack, int maxLocals)	Method max stack and max locals.
abstract Printer	visitMethod(int access, String name, String descriptor, String signature, String[] exceptions)	Class method.
abstract Printer	visitMethodAnnotation(String descriptor, boolean visible)	Method annotation.
abstract void	visitMethodAttribute(Attribute attribute)	Method attribute.
abstract void	visitMethodEnd()	Method end.
void	visitMethodInsn(int opcode, String owner, String name, String descriptor)	Deprecated. use visitMethodInsn(int, String, String, String, boolean) instead.
void	visitMethodInsn(int opcode, String owner, String name, String descriptor, boolean isInterface)	Method instruction.
Printer	visitMethodTypeAnnotation(int typeRef, TypePath typePath, String descriptor, boolean visible)	Method type annotation.
Printer	visitModule(String name, int access, String version)	Module.
void	visitModuleEnd()	Module end.
abstract void	visitMultiANewArrayInsn(String descriptor, int numDimensions)	Method instruction.
void	visitNestHost(String nestHost)	Visits the nest host class of the class.
void	visitNestMember(String nestMember)	Visits a member of the nest.
void	visitOpen(String packaze, int access, String... modules)	Module open.
abstract void	visitOuterClass(String owner, String name, String descriptor)	Class outer class.
void	visitPackage(String packaze)	Module package.
void	visitParameter(String name, int access)	Method parameter.
abstract Printer	visitParameterAnnotation(int parameter, String descriptor, boolean visible)	Method parameter annotation.
void	visitPermittedSubclass(String permittedSubclass)	Visits a permitted subclasses.
void	visitProvide(String service, String... providers)	Module provide.
Printer	visitRecordComponent(String name, String descriptor, String signature)	Visits a record component of the class.
Printer	visitRecordComponentAnnotation(String descriptor, boolean visible)	Visits an annotation of the record component.
void	visitRecordComponentAttribute(Attribute attribute)	Visits a non standard attribute of the record component.
void	visitRecordComponentEnd()	Visits the end of the record component.
Printer	visitRecordComponentTypeAnnotation(int typeRef, TypePath typePath, String descriptor, boolean visible)	Visits an annotation on a type in the record component signature.
void	visitRequire(String module, int access, String version)	Module require.
abstract void	visitSource(String source, String debug)	Class source.
abstract void	visitTableSwitchInsn(int min, int max, Label dflt, Label... labels)	Method instruction.
Printer	visitTryCatchAnnotation(int typeRef, TypePath typePath, String descriptor, boolean visible)	Try catch block type annotation.
abstract void	visitTryCatchBlock(Label start, Label end, Label handler, String type)	Method exception handler.
abstract void	visitTypeInsn(int opcode, String type)	Method instruction.
void	visitUse(String service)	Module use.
abstract void	visitVarInsn(int opcode, int varIndex)	Method instruction.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

OPCODES

public static final String[] OPCODES

The names of the Java Virtual Machine opcodes.

TYPES

public static final String[] TYPES

The names of the operand values of the MethodVisitor.visitIntInsn(int, int) method when opcode is NEWARRAY.

HANDLE_TAG

public static final String[] HANDLE_TAG

The names of the tag field values for Handle.

api

protected final int api

The ASM API version implemented by this class. The value of this field must be one of the ASMx values in Opcodes.

stringBuilder

protected final StringBuilder stringBuilder

The builder used to build strings in the various visit methods.

text

public final List<Object> text

The text to be printed. Since the code of methods is not necessarily visited in sequential order, one method after the other, but can be interlaced (some instructions from method one, then some instructions from method two, then some instructions from method one again...), it is not possible to print the visited instructions directly to a sequential stream. A class is therefore printed in a two steps process: a string tree is constructed during the visit, and printed to a sequential stream at the end of the visit. This string tree is stored in this field, as a string list that can contain other string lists, which can themselves contain other string lists, and so on.

Constructor Details

Printer

protected Printer(int api)

Constructs a new Printer.

Parameters:

api - the ASM API version implemented by this printer. Must be one of the ASMx values in Opcodes.

Method Details

visit

public abstract void visit(int version,
 int access,
 String name,
 String signature,
 String superName,
 String[] interfaces)

Class header. See ClassVisitor.visit(int, int, java.lang.String, java.lang.String, java.lang.String, java.lang.String[]).

Parameters:

version - the class version. The minor version is stored in the 16 most significant bits, and the major version in the 16 least significant bits.

access - the class's access flags (see Opcodes). This parameter also indicates if the class is deprecated.

name - the internal name of the class (see Type.getInternalName()).

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.

superName - the internal of name of the super class (see Type.getInternalName()). For interfaces, the super class is Object. May be null, but only for the Object class.

interfaces - the internal names of the class's interfaces (see Type.getInternalName()). May be null.

visitSource

public abstract void visitSource(String source,
 String debug)

Class source. See ClassVisitor.visitSource(java.lang.String, java.lang.String).

Parameters:

source - the name of the source file from which the class was compiled. May be null.

debug - additional debug information to compute the correspondence between source and compiled elements of the class. May be null.

visitModule

public Printer visitModule(String name,
 int access,
 String version)

Module. See ClassVisitor.visitModule(java.lang.String, int, java.lang.String).

Parameters:

name - the fully qualified name (using dots) of the module.

access - the module access flags, among ACC_OPEN, ACC_SYNTHETIC and ACC_MANDATED.

version - the module version, or null.

Returns:

the printer.

visitNestHost

public void visitNestHost(String nestHost)

Visits the nest host class of the class. A nest is a set of classes of the same package that share access to their private members. One of these classes, called the host, lists the other members of the nest, which in turn should link to the host of their nest. This method must be called only once and only if the visited class is a non-host member of a nest. A class is implicitly its own nest, so it's invalid to call this method with the visited class name as argument.

Parameters:

nestHost - the internal name of the host class of the nest (see Type.getInternalName()).

visitOuterClass

public abstract void visitOuterClass(String owner,
 String name,
 String descriptor)

Class outer class. See ClassVisitor.visitOuterClass(java.lang.String, java.lang.String, java.lang.String).

Parameters:

owner - internal name of the enclosing class of the class (see Type.getInternalName()).

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.

descriptor - the descriptor of the method that contains the class, or null if the class is not enclosed in a method of its enclosing class.

visitClassAnnotation

public abstract Printer visitClassAnnotation(String descriptor,
 boolean visible)

Class annotation. See ClassVisitor.visitAnnotation(java.lang.String, boolean).

Parameters:

descriptor - the class descriptor of the annotation class.

visible - true if the annotation is visible at runtime.

Returns:

the printer.

visitClassTypeAnnotation

public Printer visitClassTypeAnnotation(int typeRef,
 TypePath typePath,
 String descriptor,
 boolean visible)

Class type annotation. See ClassVisitor.visitTypeAnnotation(int, org.objectweb.asm.TypePath, java.lang.String, boolean).

Parameters:

typeRef - a reference to the annotated type. The sort of this type reference must be TypeReference.CLASS_TYPE_PARAMETER, TypeReference.CLASS_TYPE_PARAMETER_BOUND or TypeReference.CLASS_EXTENDS. See TypeReference.

typePath - the path to the annotated type argument, wildcard bound, array element type, or static inner type within 'typeRef'. May be null if the annotation targets 'typeRef' as a whole.

descriptor - the class descriptor of the annotation class.

visible - true if the annotation is visible at runtime.

Returns:

the printer.

visitClassAttribute

public abstract void visitClassAttribute(Attribute attribute)

Class attribute. See ClassVisitor.visitAttribute(org.objectweb.asm.Attribute).

Parameters:

attribute - an attribute.

visitNestMember

public void visitNestMember(String nestMember)

Visits a member of the nest. A nest is a set of classes of the same package that share access to their private members. One of these classes, called the host, lists the other members of the nest, which in turn should link to the host of their nest. This method must be called only if the visited class is the host of a nest. A nest host is implicitly a member of its own nest, so it's invalid to call this method with the visited class name as argument.

Parameters:

nestMember - the internal name of a nest member (see Type.getInternalName()).

visitPermittedSubclass

public void visitPermittedSubclass(String permittedSubclass)

Visits a permitted subclasses. A permitted subclass is one of the allowed subclasses of the current class. See ClassVisitor.visitPermittedSubclass(String).

Parameters:

permittedSubclass - the internal name of a permitted subclass (see Type.getInternalName()).

visitInnerClass

public abstract void visitInnerClass(String name,
 String outerName,
 String innerName,
 int access)

Class inner name. See ClassVisitor.visitInnerClass(java.lang.String, java.lang.String, java.lang.String, int).

Parameters:

name - the internal name of an inner class (see Type.getInternalName()).

outerName - the internal name of the class to which the inner class belongs (see Type.getInternalName()). May be null for not member classes.

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.

visitRecordComponent

public Printer visitRecordComponent(String name,
 String descriptor,
 String signature)

Visits a record component of the class. See ClassVisitor.visitRecordComponent(String, String, String).

Parameters:

name - the field's name.

descriptor - the record component descriptor (see Type).

signature - the record component signature. May be null if the record component type does not use generic types.

Returns:

a visitor to visit this record component annotations and attributes, or null if this class visitor is not interested in visiting these annotations and attributes.

visitField

public abstract Printer visitField(int access,
 String name,
 String descriptor,
 String signature,
 Object value)

Class field. See ClassVisitor.visitField(int, java.lang.String, java.lang.String, java.lang.String, java.lang.Object).

Parameters:

access - the field's access flags (see Opcodes). This parameter also indicates if the field is synthetic and/or deprecated.

name - the field's name.

descriptor - the field's descriptor (see Type).

signature - the field's signature. May be null if the field's type does not use generic types.

value - the field's initial value. This parameter, which may be null if the field does not have an initial value, must be an Integer, a Float, a Long, a Double or a 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.

Returns:

the printer.

visitMethod

public abstract Printer visitMethod(int access,
 String name,
 String descriptor,
 String signature,
 String[] exceptions)

Class method. See ClassVisitor.visitMethod(int, java.lang.String, java.lang.String, java.lang.String, java.lang.String[]).

Parameters:

access - the method's access flags (see Opcodes). This parameter also indicates if the method is synthetic and/or deprecated.

name - the method's name.

descriptor - the method's descriptor (see Type).

signature - the method's signature. May be null if the method parameters, return type and exceptions do not use generic types.

exceptions - the internal names of the method's exception classes (see Type.getInternalName()). May be null.

Returns:

the printer.

visitClassEnd

public abstract void visitClassEnd()

Class end. See ClassVisitor.visitEnd().

visitMainClass

public void visitMainClass(String mainClass)

Module main class. See ModuleVisitor.visitMainClass(java.lang.String).

Parameters:

mainClass - the internal name of the main class of the current module (see Type.getInternalName()).

visitPackage

public void visitPackage(String packaze)

Module package. See ModuleVisitor.visitPackage(java.lang.String).

Parameters:

packaze - the internal name of a package (see Type.getInternalName()).

visitRequire

public void visitRequire(String module,
 int access,
 String version)

Module require. See ModuleVisitor.visitRequire(java.lang.String, int, java.lang.String).

Parameters:

module - the fully qualified name (using dots) of the dependence.

access - the access flag of the dependence among ACC_TRANSITIVE, ACC_STATIC_PHASE, ACC_SYNTHETIC and ACC_MANDATED.

version - the module version at compile time, or null.

visitExport

public void visitExport(String packaze,
 int access,
 String... modules)

Module export. See ModuleVisitor.visitExport(java.lang.String, int, java.lang.String...).

Parameters:

packaze - the internal name of the exported package (see Type.getInternalName()).

access - the access flag of the exported package, valid values are among ACC_SYNTHETIC and ACC_MANDATED.

modules - the fully qualified names (using dots) of the modules that can access the public classes of the exported package, or null.

visitOpen

public void visitOpen(String packaze,
 int access,
 String... modules)

Module open. See ModuleVisitor.visitOpen(java.lang.String, int, java.lang.String...).

Parameters:

packaze - the internal name of the opened package (see Type.getInternalName()).

access - the access flag of the opened package, valid values are among ACC_SYNTHETIC and ACC_MANDATED.

modules - the fully qualified names (using dots) of the modules that can use deep reflection to the classes of the open package, or null.

visitUse

public void visitUse(String service)

Module use. See ModuleVisitor.visitUse(java.lang.String).

Parameters:

service - the internal name of the service (see Type.getInternalName()).

visitProvide

public void visitProvide(String service,
 String... providers)

Module provide. See ModuleVisitor.visitProvide(java.lang.String, java.lang.String...).

Parameters:

service - the internal name of the service (see Type.getInternalName()).

providers - the internal names of the implementations of the service (there is at least one provider).

visitModuleEnd

public void visitModuleEnd()

Module end. See ModuleVisitor.visitEnd().

visit

public abstract void visit(String name,
 Object value)

Annotation value. See AnnotationVisitor.visit(java.lang.String, java.lang.Object).

Parameters:

name - the value name.

value - the actual value, whose type must be Byte, Boolean, Character, Short, Integer , Long, Float, Double, String or Type of Type.OBJECT or Type.ARRAY sort. This value can also be an array of byte, boolean, short, char, int, long, float or double values (this is equivalent to using visitArray(java.lang.String) and visiting each array element in turn, but is more convenient).

visitEnum

public abstract void visitEnum(String name,
 String descriptor,
 String value)

Annotation enum value. See AnnotationVisitor.visitEnum(java.lang.String, java.lang.String, java.lang.String).

Parameters:

name - the value name.

descriptor - the class descriptor of the enumeration class.

value - the actual enumeration value.

visitAnnotation

public abstract Printer visitAnnotation(String name,
 String descriptor)

Nested annotation value. See AnnotationVisitor.visitAnnotation(java.lang.String, java.lang.String).

Parameters:

name - the value name.

descriptor - the class descriptor of the nested annotation class.

Returns:

the printer.

visitArray

public abstract Printer visitArray(String name)

Annotation array value. See AnnotationVisitor.visitArray(java.lang.String).

Parameters:

name - the value name.

Returns:

the printer.

visitAnnotationEnd

public abstract void visitAnnotationEnd()

Annotation end. See AnnotationVisitor.visitEnd().

visitRecordComponentAnnotation

public Printer visitRecordComponentAnnotation(String descriptor,
 boolean visible)

Visits an annotation of the record component. See RecordComponentVisitor.visitAnnotation(java.lang.String, boolean).

Parameters:

descriptor - the class descriptor of the annotation class.

visible - true if the annotation is visible at runtime.

Returns:

a visitor to visit the annotation values, or null if this visitor is not interested in visiting this annotation.

visitRecordComponentTypeAnnotation

public Printer visitRecordComponentTypeAnnotation(int typeRef,
 TypePath typePath,
 String descriptor,
 boolean visible)

Visits an annotation on a type in the record component signature. See RecordComponentVisitor.visitTypeAnnotation(int, org.objectweb.asm.TypePath, java.lang.String, boolean).

Parameters:

typeRef - a reference to the annotated type. The sort of this type reference must be TypeReference.CLASS_TYPE_PARAMETER, TypeReference.CLASS_TYPE_PARAMETER_BOUND or TypeReference.CLASS_EXTENDS. See TypeReference.

typePath - the path to the annotated type argument, wildcard bound, array element type, or static inner type within 'typeRef'. May be null if the annotation targets 'typeRef' as a whole.

descriptor - the class descriptor of the annotation class.

visible - true if the annotation is visible at runtime.

Returns:

a visitor to visit the annotation values, or null if this visitor is not interested in visiting this annotation.

visitRecordComponentAttribute

public void visitRecordComponentAttribute(Attribute attribute)

Visits a non standard attribute of the record component. See RecordComponentVisitor.visitAttribute(org.objectweb.asm.Attribute).

Parameters:

attribute - an attribute.

visitRecordComponentEnd

public void visitRecordComponentEnd()

Visits the end of the record component. See RecordComponentVisitor.visitEnd(). This method, which is the last one to be called, is used to inform the visitor that everything have been visited.

visitFieldAnnotation

public abstract Printer visitFieldAnnotation(String descriptor,
 boolean visible)

Field annotation. See FieldVisitor.visitAnnotation(java.lang.String, boolean).

Parameters:

descriptor - the class descriptor of the annotation class.

visible - true if the annotation is visible at runtime.

Returns:

the printer.

visitFieldTypeAnnotation

public Printer visitFieldTypeAnnotation(int typeRef,
 TypePath typePath,
 String descriptor,
 boolean visible)

Field type annotation. See FieldVisitor.visitTypeAnnotation(int, org.objectweb.asm.TypePath, java.lang.String, boolean).

Parameters:

typeRef - a reference to the annotated type. The sort of this type reference must be TypeReference.FIELD. See TypeReference.

typePath - the path to the annotated type argument, wildcard bound, array element type, or static inner type within 'typeRef'. May be null if the annotation targets 'typeRef' as a whole.

descriptor - the class descriptor of the annotation class.

visible - true if the annotation is visible at runtime.

Returns:

the printer.

visitFieldAttribute

public abstract void visitFieldAttribute(Attribute attribute)

Field attribute. See FieldVisitor.visitAttribute(org.objectweb.asm.Attribute).

Parameters:

attribute - an attribute.

visitFieldEnd

public abstract void visitFieldEnd()

Field end. See FieldVisitor.visitEnd().

visitParameter

public void visitParameter(String name,
 int access)

Method parameter. See MethodVisitor.visitParameter(String, int).

Parameters:

name - parameter name or null if none is provided.

access - the parameter's access flags, only ACC_FINAL, ACC_SYNTHETIC or/and ACC_MANDATED are allowed (see Opcodes).

visitAnnotationDefault

public abstract Printer visitAnnotationDefault()

Method default annotation. See MethodVisitor.visitAnnotationDefault().

Returns:

the printer.

visitMethodAnnotation

public abstract Printer visitMethodAnnotation(String descriptor,
 boolean visible)

Method annotation. See MethodVisitor.visitAnnotation(java.lang.String, boolean).

Parameters:

descriptor - the class descriptor of the annotation class.

visible - true if the annotation is visible at runtime.

Returns:

the printer.

visitMethodTypeAnnotation

public Printer visitMethodTypeAnnotation(int typeRef,
 TypePath typePath,
 String descriptor,
 boolean visible)

Method type annotation. See MethodVisitor.visitTypeAnnotation(int, org.objectweb.asm.TypePath, java.lang.String, boolean).

Parameters:

typeRef - a reference to the annotated type. The sort of this type reference must be TypeReference.METHOD_TYPE_PARAMETER, TypeReference.METHOD_TYPE_PARAMETER_BOUND, TypeReference.METHOD_RETURN, TypeReference.METHOD_RECEIVER, TypeReference.METHOD_FORMAL_PARAMETER or TypeReference.THROWS. See TypeReference.

typePath - the path to the annotated type argument, wildcard bound, array element type, or static inner type within 'typeRef'. May be null if the annotation targets 'typeRef' as a whole.

descriptor - the class descriptor of the annotation class.

visible - true if the annotation is visible at runtime.

Returns:

the printer.

visitAnnotableParameterCount

public Printer visitAnnotableParameterCount(int parameterCount,
 boolean visible)

Number of method parameters that can have annotations. See MethodVisitor.visitAnnotableParameterCount(int, boolean).

Parameters:

parameterCount - the number of method parameters than can have annotations. This number must be less or equal than the number of parameter types in the method descriptor. It can be strictly less when a method has synthetic parameters and when these parameters are ignored when computing parameter indices for the purpose of parameter annotations (see https://docs.oracle.com/javase/specs/jvms/se9/html/jvms-4.html#jvms-4.7.18).

visible - true to define the number of method parameters that can have annotations visible at runtime, false to define the number of method parameters that can have annotations invisible at runtime.

Returns:

the printer.

visitParameterAnnotation

public abstract Printer visitParameterAnnotation(int parameter,
 String descriptor,
 boolean visible)

Method parameter annotation. See MethodVisitor.visitParameterAnnotation(int, java.lang.String, boolean).

Parameters:

parameter - the parameter index. This index must be strictly smaller than the number of parameters in the method descriptor, and strictly smaller than the parameter count specified in visitAnnotableParameterCount(int, boolean). Important note: a parameter index i is not required to correspond to the i'th parameter descriptor in the method descriptor, in particular in case of synthetic parameters (see https://docs.oracle.com/javase/specs/jvms/se9/html/jvms-4.html#jvms-4.7.18).

descriptor - the class descriptor of the annotation class.

visible - true if the annotation is visible at runtime.

Returns:

the printer.

visitMethodAttribute

public abstract void visitMethodAttribute(Attribute attribute)

Method attribute. See MethodVisitor.visitAttribute(org.objectweb.asm.Attribute).

Parameters:

attribute - an attribute.

visitCode

public abstract void visitCode()

Method start. See MethodVisitor.visitCode().

visitFrame

public abstract void visitFrame(int type,
 int numLocal,
 Object[] local,
 int numStack,
 Object[] stack)

Method stack frame. See MethodVisitor.visitFrame(int, int, java.lang.Object[], int, java.lang.Object[]).

Parameters:

type - the type of this stack map frame. Must be Opcodes.F_NEW for expanded frames, or Opcodes.F_FULL, Opcodes.F_APPEND, Opcodes.F_CHOP, Opcodes.F_SAME or Opcodes.F_APPEND, Opcodes.F_SAME1 for compressed frames.

numLocal - the number of local variables in the visited frame.

local - the local variable types in this frame. This array must not be modified. Primitive types are represented by Opcodes.TOP, Opcodes.INTEGER, Opcodes.FLOAT, Opcodes.LONG, Opcodes.DOUBLE, Opcodes.NULL or Opcodes.UNINITIALIZED_THIS (long and double are represented by a single element). Reference types are represented by String objects (representing internal names, see Type.getInternalName()), and uninitialized types by Label objects (this label designates the NEW instruction that created this uninitialized value).

numStack - the number of operand stack elements in the visited frame.

stack - the operand stack types in this frame. This array must not be modified. Its content has the same format as the "local" array.

visitInsn

public abstract void visitInsn(int opcode)

Method instruction. See MethodVisitor.visitInsn(int)

Parameters:

opcode - the opcode of the instruction to be visited. This opcode is either NOP, ACONST_NULL, ICONST_M1, ICONST_0, ICONST_1, ICONST_2, ICONST_3, ICONST_4, ICONST_5, LCONST_0, LCONST_1, FCONST_0, FCONST_1, FCONST_2, DCONST_0, DCONST_1, IALOAD, LALOAD, FALOAD, DALOAD, AALOAD, BALOAD, CALOAD, SALOAD, IASTORE, LASTORE, FASTORE, DASTORE, AASTORE, BASTORE, CASTORE, SASTORE, POP, POP2, DUP, DUP_X1, DUP_X2, DUP2, DUP2_X1, DUP2_X2, SWAP, IADD, LADD, FADD, DADD, ISUB, LSUB, FSUB, DSUB, IMUL, LMUL, FMUL, DMUL, IDIV, LDIV, FDIV, DDIV, IREM, LREM, FREM, DREM, INEG, LNEG, FNEG, DNEG, ISHL, LSHL, ISHR, LSHR, IUSHR, LUSHR, IAND, LAND, IOR, LOR, IXOR, LXOR, I2L, I2F, I2D, L2I, L2F, L2D, F2I, F2L, F2D, D2I, D2L, D2F, I2B, I2C, I2S, LCMP, FCMPL, FCMPG, DCMPL, DCMPG, IRETURN, LRETURN, FRETURN, DRETURN, ARETURN, RETURN, ARRAYLENGTH, ATHROW, MONITORENTER, or MONITOREXIT.

visitIntInsn

public abstract void visitIntInsn(int opcode,
 int operand)

Method instruction. See MethodVisitor.visitIntInsn(int, int).

Parameters:

opcode - the opcode of the instruction to be visited. This opcode is either BIPUSH, SIPUSH or NEWARRAY.

operand - the operand of the instruction to be visited.
When opcode is BIPUSH, operand value should be between Byte.MIN_VALUE and Byte.MAX_VALUE.
When opcode is SIPUSH, operand value should be between Short.MIN_VALUE and Short.MAX_VALUE.
When opcode is NEWARRAY, operand value should be one of Opcodes.T_BOOLEAN, Opcodes.T_CHAR, Opcodes.T_FLOAT, Opcodes.T_DOUBLE, Opcodes.T_BYTE, Opcodes.T_SHORT, Opcodes.T_INT or Opcodes.T_LONG.

visitVarInsn

public abstract void visitVarInsn(int opcode,
 int varIndex)

Method instruction. See MethodVisitor.visitVarInsn(int, int).

Parameters:

opcode - the opcode of the local variable instruction to be visited. This opcode is either ILOAD, LLOAD, FLOAD, DLOAD, ALOAD, ISTORE, LSTORE, FSTORE, DSTORE, ASTORE or RET.

varIndex - the operand of the instruction to be visited. This operand is the index of a local variable.

visitTypeInsn

public abstract void visitTypeInsn(int opcode,
 String type)

Method instruction. See MethodVisitor.visitTypeInsn(int, java.lang.String).

Parameters:

opcode - the opcode of the type instruction to be visited. This opcode is either NEW, ANEWARRAY, CHECKCAST or INSTANCEOF.

type - the operand of the instruction to be visited. This operand must be the internal name of an object or array class (see Type.getInternalName()).

visitFieldInsn

public abstract void visitFieldInsn(int opcode,
 String owner,
 String name,
 String descriptor)

Method instruction. See MethodVisitor.visitFieldInsn(int, java.lang.String, java.lang.String, java.lang.String).

Parameters:

opcode - the opcode of the type instruction to be visited. This opcode is either GETSTATIC, PUTSTATIC, GETFIELD or PUTFIELD.

owner - the internal name of the field's owner class (see Type.getInternalName()).

name - the field's name.

descriptor - the field's descriptor (see Type).

visitMethodInsn

@Deprecated
public void visitMethodInsn(int opcode,
 String owner,
 String name,
 String descriptor)

Deprecated.

use visitMethodInsn(int, String, String, String, boolean) instead.

Method instruction. See MethodVisitor.visitMethodInsn(int, java.lang.String, java.lang.String, java.lang.String).

Parameters:

opcode - the opcode of the type instruction to be visited. This opcode is either INVOKEVIRTUAL, INVOKESPECIAL, INVOKESTATIC or INVOKEINTERFACE.

owner - the internal name of the method's owner class (see Type.getInternalName()).

name - the method's name.

descriptor - the method's descriptor (see Type).

visitMethodInsn

public void visitMethodInsn(int opcode,
 String owner,
 String name,
 String descriptor,
 boolean isInterface)

Method instruction. See MethodVisitor.visitMethodInsn(int, java.lang.String, java.lang.String, java.lang.String).

Parameters:

opcode - the opcode of the type instruction to be visited. This opcode is either INVOKEVIRTUAL, INVOKESPECIAL, INVOKESTATIC or INVOKEINTERFACE.

owner - the internal name of the method's owner class (see Type.getInternalName()).

name - the method's name.

descriptor - the method's descriptor (see Type).

isInterface - if the method's owner class is an interface.

visitInvokeDynamicInsn

public abstract void visitInvokeDynamicInsn(String name,
 String descriptor,
 Handle bootstrapMethodHandle,
 Object... bootstrapMethodArguments)

Method instruction. See MethodVisitor.visitInvokeDynamicInsn(java.lang.String, java.lang.String, org.objectweb.asm.Handle, java.lang.Object...).

Parameters:

name - the method's name.

descriptor - the method's descriptor (see Type).

bootstrapMethodHandle - the bootstrap method.

bootstrapMethodArguments - the bootstrap method constant arguments. Each argument must be an Integer, Float, Long, Double, String, Type or Handle value. This method is allowed to modify the content of the array so a caller should expect that this array may change.

visitJumpInsn

public abstract void visitJumpInsn(int opcode,
 Label label)

Method jump instruction. See MethodVisitor.visitJumpInsn(int, org.objectweb.asm.Label).

Parameters:

opcode - the opcode of the type instruction to be visited. This opcode is either IFEQ, IFNE, IFLT, IFGE, IFGT, IFLE, IF_ICMPEQ, IF_ICMPNE, IF_ICMPLT, IF_ICMPGE, IF_ICMPGT, IF_ICMPLE, IF_ACMPEQ, IF_ACMPNE, GOTO, JSR, IFNULL or IFNONNULL.

label - the operand of the instruction to be visited. This operand is a label that designates the instruction to which the jump instruction may jump.

visitLabel

public abstract void visitLabel(Label label)

Method label. See MethodVisitor.visitLabel(org.objectweb.asm.Label).

Parameters:

label - a Label object.

visitLdcInsn

public abstract void visitLdcInsn(Object value)

Method instruction. See MethodVisitor.visitLdcInsn(java.lang.Object).

Parameters:

value - the constant to be loaded on the stack. This parameter must be a non null Integer, a Float, a Long, a Double, a String, a Type of OBJECT or ARRAY sort for .class constants, for classes whose version is 49, a Type of METHOD sort for MethodType, a Handle for MethodHandle constants, for classes whose version is 51 or a ConstantDynamic for a constant dynamic for classes whose version is 55.

visitIincInsn

public abstract void visitIincInsn(int varIndex,
 int increment)

Method instruction. See MethodVisitor.visitIincInsn(int, int).

Parameters:

varIndex - index of the local variable to be incremented.

increment - amount to increment the local variable by.

visitTableSwitchInsn

public abstract void visitTableSwitchInsn(int min,
 int max,
 Label dflt,
 Label... labels)

Method instruction. See MethodVisitor.visitTableSwitchInsn(int, int, org.objectweb.asm.Label, org.objectweb.asm.Label...).

Parameters:

min - the minimum key value.

max - the maximum key value.

dflt - beginning of the default handler block.

labels - beginnings of the handler blocks. labels[i] is the beginning of the handler block for the min + i key.

visitLookupSwitchInsn

public abstract void visitLookupSwitchInsn(Label dflt,
 int[] keys,
 Label[] labels)

Method instruction. See MethodVisitor.visitLookupSwitchInsn(org.objectweb.asm.Label, int[], org.objectweb.asm.Label[]).

Parameters:

dflt - beginning of the default handler block.

keys - the values of the keys.

labels - beginnings of the handler blocks. labels[i] is the beginning of the handler block for the keys[i] key.

visitMultiANewArrayInsn

public abstract void visitMultiANewArrayInsn(String descriptor,
 int numDimensions)

Method instruction. See MethodVisitor.visitMultiANewArrayInsn(java.lang.String, int).

Parameters:

descriptor - an array type descriptor (see Type).

numDimensions - the number of dimensions of the array to allocate.

visitInsnAnnotation

public Printer visitInsnAnnotation(int typeRef,
 TypePath typePath,
 String descriptor,
 boolean visible)

Instruction type annotation. See MethodVisitor.visitInsnAnnotation(int, org.objectweb.asm.TypePath, java.lang.String, boolean).

Parameters:

typeRef - a reference to the annotated type. The sort of this type reference must be TypeReference.INSTANCEOF, TypeReference.NEW, TypeReference.CONSTRUCTOR_REFERENCE, TypeReference.METHOD_REFERENCE, TypeReference.CAST, TypeReference.CONSTRUCTOR_INVOCATION_TYPE_ARGUMENT, TypeReference.METHOD_INVOCATION_TYPE_ARGUMENT, TypeReference.CONSTRUCTOR_REFERENCE_TYPE_ARGUMENT, or TypeReference.METHOD_REFERENCE_TYPE_ARGUMENT. See TypeReference.

typePath - the path to the annotated type argument, wildcard bound, array element type, or static inner type within 'typeRef'. May be null if the annotation targets 'typeRef' as a whole.

descriptor - the class descriptor of the annotation class.

visible - true if the annotation is visible at runtime.

Returns:

the printer.

visitTryCatchBlock

public abstract void visitTryCatchBlock(Label start,
 Label end,
 Label handler,
 String type)

Method exception handler. See MethodVisitor.visitTryCatchBlock(org.objectweb.asm.Label, org.objectweb.asm.Label, org.objectweb.asm.Label, java.lang.String).

Parameters:

start - the beginning of the exception handler's scope (inclusive).

end - the end of the exception handler's scope (exclusive).

handler - the beginning of the exception handler's code.

type - the internal name of the type of exceptions handled by the handler (see Type.getInternalName()), or null to catch any exceptions (for "finally" blocks).

visitTryCatchAnnotation

public Printer visitTryCatchAnnotation(int typeRef,
 TypePath typePath,
 String descriptor,
 boolean visible)

Try catch block type annotation. See MethodVisitor.visitTryCatchAnnotation(int, org.objectweb.asm.TypePath, java.lang.String, boolean).

Parameters:

typeRef - a reference to the annotated type. The sort of this type reference must be TypeReference.EXCEPTION_PARAMETER. See TypeReference.

typePath - the path to the annotated type argument, wildcard bound, array element type, or static inner type within 'typeRef'. May be null if the annotation targets 'typeRef' as a whole.

descriptor - the class descriptor of the annotation class.

visible - true if the annotation is visible at runtime.

Returns:

the printer.

visitLocalVariable

public abstract void visitLocalVariable(String name,
 String descriptor,
 String signature,
 Label start,
 Label end,
 int index)

Method debug info. See MethodVisitor.visitLocalVariable(java.lang.String, java.lang.String, java.lang.String, org.objectweb.asm.Label, org.objectweb.asm.Label, int).

Parameters:

name - the name of a local variable.

descriptor - the type descriptor of this local variable.

signature - the type signature of this local variable. May be null if the local variable type does not use generic types.

start - the first instruction corresponding to the scope of this local variable (inclusive).

end - the last instruction corresponding to the scope of this local variable (exclusive).

index - the local variable's index.

visitLocalVariableAnnotation

public Printer visitLocalVariableAnnotation(int typeRef,
 TypePath typePath,
 Label[] start,
 Label[] end,
 int[] index,
 String descriptor,
 boolean visible)

Local variable type annotation. See MethodVisitor.visitTryCatchAnnotation(int, org.objectweb.asm.TypePath, java.lang.String, boolean).

Parameters:

typeRef - a reference to the annotated type. The sort of this type reference must be TypeReference.LOCAL_VARIABLE or TypeReference.RESOURCE_VARIABLE. See TypeReference.

typePath - the path to the annotated type argument, wildcard bound, array element type, or static inner type within 'typeRef'. May be null if the annotation targets 'typeRef' as a whole.

start - the fist instructions corresponding to the continuous ranges that make the scope of this local variable (inclusive).

end - the last instructions corresponding to the continuous ranges that make the scope of this local variable (exclusive). This array must have the same size as the 'start' array.

index - the local variable's index in each range. This array must have the same size as the 'start' array.

descriptor - the class descriptor of the annotation class.

visible - true if the annotation is visible at runtime.

Returns:

the printer.

visitLineNumber

public abstract void visitLineNumber(int line,
 Label start)

Method debug info. See MethodVisitor.visitLineNumber(int, org.objectweb.asm.Label).

Parameters:

line - a line number. This number refers to the source file from which the class was compiled.

start - the first instruction corresponding to this line number.

visitMaxs

public abstract void visitMaxs(int maxStack,
 int maxLocals)

Method max stack and max locals. See MethodVisitor.visitMaxs(int, int).

Parameters:

maxStack - maximum stack size of the method.

maxLocals - maximum number of local variables for the method.

visitMethodEnd

public abstract void visitMethodEnd()

Method end. See MethodVisitor.visitEnd().

getText

public List<Object> getText()

Returns the text constructed by this visitor.

Returns:

the text constructed by this visitor. See text.

print

public void print(PrintWriter printWriter)

Prints the text constructed by this visitor.

Parameters:

printWriter - the print writer to be used.

appendString

public static void appendString(StringBuilder stringBuilder,
 String string)

Appends a quoted string to the given string builder.

Parameters:

stringBuilder - the buffer where the string must be added.

string - the string to be added.