com.sleepycat.persist.model
Class BytecodeEnhancer

java.lang.Object
  extended by com.sleepycat.asm.ClassAdapter
      extended by com.sleepycat.persist.model.BytecodeEnhancer
All Implemented Interfaces:
ClassVisitor

 class BytecodeEnhancer
extends ClassAdapter

An ASM ClassVisitor that examines a class, throws NotPersistentException if it is not persistent, or enhances it if it is persistent. A class is persistent if it contains the @Entity or @Persistent annotations. A resulting enhanced class implements the com.sleepycat.persist.impl.Enhanced interface.

NotPersistentException is thrown to abort the transformation in order to avoid making two passes over the class file (one to look for the annotations and another to enhance the bytecode) or outputing a class that isn't enhanced. By aborting the transformation as soon as we detect that the annotations are missing, we make only one partial pass for a non-persistent class.


Nested Class Summary
(package private) static class BytecodeEnhancer.NotPersistentException
          Thrown when we determine that a class is not persistent.
 
Field Summary
 
Fields inherited from class com.sleepycat.asm.ClassAdapter
cv
 
Constructor Summary
BytecodeEnhancer(ClassVisitor parentVisitor)
           
 
Method Summary
(package private) static java.lang.String getPrimitiveWrapperClass(int primitiveSort)
          Returns the wrapper class for a primitive.
(package private) static boolean isSimpleRefType(java.lang.String className)
          Returns true if the given class is a primitive wrapper, Date or String.
 void visit(int version, int access, java.lang.String name, java.lang.String sig, 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 visitEnd()
          Visits the end of the class.
 FieldVisitor visitField(int access, java.lang.String name, java.lang.String desc, java.lang.String sig, java.lang.Object value)
          Visits a field of the class.
 MethodVisitor visitMethod(int access, java.lang.String name, java.lang.String desc, java.lang.String sig, java.lang.String[] exceptions)
          Visits a method of the class.
 void visitSource(java.lang.String source, java.lang.String debug)
          Visits the source of the class.
 
Methods inherited from class com.sleepycat.asm.ClassAdapter
visitAttribute, visitInnerClass, visitOuterClass
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BytecodeEnhancer

BytecodeEnhancer(ClassVisitor parentVisitor)
Method Detail

visit

public void visit(int version,
                  int access,
                  java.lang.String name,
                  java.lang.String sig,
                  java.lang.String superName,
                  java.lang.String[] interfaces)
Description copied from interface: ClassVisitor
Visits the header of the class.

Specified by:
visit in interface ClassVisitor
Overrides:
visit in class ClassAdapter
Parameters:
version - 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).
sig - 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.

visitSource

public void visitSource(java.lang.String source,
                        java.lang.String debug)
Description copied from interface: ClassVisitor
Visits the source of the class.

Specified by:
visitSource in interface ClassVisitor
Overrides:
visitSource in class ClassAdapter
Parameters:
source - 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.

visitAnnotation

public AnnotationVisitor visitAnnotation(java.lang.String desc,
                                         boolean visible)
Description copied from interface: ClassVisitor
Visits an annotation of the class.

Specified by:
visitAnnotation in interface ClassVisitor
Overrides:
visitAnnotation in class ClassAdapter
Parameters:
desc - the class descriptor of the annotation class.
visible - true if the annotation is visible at runtime.
Returns:
a non null visitor to visit the annotation values.

visitField

public FieldVisitor visitField(int access,
                               java.lang.String name,
                               java.lang.String desc,
                               java.lang.String sig,
                               java.lang.Object value)
Description copied from interface: ClassVisitor
Visits a field of the class.

Specified by:
visitField in interface ClassVisitor
Overrides:
visitField in class ClassAdapter
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.
desc - the field's descriptor (see Type).
sig - 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.

visitMethod

public MethodVisitor visitMethod(int access,
                                 java.lang.String name,
                                 java.lang.String desc,
                                 java.lang.String sig,
                                 java.lang.String[] exceptions)
Description copied from interface: 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.

Specified by:
visitMethod in interface ClassVisitor
Overrides:
visitMethod in class ClassAdapter
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.
desc - the method's descriptor (see Type).
sig - 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.
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.

visitEnd

public void visitEnd()
Description copied from interface: 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.

Specified by:
visitEnd in interface ClassVisitor
Overrides:
visitEnd in class ClassAdapter

isSimpleRefType

static boolean isSimpleRefType(java.lang.String className)
Returns true if the given class is a primitive wrapper, Date or String.


getPrimitiveWrapperClass

static java.lang.String getPrimitiveWrapperClass(int primitiveSort)
Returns the wrapper class for a primitive.



Copyright 2004-2006 Sleepycat, Inc. All Rights Reserved.