public class ClassWriter extends ClassVisitor
ClassVisitor that generates a corresponding ClassFile structure, as defined in the Java
Virtual Machine Specification (JVMS). It can be used alone, to generate a Java class "from
scratch", or with one or more ClassReader and adapter ClassVisitor to generate a
modified class from one or more existing Java classes.| 限定符和类型 | 字段和说明 |
|---|---|
private int |
accessFlags
The access_flags field of the JVMS ClassFile structure.
|
private int |
compute
Indicates what must be automatically computed in
MethodWriter. |
static int |
COMPUTE_FRAMES
A flag to automatically compute the stack map frames of methods from scratch.
|
static int |
COMPUTE_MAXS
A flag to automatically compute the maximum stack size and the maximum number of local
variables of methods.
|
private ByteVector |
debugExtension
The debug_extension field of the SourceDebugExtension attribute, or null.
|
private int |
enclosingClassIndex
The class_index field of the EnclosingMethod attribute, or 0.
|
private int |
enclosingMethodIndex
The method_index field of the EnclosingMethod attribute.
|
private Attribute |
firstAttribute
The first non standard attribute of this class.
|
private FieldWriter |
firstField
The fields of this class, stored in a linked list of
FieldWriter linked via their
FieldVisitor.fv field. |
private MethodWriter |
firstMethod
The methods of this class, stored in a linked list of
MethodWriter linked via their
MethodVisitor.mv field. |
private RecordComponentWriter |
firstRecordComponent
The record components of this class, stored in a linked list of
RecordComponentWriter
linked via their RecordComponentVisitor.delegate field. |
private ByteVector |
innerClasses
The 'classes' array of the InnerClasses attribute, or null.
|
private int |
interfaceCount
The interface_count field of the JVMS ClassFile structure.
|
private int[] |
interfaces
The 'interfaces' array of the JVMS ClassFile structure.
|
private FieldWriter |
lastField
The fields of this class, stored in a linked list of
FieldWriter linked via their
FieldVisitor.fv field. |
private MethodWriter |
lastMethod
The methods of this class, stored in a linked list of
MethodWriter linked via their
MethodVisitor.mv field. |
private RecordComponentWriter |
lastRecordComponent
The record components of this class, stored in a linked list of
RecordComponentWriter
linked via their RecordComponentVisitor.delegate field. |
private AnnotationWriter |
lastRuntimeInvisibleAnnotation
The last runtime invisible annotation of this class.
|
private AnnotationWriter |
lastRuntimeInvisibleTypeAnnotation
The last runtime invisible type annotation of this class.
|
private AnnotationWriter |
lastRuntimeVisibleAnnotation
The last runtime visible annotation of this class.
|
private AnnotationWriter |
lastRuntimeVisibleTypeAnnotation
The last runtime visible type annotation of this class.
|
private ModuleWriter |
moduleWriter
The Module attribute of this class, or null.
|
private int |
nestHostClassIndex
The host_class_index field of the NestHost attribute, or 0.
|
private ByteVector |
nestMemberClasses
The 'classes' array of the NestMembers attribute, or null.
|
private int |
numberOfInnerClasses
The number_of_classes field of the InnerClasses attribute, or 0.
|
private int |
numberOfNestMemberClasses
The number_of_classes field of the NestMembers attribute, or 0.
|
private int |
numberOfPermittedSubclasses
The number_of_classes field of the PermittedSubclasses attribute, or 0.
|
private ByteVector |
permittedSubclasses
The 'classes' array of the PermittedSubclasses attribute, or null.
|
private int |
signatureIndex
The signature_index field of the Signature attribute, or 0.
|
private int |
sourceFileIndex
The source_file_index field of the SourceFile attribute, or 0.
|
private int |
superClass
The super_class field of the JVMS ClassFile structure.
|
private SymbolTable |
symbolTable
The symbol table for this class (contains the constant_pool and the BootstrapMethods).
|
private int |
thisClass
The this_class field of the JVMS ClassFile structure.
|
private int |
version
The minor_version and major_version fields of the JVMS ClassFile structure. minor_version is
stored in the 16 most significant bits, and major_version in the 16 least significant bits.
|
api, cv| 构造器和说明 |
|---|
ClassWriter(ClassReader classReader,
int flags)
Constructs a new
ClassWriter object and enables optimizations for "mostly add" bytecode
transformations. |
ClassWriter(int flags)
Constructs a new
ClassWriter object. |
| 限定符和类型 | 方法和说明 |
|---|---|
private Attribute[] |
getAttributePrototypes()
Returns the prototypes of the attributes used by this class, its fields and its methods.
|
protected ClassLoader |
getClassLoader()
Returns the
ClassLoader to be used by the default implementation of getCommonSuperClass(String, String), that of this ClassWriter's runtime type by
default. |
protected String |
getCommonSuperClass(String type1,
String type2)
Returns the common super type of the two given types.
|
int |
newClass(String value)
Adds a class reference to the constant pool of the class being build.
|
int |
newConst(Object value)
Adds a number or string constant to the constant pool of the class being build.
|
int |
newConstantDynamic(String name,
String descriptor,
Handle bootstrapMethodHandle,
Object... bootstrapMethodArguments)
Adds a dynamic constant reference to the constant pool of the class being build.
|
int |
newField(String owner,
String name,
String descriptor)
Adds a field reference to the constant pool of the class being build.
|
int |
newHandle(int tag,
String owner,
String name,
String descriptor)
已过时。
this method is superseded by
newHandle(int, String, String, String,
boolean). |
int |
newHandle(int tag,
String owner,
String name,
String descriptor,
boolean isInterface)
Adds a handle to the constant pool of the class being build.
|
int |
newInvokeDynamic(String name,
String descriptor,
Handle bootstrapMethodHandle,
Object... bootstrapMethodArguments)
Adds an invokedynamic reference to the constant pool of the class being build.
|
int |
newMethod(String owner,
String name,
String descriptor,
boolean isInterface)
Adds a method reference to the constant pool of the class being build.
|
int |
newMethodType(String methodDescriptor)
Adds a method type reference to the constant pool of the class being build.
|
int |
newModule(String moduleName)
Adds a module reference to the constant pool of the class being build.
|
int |
newNameType(String name,
String descriptor)
Adds a name and type to the constant pool of the class being build.
|
int |
newPackage(String packageName)
Adds a package reference to the constant pool of the class being build.
|
int |
newUTF8(String value)
Adds an UTF8 string to the constant pool of the class being build.
|
private byte[] |
replaceAsmInstructions(byte[] classFile,
boolean hasFrames)
Returns the equivalent of the given class file, with the ASM specific instructions replaced
with standard ones.
|
byte[] |
toByteArray()
Returns the content of the class file that was built by this ClassWriter.
|
void |
visit(int version,
int access,
String name,
String signature,
String superName,
String[] interfaces)
Visits the header of the class.
|
AnnotationVisitor |
visitAnnotation(String descriptor,
boolean visible)
Visits an annotation of the class.
|
void |
visitAttribute(Attribute attribute)
Visits a non standard attribute of the class.
|
void |
visitEnd()
Visits the end of the class.
|
FieldVisitor |
visitField(int access,
String name,
String descriptor,
String signature,
Object value)
Visits a field of the class.
|
void |
visitInnerClass(String name,
String outerName,
String innerName,
int access)
Visits information about an inner class.
|
MethodVisitor |
visitMethod(int access,
String name,
String descriptor,
String signature,
String[] exceptions)
Visits a method of the class.
|
ModuleVisitor |
visitModule(String name,
int access,
String version)
Visit the module corresponding to the class.
|
void |
visitNestHost(String nestHost)
Visits the nest host class of the class.
|
void |
visitNestMember(String nestMember)
Visits a member of the nest.
|
void |
visitOuterClass(String owner,
String name,
String descriptor)
Visits the enclosing class of the class.
|
void |
visitPermittedSubclass(String permittedSubclass)
Visits a permitted subclasses.
|
RecordComponentVisitor |
visitRecordComponent(String name,
String descriptor,
String signature)
Visits a record component of the class.
|
void |
visitSource(String file,
String debug)
Visits the source of the class.
|
AnnotationVisitor |
visitTypeAnnotation(int typeRef,
TypePath typePath,
String descriptor,
boolean visible)
Visits an annotation on a type in the class signature.
|
public static final int COMPUTE_MAXS
MethodVisitor.visitMaxs(int, int) method of the MethodVisitor returned by the visitMethod(int, java.lang.String, java.lang.String, java.lang.String, java.lang.String[]) method will be ignored, and computed automatically from the signature and the
bytecode of each method.
Note: for classes whose version is Opcodes.V1_7 of more, this option requires
valid stack map frames. The maximum stack size is then computed from these frames, and from the
bytecode instructions in between. If stack map frames are not present or must be recomputed,
used COMPUTE_FRAMES instead.
ClassWriter(int),
常量字段值public static final int COMPUTE_FRAMES
MethodVisitor.visitFrame(int, int, java.lang.Object[], int, java.lang.Object[]) method are ignored, and the stack
map frames are recomputed from the methods bytecode. The arguments of the MethodVisitor.visitMaxs(int, int) method are also ignored and recomputed from the bytecode. In other
words, COMPUTE_FRAMES implies COMPUTE_MAXS.ClassWriter(int),
常量字段值private int version
private final SymbolTable symbolTable
private int accessFlags
Opcodes.ACC_DEPRECATED or Opcodes.ACC_RECORD, which are
removed when generating the ClassFile structure.private int thisClass
private int superClass
private int interfaceCount
private int[] interfaces
private FieldWriter firstField
FieldWriter linked via their
FieldVisitor.fv field. This field stores the first element of this list.private FieldWriter lastField
FieldWriter linked via their
FieldVisitor.fv field. This field stores the last element of this list.private MethodWriter firstMethod
MethodWriter linked via their
MethodVisitor.mv field. This field stores the first element of this list.private MethodWriter lastMethod
MethodWriter linked via their
MethodVisitor.mv field. This field stores the last element of this list.private int numberOfInnerClasses
private ByteVector innerClasses
private int enclosingClassIndex
private int enclosingMethodIndex
private int signatureIndex
private int sourceFileIndex
private ByteVector debugExtension
private AnnotationWriter lastRuntimeVisibleAnnotation
AnnotationWriter.previousAnnotation field. May be null.private AnnotationWriter lastRuntimeInvisibleAnnotation
AnnotationWriter.previousAnnotation field. May be null.private AnnotationWriter lastRuntimeVisibleTypeAnnotation
AnnotationWriter.previousAnnotation field. May be null.private AnnotationWriter lastRuntimeInvisibleTypeAnnotation
AnnotationWriter.previousAnnotation field. May be null.private ModuleWriter moduleWriter
private int nestHostClassIndex
private int numberOfNestMemberClasses
private ByteVector nestMemberClasses
private int numberOfPermittedSubclasses
private ByteVector permittedSubclasses
private RecordComponentWriter firstRecordComponent
RecordComponentWriter
linked via their RecordComponentVisitor.delegate field. This field stores the first
element of this list.private RecordComponentWriter lastRecordComponent
RecordComponentWriter
linked via their RecordComponentVisitor.delegate field. This field stores the last
element of this list.private Attribute firstAttribute
Attribute.nextAttribute field. May be null.
WARNING: this list stores the attributes in the reverse order of their visit.
firstAttribute is actually the last attribute visited in visitAttribute(com.fastchar.asm.org.objectweb.Attribute). The toByteArray() method writes the attributes in the order defined by this list, i.e. in the
reverse order specified by the user.
private int compute
MethodWriter. Must be one of MethodWriter.COMPUTE_NOTHING, MethodWriter.COMPUTE_MAX_STACK_AND_LOCAL, MethodWriter.COMPUTE_INSERTED_FRAMES, or MethodWriter.COMPUTE_ALL_FRAMES.public ClassWriter(int flags)
ClassWriter object.flags - option flags that can be used to modify the default behavior of this class. Must
be zero or more of COMPUTE_MAXS and COMPUTE_FRAMES.public ClassWriter(ClassReader classReader, int flags)
ClassWriter object and enables optimizations for "mostly add" bytecode
transformations. These optimizations are the following:
ClassReader receives MethodVisitor objects that come
from a ClassWriter (and not from any other ClassVisitor instance).
classReader - the ClassReader used to read the original class. It will be used to
copy the entire constant pool and bootstrap methods from the original class and also to
copy other fragments of original bytecode where applicable.flags - option flags that can be used to modify the default behavior of this class.Must be
zero or more of COMPUTE_MAXS and COMPUTE_FRAMES. These option flags do
not affect methods that are copied as is in the new class. This means that neither the
maximum stack size nor the stack frames will be computed for these methods.public final void visit(int version,
int access,
String name,
String signature,
String superName,
String[] interfaces)
ClassVisitorvisit 在类中 ClassVisitorversion - 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 Opcodes.ACC_DEPRECATED or a record Opcodes.ACC_RECORD.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.public final void visitSource(String file, String debug)
ClassVisitorvisitSource 在类中 ClassVisitorfile - 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.public final ModuleVisitor visitModule(String name, int access, String version)
ClassVisitorvisitModule 在类中 ClassVisitorname - 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.public final void visitNestHost(String nestHost)
ClassVisitorvisitNestHost 在类中 ClassVisitornestHost - the internal name of the host class of the nest.public final void visitOuterClass(String owner, String name, String descriptor)
ClassVisitorvisitOuterClass 在类中 ClassVisitorowner - internal name of the enclosing class of the class.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.public final AnnotationVisitor visitAnnotation(String descriptor, boolean visible)
ClassVisitorvisitAnnotation 在类中 ClassVisitordescriptor - the class descriptor of the annotation class.visible - true if the annotation is visible at runtime.public final AnnotationVisitor visitTypeAnnotation(int typeRef, TypePath typePath, String descriptor, boolean visible)
ClassVisitorvisitTypeAnnotation 在类中 ClassVisitortypeRef - 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.public final void visitAttribute(Attribute attribute)
ClassVisitorvisitAttribute 在类中 ClassVisitorattribute - an attribute.public final void visitNestMember(String nestMember)
ClassVisitorvisitNestMember 在类中 ClassVisitornestMember - the internal name of a nest member.public final void visitPermittedSubclass(String permittedSubclass)
ClassVisitorvisitPermittedSubclass 在类中 ClassVisitorpermittedSubclass - the internal name of a permitted subclass.public final void visitInnerClass(String name, String outerName, String innerName, int access)
ClassVisitorvisitInnerClass 在类中 ClassVisitorname - 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.public final RecordComponentVisitor visitRecordComponent(String name, String descriptor, String signature)
ClassVisitorvisitRecordComponent 在类中 ClassVisitorname - the record component 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.public final FieldVisitor visitField(int access, String name, String descriptor, String signature, Object value)
ClassVisitorvisitField 在类中 ClassVisitoraccess - 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.public final MethodVisitor visitMethod(int access, String name, String descriptor, String signature, String[] exceptions)
ClassVisitorMethodVisitor
instance (or null) each time it is called, i.e., it should not return a previously
returned visitor.visitMethod 在类中 ClassVisitoraccess - 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.public final void visitEnd()
ClassVisitorvisitEnd 在类中 ClassVisitorpublic byte[] toByteArray()
ClassTooLargeException - if the constant pool of the class is too large.MethodTooLargeException - if the Code attribute of a method is too large.private byte[] replaceAsmInstructions(byte[] classFile,
boolean hasFrames)
classFile - a class file containing ASM specific instructions, generated by this
ClassWriter.hasFrames - whether there is at least one stack map frames in 'classFile'.private Attribute[] getAttributePrototypes()
public int newConst(Object value)
Attribute sub classes, and is normally not needed by class generators or adapters.public int newUTF8(String value)
Attribute sub
classes, and is normally not needed by class generators or adapters.value - the String value.public int newClass(String value)
Attribute
sub classes, and is normally not needed by class generators or adapters.value - the internal name of the class.public int newMethodType(String methodDescriptor)
Attribute
sub classes, and is normally not needed by class generators or adapters.methodDescriptor - method descriptor of the method type.public int newModule(String moduleName)
Attribute
sub classes, and is normally not needed by class generators or adapters.moduleName - name of the module.public int newPackage(String packageName)
Attribute
sub classes, and is normally not needed by class generators or adapters.packageName - name of the package in its internal form.@Deprecated public int newHandle(int tag, String owner, String name, String descriptor)
newHandle(int, String, String, String,
boolean).Attribute sub classes,
and is normally not needed by class generators or adapters.tag - the kind of this handle. Must be Opcodes.H_GETFIELD, Opcodes.H_GETSTATIC, Opcodes.H_PUTFIELD, Opcodes.H_PUTSTATIC, Opcodes.H_INVOKEVIRTUAL, Opcodes.H_INVOKESTATIC, Opcodes.H_INVOKESPECIAL,
Opcodes.H_NEWINVOKESPECIAL or Opcodes.H_INVOKEINTERFACE.owner - the internal name of the field or method owner class.name - the name of the field or method.descriptor - the descriptor of the field or method.public int newHandle(int tag,
String owner,
String name,
String descriptor,
boolean isInterface)
Attribute sub classes,
and is normally not needed by class generators or adapters.tag - the kind of this handle. Must be Opcodes.H_GETFIELD, Opcodes.H_GETSTATIC, Opcodes.H_PUTFIELD, Opcodes.H_PUTSTATIC, Opcodes.H_INVOKEVIRTUAL, Opcodes.H_INVOKESTATIC, Opcodes.H_INVOKESPECIAL,
Opcodes.H_NEWINVOKESPECIAL or Opcodes.H_INVOKEINTERFACE.owner - the internal name of the field or method owner class.name - the name of the field or method.descriptor - the descriptor of the field or method.isInterface - true if the owner is an interface.public int newConstantDynamic(String name, String descriptor, Handle bootstrapMethodHandle, Object... bootstrapMethodArguments)
Attribute sub classes, and is normally not needed by class generators or adapters.name - name of the invoked method.descriptor - field descriptor of the constant type.bootstrapMethodHandle - the bootstrap method.bootstrapMethodArguments - the bootstrap method constant arguments.public int newInvokeDynamic(String name, String descriptor, Handle bootstrapMethodHandle, Object... bootstrapMethodArguments)
Attribute sub classes, and is normally not needed by class generators or adapters.name - name of the invoked method.descriptor - descriptor of the invoke method.bootstrapMethodHandle - the bootstrap method.bootstrapMethodArguments - the bootstrap method constant arguments.public int newField(String owner, String name, String descriptor)
Attribute
sub classes, and is normally not needed by class generators or adapters.owner - the internal name of the field's owner class.name - the field's name.descriptor - the field's descriptor.public int newMethod(String owner, String name, String descriptor, boolean isInterface)
Attribute
sub classes, and is normally not needed by class generators or adapters.owner - the internal name of the method's owner class.name - the method's name.descriptor - the method's descriptor.isInterface - true if owner is an interface.public int newNameType(String name, String descriptor)
Attribute
sub classes, and is normally not needed by class generators or adapters.name - a name.descriptor - a type descriptor.protected String getCommonSuperClass(String type1, String type2)
type1 - the internal name of a class.type2 - the internal name of another class.protected ClassLoader getClassLoader()
ClassLoader to be used by the default implementation of getCommonSuperClass(String, String), that of this ClassWriter's runtime type by
default.Copyright © 2021. All rights reserved.