Module org.datanucleus
Package org.datanucleus.enhancer

Class EnhancerPropertyGetterAdapter

  • public class EnhancerPropertyGetterAdapter
extends MethodVisitor
    Adapter for property getter methods in persistence-enabled classes. This adapter processes the getXXX method and
    • Creates dnGetXXX with the same code as was present in getXXX
    • Changes getXXX to have the code below
    When detachable this will be (CHECK_READ variant) 
     YYY getZZZ()
 {
     if (dnFlags > 0 && dnStateManager != null && !dnStateManager.isLoaded(this, 0))
         return (Integer) dnStateManager.getObjectField(this, 0, dnGetXXX());
     if (dnIsDetached() && !((BitSet) dnDetachedState[2]).get(0))
         throw new DetachedFieldAccessException
             ("You have just attempted to access property \"id\" yet this field was not detached ...");
     return dnGetXXX();
 }
    and when not detachable 
     YYY getZZZ()
 {
     if (dnFlags > 0 && dnStateManager != null && !dnStateManager.isLoaded(this, 0))
         return (Integer) dnStateManager.getObjectField(this, 0, dnGetXXX());
     return dnGetXXX();
 }
    There are other variants for MEDIATE_READ and NORMAL_READ

    • Field Detail

      • enhancer

        protected ClassEnhancer enhancer
        The enhancer for this class.

      • methodName

        protected String methodName
        Name for the method being adapted.

      • methodDescriptor

        protected String methodDescriptor
        Descriptor for the method being adapted.

      • visitor

        protected MethodVisitor visitor
        Visitor for the dnGetXXX method.

    • Constructor Detail

      • EnhancerPropertyGetterAdapter

        public EnhancerPropertyGetterAdapter​(MethodVisitor mv,
                                     ClassEnhancer enhancer,
                                     String methodName,
                                     String methodDesc,
                                     AbstractMemberMetaData mmd,
                                     ClassVisitor cv)
        Constructor for the method adapter.
        Parameters:
        mv - MethodVisitor
        enhancer - ClassEnhancer for the class with the method
        methodName - Name of the method
        methodDesc - Method descriptor
        mmd - MetaData for the property
        cv - ClassVisitor

    • Method Detail

      • visitEnd

        public void visitEnd()
        Method called at the end of visiting the getXXX method. This is used to add the dnGetXXX method with the same code as is present originally in the getXXX method.
        Overrides:
        visitEnd in class MethodVisitor

      • generateGetXXXMethod

        public static void generateGetXXXMethod​(MethodVisitor mv,
                                        AbstractMemberMetaData mmd,
                                        String asmClassName,
                                        String asmClassDesc,
                                        boolean detachListener,
                                        EnhancementNamer namer)
        Convenience method to use the MethodVisitor to generate the code for the method getXXX() for the property with the specified MetaData.
        Parameters:
        mv - MethodVisitor
        mmd - MetaData for the property
        asmClassName - ASM class name for the owning class
        asmClassDesc - ASM descriptor for the owning class
        detachListener - true if the generate code must support DetachListener
        namer - Namer for methods etc

      • visitAnnotation

        public AnnotationVisitor visitAnnotation​(String arg0,
                                         boolean arg1)
        Description copied from class: MethodVisitor
        Visits an annotation of this method.
        Overrides:
        visitAnnotation in class MethodVisitor
        Parameters:
        arg0 - the class descriptor of the annotation class.
        arg1 - 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.

      • visitAnnotationDefault

        public AnnotationVisitor visitAnnotationDefault()
        Description copied from class: MethodVisitor
        Visits the default value of this annotation interface method.
        Overrides:
        visitAnnotationDefault in class MethodVisitor
        Returns:
        a visitor to the visit the actual default value of this annotation interface method, or null if this visitor is not interested in visiting this default value. The 'name' parameters passed to the methods of this annotation visitor are ignored. Moreover, exacly one visit method must be called on this annotation visitor, followed by visitEnd.

      • visitParameter

        public void visitParameter​(String name,
                           int access)
        Description copied from class: MethodVisitor
        Visits a parameter of this method.
        Overrides:
        visitParameter in class MethodVisitor
        Parameters:
        name - parameter name or null if none is provided.
        access - the parameter's access flags, only ACC_FINAL, ACC_SYNTHETIC or/and ACC_MANDATED are allowed (see Opcodes).

      • visitMethodInsn

        public void visitMethodInsn​(int opcode,
                            String owner,
                            String name,
                            String desc,
                            boolean itf)
        Description copied from class: MethodVisitor
        Visits a method instruction. A method instruction is an instruction that invokes a method.
        Overrides:
        visitMethodInsn in class MethodVisitor
        Parameters:
        opcode - the opcode of the type instruction to be visited. This opcode is either INVOKEVIRTUAL, INVOKESPECIAL, INVOKESTATIC or INVOKEINTERFACE.
        owner - the internal name of the method's owner class (see Type.getInternalName()).
        name - the method's name.
        desc - the method's descriptor (see Type).
        itf - if the method's owner class is an interface.

      • visitLocalVariableAnnotation

        public AnnotationVisitor visitLocalVariableAnnotation​(int typeRef,
                                                      TypePath typePath,
                                                      Label[] start,
                                                      Label[] end,
                                                      int[] index,
                                                      String desc,
                                                      boolean visible)
        Description copied from class: MethodVisitor
        Visits an annotation on a local variable type.
        Overrides:
        visitLocalVariableAnnotation in class MethodVisitor
        Parameters:
        typeRef - a reference to the annotated type. The sort of this type reference must be TypeReference.LOCAL_VARIABLE or TypeReference.RESOURCE_VARIABLE. 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.
        start - the fist instructions corresponding to the continuous ranges that make the scope of this local variable (inclusive).
        end - the last instructions corresponding to the continuous ranges that make the scope of this local variable (exclusive). This array must have the same size as the 'start' array.
        index - the local variable's index in each range. This array must have the same size as the 'start' array.
        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.

      • visitCode

        public void visitCode()
        Description copied from class: MethodVisitor
        Starts the visit of the method's code, if any (i.e. non abstract method).
        Overrides:
        visitCode in class MethodVisitor

      • visitFieldInsn

        public void visitFieldInsn​(int opcode,
                           String owner,
                           String name,
                           String desc)
        Description copied from class: MethodVisitor
        Visits a field instruction. A field instruction is an instruction that loads or stores the value of a field of an object.
        Overrides:
        visitFieldInsn in class MethodVisitor
        Parameters:
        opcode - the opcode of the type instruction to be visited. This opcode is either GETSTATIC, PUTSTATIC, GETFIELD or PUTFIELD.
        owner - the internal name of the field's owner class (see Type.getInternalName()).
        name - the field's name.
        desc - the field's descriptor (see Type).

      • visitFrame

        public void visitFrame​(int arg0,
                       int arg1,
                       Object[] arg2,
                       int arg3,
                       Object[] arg4)
        Description copied from class: MethodVisitor
        Visits the current state of the local variables and operand stack elements. This method must(*) be called just before any instruction i that follows an unconditional branch instruction such as GOTO or THROW, that is the target of a jump instruction, or that starts an exception handler block. The visited types must describe the values of the local variables and of the operand stack elements just before i is executed.

        (*) this is mandatory only for classes whose version is greater than or equal to Opcodes.V1_6.

        The frames of a method must be given either in expanded form, or in compressed form (all frames must use the same format, i.e. you must not mix expanded and compressed frames within a single method):
        • In expanded form, all frames must have the F_NEW type.
        • In compressed form, frames are basically "deltas" from the state of the previous frame:
          • Opcodes.F_SAME representing frame with exactly the same locals as the previous frame and with the empty stack.
          • Opcodes.F_SAME1 representing frame with exactly the same locals as the previous frame and with single value on the stack ( numStack is 1 and stack[0] contains value for the type of the stack item).
          • Opcodes.F_APPEND representing frame with current locals are the same as the locals in the previous frame, except that additional locals are defined ( numLocal is 1, 2 or 3 and local elements contains values representing added types).
          • Opcodes.F_CHOP representing frame with current locals are the same as the locals in the previous frame, except that the last 1-3 locals are absent and with the empty stack (numLocal is 1, 2 or 3).
          • Opcodes.F_FULL representing complete frame data.

        In both cases the first frame, corresponding to the method's parameters and access flags, is implicit and must not be visited. Also, it is illegal to visit two or more frames for the same code location (i.e., at least one instruction must be visited between two calls to visitFrame).
        Overrides:
        visitFrame in class MethodVisitor
        Parameters:
        arg0 - the type of this stack map frame. Must be Opcodes.F_NEW for expanded frames, or Opcodes.F_FULL, Opcodes.F_APPEND, Opcodes.F_CHOP, Opcodes.F_SAME or Opcodes.F_APPEND, Opcodes.F_SAME1 for compressed frames.
        arg1 - the number of local variables in the visited frame.
        arg2 - the local variable types in this frame. This array must not be modified. Primitive types are represented by Opcodes.TOP, Opcodes.INTEGER, Opcodes.FLOAT, Opcodes.LONG, Opcodes.DOUBLE, Opcodes.NULL or Opcodes.UNINITIALIZED_THIS (long and double are represented by a single element). Reference types are represented by String objects (representing internal names), and uninitialized types by Label objects (this label designates the NEW instruction that created this uninitialized value).
        arg3 - the number of operand stack elements in the visited frame.
        arg4 - the operand stack types in this frame. This array must not be modified. Its content has the same format as the "local" array.

      • visitIincInsn

        public void visitIincInsn​(int arg0,
                          int arg1)
        Description copied from class: MethodVisitor
        Visits an IINC instruction.
        Overrides:
        visitIincInsn in class MethodVisitor
        Parameters:
        arg0 - index of the local variable to be incremented.
        arg1 - amount to increment the local variable by.

      • visitInsn

        public void visitInsn​(int opcode)
        Description copied from class: MethodVisitor
        Visits a zero operand instruction.
        Overrides:
        visitInsn in class MethodVisitor
        Parameters:
        opcode - the opcode of the instruction to be visited. This opcode is either NOP, ACONST_NULL, ICONST_M1, ICONST_0, ICONST_1, ICONST_2, ICONST_3, ICONST_4, ICONST_5, LCONST_0, LCONST_1, FCONST_0, FCONST_1, FCONST_2, DCONST_0, DCONST_1, IALOAD, LALOAD, FALOAD, DALOAD, AALOAD, BALOAD, CALOAD, SALOAD, IASTORE, LASTORE, FASTORE, DASTORE, AASTORE, BASTORE, CASTORE, SASTORE, POP, POP2, DUP, DUP_X1, DUP_X2, DUP2, DUP2_X1, DUP2_X2, SWAP, IADD, LADD, FADD, DADD, ISUB, LSUB, FSUB, DSUB, IMUL, LMUL, FMUL, DMUL, IDIV, LDIV, FDIV, DDIV, IREM, LREM, FREM, DREM, INEG, LNEG, FNEG, DNEG, ISHL, LSHL, ISHR, LSHR, IUSHR, LUSHR, IAND, LAND, IOR, LOR, IXOR, LXOR, I2L, I2F, I2D, L2I, L2F, L2D, F2I, F2L, F2D, D2I, D2L, D2F, I2B, I2C, I2S, LCMP, FCMPL, FCMPG, DCMPL, DCMPG, IRETURN, LRETURN, FRETURN, DRETURN, ARETURN, RETURN, ARRAYLENGTH, ATHROW, MONITORENTER, or MONITOREXIT.

      • visitJumpInsn

        public void visitJumpInsn​(int arg0,
                          Label arg1)
        Description copied from class: MethodVisitor
        Visits a jump instruction. A jump instruction is an instruction that may jump to another instruction.
        Overrides:
        visitJumpInsn in class MethodVisitor
        Parameters:
        arg0 - the opcode of the type instruction to be visited. This opcode is either IFEQ, IFNE, IFLT, IFGE, IFGT, IFLE, IF_ICMPEQ, IF_ICMPNE, IF_ICMPLT, IF_ICMPGE, IF_ICMPGT, IF_ICMPLE, IF_ACMPEQ, IF_ACMPNE, GOTO, JSR, IFNULL or IFNONNULL.
        arg1 - the operand of the instruction to be visited. This operand is a label that designates the instruction to which the jump instruction may jump.

      • visitLabel

        public void visitLabel​(Label arg0)
        Description copied from class: MethodVisitor
        Visits a label. A label designates the instruction that will be visited just after it.
        Overrides:
        visitLabel in class MethodVisitor
        Parameters:
        arg0 - a Label object.

      • visitLdcInsn

        public void visitLdcInsn​(Object arg0)
        Description copied from class: MethodVisitor
        Visits a LDC instruction. Note that new constant types may be added in future versions of the Java Virtual Machine. To easily detect new constant types, implementations of this method should check for unexpected constant types, like this: 
         if (cst instanceof Integer) {
     // ...
 } else if (cst instanceof Float) {
     // ...
 } else if (cst instanceof Long) {
     // ...
 } else if (cst instanceof Double) {
     // ...
 } else if (cst instanceof String) {
     // ...
 } else if (cst instanceof Type) {
     int sort = ((Type) cst).getSort();
     if (sort == Type.OBJECT) {
         // ...
     } else if (sort == Type.ARRAY) {
         // ...
     } else if (sort == Type.METHOD) {
         // ...
     } else {
         // throw an exception
     }
 } else if (cst instanceof Handle) {
     // ...
 } else if (cst instanceof ConstantDynamic) {
     // ...
 } else {
     // throw an exception
 }
        Overrides:
        visitLdcInsn in class MethodVisitor
        Parameters:
        arg0 - the constant to be loaded on the stack. This parameter must be a non null Integer, a Float, a Long, a Double, a String, a Type of OBJECT or ARRAY sort for .class constants, for classes whose version is 49, a Type of METHOD sort for MethodType, a Handle for MethodHandle constants, for classes whose version is 51 or a ConstantDynamic for a constant dynamic for classes whose version is 55.

      • visitLineNumber

        public void visitLineNumber​(int arg0,
                            Label arg1)
        Description copied from class: MethodVisitor
        Visits a line number declaration.
        Overrides:
        visitLineNumber in class MethodVisitor
        Parameters:
        arg0 - a line number. This number refers to the source file from which the class was compiled.
        arg1 - the first instruction corresponding to this line number.

      • visitLocalVariable

        public void visitLocalVariable​(String arg0,
                               String arg1,
                               String arg2,
                               Label arg3,
                               Label arg4,
                               int arg5)
        Description copied from class: MethodVisitor
        Visits a local variable declaration.
        Overrides:
        visitLocalVariable in class MethodVisitor
        Parameters:
        arg0 - the name of a local variable.
        arg1 - the type descriptor of this local variable.
        arg2 - the type signature of this local variable. May be null if the local variable type does not use generic types.
        arg3 - the first instruction corresponding to the scope of this local variable (inclusive).
        arg4 - the last instruction corresponding to the scope of this local variable (exclusive).
        arg5 - the local variable's index.

      • visitLookupSwitchInsn

        public void visitLookupSwitchInsn​(Label arg0,
                                  int[] arg1,
                                  Label[] arg2)
        Description copied from class: MethodVisitor
        Visits a LOOKUPSWITCH instruction.
        Overrides:
        visitLookupSwitchInsn in class MethodVisitor
        Parameters:
        arg0 - beginning of the default handler block.
        arg1 - the values of the keys.
        arg2 - beginnings of the handler blocks. labels[i] is the beginning of the handler block for the keys[i] key.

      • visitMaxs

        public void visitMaxs​(int arg0,
                      int arg1)
        Description copied from class: MethodVisitor
        Visits the maximum stack size and the maximum number of local variables of the method.
        Overrides:
        visitMaxs in class MethodVisitor
        Parameters:
        arg0 - maximum stack size of the method.
        arg1 - maximum number of local variables for the method.

      • visitMethodInsn

        @Deprecated
