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.Modifier and Type | Field and Description |
---|---|
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.
|
api, cv
Constructor and Description |
---|
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. |
Modifier and Type | Method and Description |
---|---|
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.
|
boolean |
hasFlags(int flags)
Returns true if all the given flags were passed to the constructor.
|
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)
Deprecated.
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.
|
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.
|
getDelegate
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)
,
Constant Field Valuespublic 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)
,
Constant Field Valuespublic 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 boolean hasFlags(int flags)
flags
- some option flags. Must be zero or more of COMPUTE_MAXS
and COMPUTE_FRAMES
.public final void visit(int version, int access, String name, String signature, String superName, String[] interfaces)
ClassVisitor
visit
in class ClassVisitor
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 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)
ClassVisitor
visitSource
in class ClassVisitor
file
- 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)
ClassVisitor
visitModule
in class ClassVisitor
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.public final void visitNestHost(String nestHost)
ClassVisitor
visitNestHost
in class ClassVisitor
nestHost
- the internal name of the host class of the nest (see Type.getInternalName()
).public final void visitOuterClass(String owner, String name, String descriptor)
ClassVisitor
visitOuterClass
in class ClassVisitor
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 or constructor of its enclosing class (e.g. if it is enclosed in
an instance initializer, static initializer, instance variable initializer, or class
variable initializer).descriptor
- the descriptor of the method that contains the class, or null if
the class is not enclosed in a method or constructor of its enclosing class (e.g. if it is
enclosed in an instance initializer, static initializer, instance variable initializer, or
class variable initializer).public final AnnotationVisitor visitAnnotation(String descriptor, boolean visible)
ClassVisitor
visitAnnotation
in class ClassVisitor
descriptor
- 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)
ClassVisitor
visitTypeAnnotation
in class ClassVisitor
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.public final void visitAttribute(Attribute attribute)
ClassVisitor
visitAttribute
in class ClassVisitor
attribute
- an attribute.public final void visitNestMember(String nestMember)
ClassVisitor
visitNestMember
in class ClassVisitor
nestMember
- the internal name of a nest member (see Type.getInternalName()
).public final void visitPermittedSubclass(String permittedSubclass)
ClassVisitor
visitPermittedSubclass
in class ClassVisitor
permittedSubclass
- the internal name of a permitted subclass (see Type.getInternalName()
).public final void visitInnerClass(String name, String outerName, String innerName, int access)
ClassVisitor
visitInnerClass
in class ClassVisitor
name
- the internal name of C (see Type.getInternalName()
).outerName
- the internal name of the class or interface C is a member of (see Type.getInternalName()
). Must be null if C is not the member of a class or
interface (e.g. for local or anonymous classes).innerName
- the (simple) name of C. Must be null for anonymous inner classes.access
- the access flags of C originally declared in the source code from which this
class was compiled.public final RecordComponentVisitor visitRecordComponent(String name, String descriptor, String signature)
ClassVisitor
visitRecordComponent
in class ClassVisitor
name
- 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)
ClassVisitor
visitField
in class ClassVisitor
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.public final MethodVisitor visitMethod(int access, String name, String descriptor, String signature, String[] exceptions)
ClassVisitor
MethodVisitor
instance (or null) each time it is called, i.e., it should not return a previously
returned visitor.visitMethod
in class ClassVisitor
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.public final void visitEnd()
ClassVisitor
visitEnd
in class ClassVisitor
public byte[] toByteArray()
ClassTooLargeException
- if the constant pool of the class is too large.MethodTooLargeException
- if the Code attribute of a method is too large.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 (see Type.getInternalName()
).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 (see Type.getInternalName()
).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 (see Type.getInternalName()
).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 (see Type.getInternalName()
).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 (see Type.getInternalName()
).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 (see Type.getInternalName()
).type2
- the internal name of another class (see Type.getInternalName()
).Type.getInternalName()
).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 © 2007-2024, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.