org.ow2.asmdex
Class ClassWriter

java.lang.Object
  org.ow2.asmdex.ClassVisitor
      org.ow2.asmdex.ClassWriter

public class ClassWriter
extends ClassVisitor

Class that takes care of visiting a Class for the Application Writer to write it.

Author:

Julien Névo

Field Summary

Fields inherited from class org.ow2.asmdex.ClassVisitor

api, cv

Constructor Summary

ClassWriter(ApplicationWriter applicationWriter, ConstantPool constantPool, int access, java.lang.String name, java.lang.String[] signature, java.lang.String superName, java.lang.String[] interfaces)
Constructor.

Method Summary

ApplicationWriter	getApplicationWriter() Returns the ApplicationWriter of this Class Writer.
ClassDefinitionItem	getClassDefinitionItem() Returns the current class definition item.
ConstantPool	getConstantPool() Returns the Constant Pool related to this Application.
java.lang.String	getName() Returns the name of the Class.
void	visit(int version, int access, java.lang.String name, java.lang.String[] signature, java.lang.String superName, java.lang.String[] interfaces) Visits the header of the class.
AnnotationVisitor	visitAnnotation(java.lang.String desc, boolean visible) Visits an annotation of the class.
void	visitAttribute(java.lang.Object attr) Visits a non standard attribute of the class.
void	visitEnd() Visits the end of the class.
FieldVisitor	visitField(int access, java.lang.String name, java.lang.String desc, java.lang.String[] signature, java.lang.Object value) Visits a field of the class.
void	visitInnerClass(java.lang.String name, java.lang.String outerName, java.lang.String innerName, int access) Visits information about an inner class.
MethodVisitor	visitMethod(int access, java.lang.String name, java.lang.String desc, java.lang.String[] signature, java.lang.String[] exceptions) Visits a method of the class.
void	visitOuterClass(java.lang.String owner, java.lang.String name, java.lang.String desc) Visits the enclosing class of the class.
void	visitSource(java.lang.String source, java.lang.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

Constructor Detail

ClassWriter

public ClassWriter(ApplicationWriter applicationWriter,
                   ConstantPool constantPool,
                   int access,
                   java.lang.String name,
                   java.lang.String[] signature,
                   java.lang.String superName,
                   java.lang.String[] interfaces)

Constructor.

Parameters:

applicationWriter - the Application Writer.

constantPool - the constantPool of the Application.

access - the access flags of the class.

name - the name of the class.

signature - the signature of the class. Used only for generics. May be null.

superName - the name of the super class.

interfaces - the name of the interfaces of the class.

Method Detail

getApplicationWriter

public ApplicationWriter getApplicationWriter()

Returns the ApplicationWriter of this Class Writer.

getName

public java.lang.String getName()

Returns the name of the Class.

Returns:

the name of the Class.

getClassDefinitionItem

public ClassDefinitionItem getClassDefinitionItem()

Returns the current class definition item.

Returns:

the current class definition item.

getConstantPool

public ConstantPool getConstantPool()

Returns the Constant Pool related to this Application.

Returns:

the Constant Pool related to this Application.

visit

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

Description copied from class: ClassVisitor

Visits the header of the class. The information given here is only given for compatibility with ASM. They are NOT used by AsmDex, as the Class currently visited has its identity given by ApplicationVisitor.visitClass.

Overrides:

visit in class ClassVisitor

Parameters:

version - the class version. Ignored by AsmDex, only here for compatibility with ASM.

access - the class's access flags (see Opcodes). Ignored by AsmDex, only here for compatibility with ASM, as this parameter has already been filled by an ApplicationVisitor.

name - the internal name of the class. Ignored by AsmDex, only here for compatibility with ASM, as this parameter has already been filled by an ApplicationVisitor.

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. Ignored by AsmDex, only here for compatibility with ASM, as this parameter has already been filled by an ApplicationVisitor.

superName - the internal of name of the super class. For interfaces, the super class is Object. May be null, but only for the Object class. Ignored by AsmDex, only here for compatibility with ASM, as this parameter has already been filled by an ApplicationVisitor.

interfaces - the internal names of the class's interfaces. May be null. Ignored by AsmDex, only here for compatibility with ASM, as this parameter has already been filled by an ApplicationVisitor.

visitSource

public void visitSource(java.lang.String source,
                        java.lang.String debug)

Description copied from class: ClassVisitor

Visits the source of the class.

Overrides:

visitSource in class ClassVisitor

Parameters:

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

debug - additional debug information to compute the link between source and compiled elements of the class. May be null. This parameter is ignored by AsmDex, and is only there for compatibility with ASM.

visitEnd

public void visitEnd()

Description copied from class: ClassVisitor

Visits the end of the class. This method, which is the last one to be called, is used to inform the visitor that all the fields and methods of the class have been visited.

Overrides:

visitEnd in class ClassVisitor

visitMethod

public MethodVisitor visitMethod(int access,
                                 java.lang.String name,
                                 java.lang.String desc,
                                 java.lang.String[] signature,
                                 java.lang.String[] exceptions)

Description copied from class: ClassVisitor

Visits a method of the class. This method must return a new MethodVisitor instance (or null) each time it is called, i.e., it should not return a previously returned visitor.

Overrides:

visitMethod in class ClassVisitor

Parameters:

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

name - the method's name.

desc - the method's descriptor.

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

exceptions - the internal names of the method's exception classes. May be null.

Returns:

an object to visit the byte code of the method, or null if this class visitor is not interested in visiting the code of this method.

visitField

public FieldVisitor visitField(int access,
                               java.lang.String name,
                               java.lang.String desc,
                               java.lang.String[] signature,
                               java.lang.Object value)

Description copied from class: ClassVisitor

Visits a field of the class.

Overrides:

visitField in class ClassVisitor

Parameters:

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

name - the field's name.

desc - the field's descriptor.

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:

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

visitAnnotation

public AnnotationVisitor visitAnnotation(java.lang.String desc,
                                         boolean visible)

Description copied from class: ClassVisitor

Visits an annotation of the class.

Overrides:

visitAnnotation in class ClassVisitor

Parameters:

desc - 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.

visitInnerClass

public void visitInnerClass(java.lang.String name,
                            java.lang.String outerName,
                            java.lang.String innerName,
                            int access)

Description copied from class: ClassVisitor

Visits information about an inner class. This inner class is not necessarily a member of the class being visited.

Overrides:

visitInnerClass in class ClassVisitor

Parameters:

name - the internal name of an inner class.

outerName - the internal name of the class to which the inner class belongs. 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.

visitOuterClass

public void visitOuterClass(java.lang.String owner,
                            java.lang.String name,
                            java.lang.String desc)

Description copied from class: ClassVisitor

Visits the enclosing class of the class. This method must be called only if the class has an enclosing class.

Overrides:

visitOuterClass in class ClassVisitor

Parameters:

owner - 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.

visitAttribute

public void visitAttribute(java.lang.Object attr)

Description copied from class: ClassVisitor

Visits a non standard attribute of the class. This method is ignored by AsmDex, since attributes are not supported.

Overrides:

visitAttribute in class ClassVisitor

Parameters:

attr - an attribute.