|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.compass.core.util.asm.ClassWriter
public class ClassWriter
A ClassVisitor that generates classes in bytecode form. More
precisely this visitor generates a byte array conforming to the Java class
file format. It can be used alone, to generate a Java class "from scratch",
or with one or more ClassReader and adapter class visitor
to generate a modified class from one or more existing Java classes.
| Field Summary | |
|---|---|
(package private) static int |
CLASS
The type of CONSTANT_Class constant pool items. |
static int |
COMPUTE_FRAMES
Flag to automatically compute the stack map frames of methods from scratch. |
static int |
COMPUTE_MAXS
Flag to automatically compute the maximum stack size and the maximum number of local variables of methods. |
(package private) ClassReader |
cr
The class reader from which this class writer was constructed, if any. |
(package private) static int |
DOUBLE
The type of CONSTANT_Double constant pool items. |
(package private) static int |
FIELD
The type of CONSTANT_Fieldref constant pool items. |
(package private) static int |
FIELDORMETH_INSN
The type of field and method invocations instructions. |
(package private) FieldWriter |
firstField
The fields of this class. |
(package private) MethodWriter |
firstMethod
The methods of this class. |
(package private) static int |
FLOAT
The type of CONSTANT_Float constant pool items. |
(package private) static int |
IINC_INSN
The type of the IINC instruction. |
(package private) static int |
IMETH
The type of CONSTANT_InterfaceMethodref constant pool items. |
(package private) static int |
IMPLVAR_INSN
The type of instructions with an implicit local variable index argument. |
(package private) int |
index
Index of the next item to be added in the constant pool. |
(package private) static int |
INT
The type of CONSTANT_Integer constant pool items. |
(package private) boolean |
invalidFrames
true if the stack map tables of this class are invalid. |
(package private) Item[] |
items
The constant pool's hash table data. |
(package private) static int |
ITFMETH_INSN
The type of the INVOKEINTERFACE instruction. |
(package private) Item |
key
A reusable key used to look for items in the items hash table. |
(package private) Item |
key2
A reusable key used to look for items in the items hash table. |
(package private) Item |
key3
A reusable key used to look for items in the items hash table. |
(package private) static int |
LABEL_INSN
The type of instructions with a 2 bytes bytecode offset label. |
(package private) static int |
LABELW_INSN
The type of instructions with a 4 bytes bytecode offset label. |
(package private) FieldWriter |
lastField
The fields of this class. |
(package private) MethodWriter |
lastMethod
The methods of this class. |
(package private) static int |
LDC_INSN
The type of the LDC instruction. |
(package private) static int |
LDCW_INSN
The type of the LDC_W and LDC2_W instructions. |
(package private) static int |
LONG
The type of CONSTANT_Long constant pool items. |
(package private) static int |
LOOK_INSN
The type of the LOOKUPSWITCH instruction. |
(package private) static int |
MANA_INSN
The type of the MULTIANEWARRAY instruction. |
(package private) static int |
METH
The type of CONSTANT_Methodref constant pool items. |
(package private) static int |
NAME_TYPE
The type of CONSTANT_NameAndType constant pool items. |
(package private) static int |
NOARG_INSN
The type of instructions without any argument. |
(package private) ByteVector |
pool
The constant pool of this class. |
(package private) static int |
SBYTE_INSN
The type of instructions with an signed byte argument. |
(package private) static int |
SHORT_INSN
The type of instructions with an signed short argument. |
(package private) static int |
STR
The type of CONSTANT_String constant pool items. |
(package private) static int |
TABL_INSN
The type of the TABLESWITCH instruction. |
(package private) String |
thisName
The internal name of this class. |
(package private) int |
threshold
The threshold of the constant pool's hash table. |
(package private) static byte[] |
TYPE
The instruction types of all JVM opcodes. |
(package private) static int |
TYPE_INSN
The type of instructions with a type descriptor argument. |
(package private) static int |
TYPE_MERGED
Merged type Item stored in the ClassWriter typeTable,
instead of the constant pool, in order to avoid clashes with normal
constant pool items in the ClassWriter constant pool's hash table. |
(package private) static int |
TYPE_NORMAL
Normal type Item stored in the ClassWriter typeTable,
instead of the constant pool, in order to avoid clashes with normal
constant pool items in the ClassWriter constant pool's hash table. |
(package private) static int |
TYPE_UNINIT
Uninitialized type Item stored in the ClassWriter typeTable, instead of the constant pool, in order to
avoid clashes with normal constant pool items in the ClassWriter constant
pool's hash table. |
(package private) Item[] |
typeTable
A type table used to temporarily store internal names that will not necessarily be stored in the constant pool. |
(package private) static int |
UTF8
The type of CONSTANT_Utf8 constant pool items. |
(package private) static int |
VAR_INSN
The type of instructions with a local variable index argument. |
(package private) int |
version
Minor and major version numbers of the class to be generated. |
(package private) static int |
WIDE_INSN
The type of the WIDE instruction. |
| Constructor Summary | |
|---|---|
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. |
|
| Method Summary | |
|---|---|
(package private) int |
addType(String type)
Adds the given internal name to typeTable and returns its index. |
(package private) int |
addUninitializedType(String type,
int offset)
Adds the given "uninitialized" type to typeTable and returns its
index. |
protected String |
getCommonSuperClass(String type1,
String type2)
Returns the common super type of the two given types. |
(package private) int |
getMergedType(int type1,
int type2)
Returns the index of 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. |
(package private) Item |
newClassItem(String value)
Adds a class reference to the constant pool of the class being build. |
int |
newConst(Object cst)
Adds a number or string constant to the constant pool of the class being build. |
(package private) Item |
newConstItem(Object cst)
Adds a number or string constant to the constant pool of the class being build. |
(package private) Item |
newDouble(double value)
Adds a double to the constant pool of the class being build. |
int |
newField(String owner,
String name,
String desc)
Adds a field reference to the constant pool of the class being build. |
(package private) Item |
newFieldItem(String owner,
String name,
String desc)
Adds a field reference to the constant pool of the class being build. |
(package private) Item |
newFloat(float value)
Adds a float to the constant pool of the class being build. |
(package private) Item |
newInteger(int value)
Adds an integer to the constant pool of the class being build. |
(package private) Item |
newLong(long value)
Adds a long to the constant pool of the class being build. |
int |
newMethod(String owner,
String name,
String desc,
boolean itf)
Adds a method reference to the constant pool of the class being build. |
(package private) Item |
newMethodItem(String owner,
String name,
String desc,
boolean itf)
Adds a method reference to the constant pool of the class being build. |
int |
newNameType(String name,
String desc)
Adds a name and type 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 bytecode of the class that was build with this class writer. |
void |
visit(int version,
int access,
String name,
String signature,
String superName,
String[] interfaces)
Visits the header of the class. |
AnnotationVisitor |
visitAnnotation(String desc,
boolean visible)
Visits an annotation of the class. |
void |
visitAttribute(Attribute attr)
Visits a non standard attribute of the class. |
void |
visitEnd()
Visits the end of the class. |
FieldVisitor |
visitField(int access,
String name,
String desc,
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 desc,
String signature,
String[] exceptions)
Visits a method of the class. |
void |
visitOuterClass(String owner,
String name,
String desc)
Visits the enclosing class of the class. |
void |
visitSource(String file,
String debug)
Visits the source of the class. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final int COMPUTE_MAXS
visitMaxs method of the
MethodVisitor returned by the visitMethod
method will be ignored, and computed automatically from the signature and
the bytecode of each method.
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
visitMaxs method are also ignored and
recomputed from the bytecode. In other words, computeFrames implies
computeMaxs.
ClassWriter(int),
Constant Field Valuesstatic final int NOARG_INSN
static final int SBYTE_INSN
static final int SHORT_INSN
static final int VAR_INSN
static final int IMPLVAR_INSN
static final int TYPE_INSN
static final int FIELDORMETH_INSN
static final int ITFMETH_INSN
static final int LABEL_INSN
static final int LABELW_INSN
static final int LDC_INSN
static final int LDCW_INSN
static final int IINC_INSN
static final int TABL_INSN
static final int LOOK_INSN
static final int MANA_INSN
static final int WIDE_INSN
static final byte[] TYPE
static final int CLASS
static final int FIELD
static final int METH
static final int IMETH
static final int STR
static final int INT
static final int FLOAT
static final int LONG
static final int DOUBLE
static final int NAME_TYPE
static final int UTF8
static final int TYPE_NORMAL
typeTable,
instead of the constant pool, in order to avoid clashes with normal
constant pool items in the ClassWriter constant pool's hash table.
static final int TYPE_UNINIT
typeTable, instead of the constant pool, in order to
avoid clashes with normal constant pool items in the ClassWriter constant
pool's hash table.
static final int TYPE_MERGED
typeTable,
instead of the constant pool, in order to avoid clashes with normal
constant pool items in the ClassWriter constant pool's hash table.
ClassReader cr
int version
int index
final ByteVector pool
Item[] items
int threshold
final Item key
items hash table.
final Item key2
items hash table.
final Item key3
items hash table.
Item[] typeTable
items hash table. These two arrays
allow to retrieve an Item from its index or, conversely, to get the index
of an Item from its value. Each Item stores an internal name in its
Item.strVal1 field.
String thisName
FieldWriter firstField
FieldWriter objects, linked to each other by their
FieldWriter.next field. This field stores the first element of
this list.
FieldWriter lastField
FieldWriter objects, linked to each other by their
FieldWriter.next field. This field stores the last element of
this list.
MethodWriter firstMethod
MethodWriter objects, linked to each other by their
MethodWriter.next field. This field stores the first element of
this list.
MethodWriter lastMethod
MethodWriter objects, linked to each other by their
MethodWriter.next field. This field stores the last element of
this list.
boolean invalidFrames
MethodWriter.resizeInstructions() method cannot transform existing
stack map tables, and so produces potentially invalid classes when it is
executed. In this case the class is reread and rewritten with the
COMPUTE_FRAMES option (the resizeInstructions method can resize
stack map tables when this option is used).
| Constructor Detail |
|---|
public ClassWriter(int flags)
ClassWriter object.
flags - option flags that can be used to modify the default behavior
of this class. See COMPUTE_MAXS, 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 a custom
ClassAdapter or any other ClassVisitor instance).
classReader - the ClassReader used to read the original
class. It will be used to copy the entire constant pool 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. See COMPUTE_MAXS, COMPUTE_FRAMES.| Method Detail |
|---|
public void visit(int version,
int access,
String name,
String signature,
String superName,
String[] interfaces)
ClassVisitor
visit in interface ClassVisitorversion - the class version.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
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
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
getInternalName). May be
null.
public void visitSource(String file,
String debug)
ClassVisitor
visitSource in interface ClassVisitorfile - the name of the source file from which the class was
compiled. May be null.debug - additional debug information to compute the correspondance
between source and compiled elements of the class. May be
null.
public void visitOuterClass(String owner,
String name,
String desc)
ClassVisitor
visitOuterClass in interface 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.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 AnnotationVisitor visitAnnotation(String desc,
boolean visible)
ClassVisitor
visitAnnotation in interface ClassVisitordesc - the class descriptor of the annotation class.visible - true if the annotation is visible at runtime.
public void visitAttribute(Attribute attr)
ClassVisitor
visitAttribute in interface ClassVisitorattr - an attribute.
public void visitInnerClass(String name,
String outerName,
String innerName,
int access)
ClassVisitor
visitInnerClass in interface ClassVisitorname - the internal name of an inner class (see
getInternalName).outerName - the internal name of the class to which the inner class
belongs (see 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 FieldVisitor visitField(int access,
String name,
String desc,
String signature,
Object value)
ClassVisitor
visitField in interface 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.desc - 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 MethodVisitor visitMethod(int access,
String name,
String desc,
String signature,
String[] exceptions)
ClassVisitorMethodVisitor instance (or null) each time it is
called, i.e., it should not return a previously returned visitor.
visitMethod in interface 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.desc - 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 getInternalName). May be
null.
public void visitEnd()
ClassVisitor
visitEnd in interface ClassVisitorpublic byte[] toByteArray()
Item newConstItem(Object cst)
cst - the value of the constant to be added to the constant pool.
This parameter must be an Integer, a Float, a
Long, a Double, a String or a
Type.
public int newConst(Object cst)
Attribute sub classes, and is
normally not needed by class generators or adapters.
cst - the value of the constant to be added to the constant pool.
This parameter must be an Integer, a Float, a
Long, a Double or a String.
public int newUTF8(String value)
Attribute sub classes, and is normally not
needed by class generators or adapters.
value - the String value.
Item newClassItem(String value)
Attribute sub classes, and is
normally not needed by class generators or adapters.
value - the internal name of the class.
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.
Item newFieldItem(String owner,
String name,
String desc)
owner - the internal name of the field's owner class.name - the field's name.desc - the field's descriptor.
public int newField(String owner,
String name,
String desc)
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.desc - the field's descriptor.
Item newMethodItem(String owner,
String name,
String desc,
boolean itf)
owner - the internal name of the method's owner class.name - the method's name.desc - the method's descriptor.itf - true if owner is an interface.
public int newMethod(String owner,
String name,
String desc,
boolean itf)
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.desc - the method's descriptor.itf - true if owner is an interface.
Item newInteger(int value)
value - the int value.
Item newFloat(float value)
value - the float value.
Item newLong(long value)
value - the long value.
Item newDouble(double value)
value - the double value.
public int newNameType(String name,
String desc)
Attribute sub classes, and is normally not
needed by class generators or adapters.
name - a name.desc - a type descriptor.
int addType(String type)
typeTable and returns its index.
Does nothing if the type table already contains this internal name.
type - the internal name to be added to the type table.
int addUninitializedType(String type,
int offset)
typeTable and returns its
index. This method is used for UNINITIALIZED types, made of an internal
name and a bytecode offset.
type - the internal name to be added to the type table.offset - the bytecode offset of the NEW instruction that created
this UNINITIALIZED type value.
int getMergedType(int type1,
int type2)
getCommonSuperClass(java.lang.String, java.lang.String) and caches the result in the
items hash table to speedup future calls with the same
parameters.
type1 - index of an internal name in typeTable.type2 - index of an internal name in typeTable.
protected String getCommonSuperClass(String type1,
String type2)
type1 - the internal name of a class.type2 - the internal name of another class.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||