public void visitMethodInsn​(int opcode,
                            String owner,
                            String name,
                            String desc)
        Deprecated.
        Description copied from class: MethodVisitor
        Visits a method instruction. A method instruction is an instruction that invokes a method.
        Overrides:
        visitMethodInsn in class MethodVisitor
        Parameters:
        opcode - the opcode of the type instruction to be visited. This opcode is either INVOKEVIRTUAL, INVOKESPECIAL, INVOKESTATIC or INVOKEINTERFACE.
        owner - the internal name of the method's owner class (see Type.getInternalName()).
        name - the method's name.
        desc - the method's descriptor (see Type).

      • visitMultiANewArrayInsn

        public void visitMultiANewArrayInsn​(String arg0,
                                    int arg1)
        Description copied from class: MethodVisitor
        Visits a MULTIANEWARRAY instruction.
        Overrides:
        visitMultiANewArrayInsn in class MethodVisitor
        Parameters:
        arg0 - an array type descriptor (see Type).
        arg1 - the number of dimensions of the array to allocate.

      • visitParameterAnnotation

        public AnnotationVisitor visitParameterAnnotation​(int arg0,
                                                  String arg1,
                                                  boolean arg2)
        Description copied from class: MethodVisitor
        Visits an annotation of a parameter this method.
        Overrides:
        visitParameterAnnotation in class MethodVisitor
        Parameters:
        arg0 - the parameter index. This index must be strictly smaller than the number of parameters in the method descriptor, and strictly smaller than the parameter count specified in MethodVisitor.visitAnnotableParameterCount(int, boolean). Important note: a parameter index i is not required to correspond to the i'th parameter descriptor in the method descriptor, in particular in case of synthetic parameters (see https://docs.oracle.com/javase/specs/jvms/se9/html/jvms-4.html#jvms-4.7.18).
        arg1 - the class descriptor of the annotation class.
        arg2 - 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.

      • visitTableSwitchInsn

        public void visitTableSwitchInsn​(int arg0,
                                 int arg1,
                                 Label arg2,
                                 Label... arg3)
        Description copied from class: MethodVisitor
        Visits a TABLESWITCH instruction.
        Overrides:
        visitTableSwitchInsn in class MethodVisitor
        Parameters:
        arg0 - the minimum key value.
        arg1 - the maximum key value.
        arg2 - beginning of the default handler block.
        arg3 - beginnings of the handler blocks. labels[i] is the beginning of the handler block for the min + i key.

      • visitTryCatchBlock

        public void visitTryCatchBlock​(Label arg0,
                               Label arg1,
                               Label arg2,
                               String arg3)
        Description copied from class: MethodVisitor
        Visits a try catch block.
        Overrides:
        visitTryCatchBlock in class MethodVisitor
        Parameters:
        arg0 - the beginning of the exception handler's scope (inclusive).
        arg1 - the end of the exception handler's scope (exclusive).
        arg2 - the beginning of the exception handler's code.
        arg3 - the internal name of the type of exceptions handled by the handler, or null to catch any exceptions (for "finally" blocks).

      • visitTypeInsn

        public void visitTypeInsn​(int arg0,
                          String arg1)
        Description copied from class: MethodVisitor
        Visits a type instruction. A type instruction is an instruction that takes the internal name of a class as parameter.
        Overrides:
        visitTypeInsn in class MethodVisitor
        Parameters:
        arg0 - the opcode of the type instruction to be visited. This opcode is either NEW, ANEWARRAY, CHECKCAST or INSTANCEOF.
        arg1 - the operand of the instruction to be visited. This operand must be the internal name of an object or array class (see Type.getInternalName()).

      • visitVarInsn

        public void visitVarInsn​(int arg0,
                         int arg1)
        Description copied from class: MethodVisitor
        Visits a local variable instruction. A local variable instruction is an instruction that loads or stores the value of a local variable.
        Overrides:
        visitVarInsn in class MethodVisitor
        Parameters:
        arg0 - the opcode of the local variable instruction to be visited. This opcode is either ILOAD, LLOAD, FLOAD, DLOAD, ALOAD, ISTORE, LSTORE, FSTORE, DSTORE, ASTORE or RET.
        arg1 - the operand of the instruction to be visited. This operand is the index of a local variable.