oracle.toplink.essentials.internal.weaving

Class TopLinkClassWeaver

java.lang.Object

oracle.toplink.libraries.asm.ClassAdapter

oracle.toplink.essentials.internal.weaving.TopLinkClassWeaver

All Implemented Interfaces:

ClassVisitor, Constants

public class TopLinkClassWeaver
extends ClassAdapter
implements Constants

INTERNAL: Weaves classes to allow them to support TopLink indirection. Classes are weaved to add a variable of type ValueHolderInterface for each attribute that uses indirection. In addition, access methods are added for the new variable. Also, triggers the process of weaving the methods of the class.

See Also:

TopLinkMethodWeaver

Field Summary

Fields

Modifier and Type	Field and Description
boolean	alreadyWeaved
protected ClassDetails	classDetails
static java.lang.String	TW_SHORT_SIGNATURE
static java.lang.String	VH_SHORT_SIGNATURE
static java.lang.String	VHI_CLASSNAME
static java.lang.String	VHI_SHORT_SIGNATURE
static java.lang.String	VHI_SIGNATURE
boolean	weavedVH

Fields inherited from class oracle.toplink.libraries.asm.ClassAdapter

cv

Fields inherited from interface oracle.toplink.libraries.asm.Constants

AALOAD, AASTORE, ACC_ABSTRACT, ACC_ANNOTATION, ACC_BRIDGE, ACC_DEPRECATED, ACC_ENUM, ACC_FINAL, ACC_INTERFACE, ACC_NATIVE, ACC_PRIVATE, ACC_PROTECTED, ACC_PUBLIC, ACC_STATIC, ACC_STRICT, ACC_SUPER, ACC_SYNCHRONIZED, ACC_SYNTHETIC, ACC_TRANSIENT, ACC_VARARGS, ACC_VOLATILE, ACONST_NULL, ALOAD, ANEWARRAY, ARETURN, ARRAYLENGTH, ASTORE, ATHROW, BALOAD, BASTORE, BIPUSH, CALOAD, CASTORE, CHECKCAST, D2F, D2I, D2L, DADD, DALOAD, DASTORE, DCMPG, DCMPL, DCONST_0, DCONST_1, DDIV, DLOAD, DMUL, DNEG, DREM, DRETURN, DSTORE, DSUB, DUP, DUP_X1, DUP_X2, DUP2, DUP2_X1, DUP2_X2, F2D, F2I, F2L, FADD, FALOAD, FASTORE, FCMPG, FCMPL, FCONST_0, FCONST_1, FCONST_2, FDIV, FLOAD, FMUL, FNEG, FREM, FRETURN, FSTORE, FSUB, GETFIELD, GETSTATIC, GOTO, I2B, I2C, I2D, I2F, I2L, I2S, IADD, IALOAD, IAND, IASTORE, ICONST_0, ICONST_1, ICONST_2, ICONST_3, ICONST_4, ICONST_5, ICONST_M1, IDIV, IF_ACMPEQ, IF_ACMPNE, IF_ICMPEQ, IF_ICMPGE, IF_ICMPGT, IF_ICMPLE, IF_ICMPLT, IF_ICMPNE, IFEQ, IFGE, IFGT, IFLE, IFLT, IFNE, IFNONNULL, IFNULL, IINC, ILOAD, IMUL, INEG, INSTANCEOF, INVOKEINTERFACE, INVOKESPECIAL, INVOKESTATIC, INVOKEVIRTUAL, IOR, IREM, IRETURN, ISHL, ISHR, ISTORE, ISUB, IUSHR, IXOR, JSR, L2D, L2F, L2I, LADD, LALOAD, LAND, LASTORE, LCMP, LCONST_0, LCONST_1, LDC, LDIV, LLOAD, LMUL, LNEG, LOOKUPSWITCH, LOR, LREM, LRETURN, LSHL, LSHR, LSTORE, LSUB, LUSHR, LXOR, MONITORENTER, MONITOREXIT, MULTIANEWARRAY, NEW, NEWARRAY, NOP, POP, POP2, PUTFIELD, PUTSTATIC, RET, RETURN, SALOAD, SASTORE, SIPUSH, SWAP, T_BOOLEAN, T_BYTE, T_CHAR, T_DOUBLE, T_FLOAT, T_INT, T_LONG, T_SHORT, TABLESWITCH, V1_1, V1_2, V1_3, V1_4, V1_5

Constructor Summary

Constructors

Constructor and Description
TopLinkClassWeaver(ClassWriter classWriter, ClassDetails classDetails)

Method Summary

Modifier and Type	Method and Description
void	addGetterMethodForFieldAccess(ClassDetails classDetails, AttributeDetails attributeDetails) INTERNAL: Adds a convenience method used to replace a GETFIELD when field access is used.
void	addGetterMethodForValueHolder(ClassDetails classDetails, AttributeDetails attributeDetails) INTERNAL: Add a get method for the newly added valueholder.
void	addSetterMethodForFieldAccess(ClassDetails classDetails, AttributeDetails attributeDetails) INTERNAL: Adds a convenience method used to replace a PUTFIELD when field access is used.
void	addSetterMethodForValueHolder(ClassDetails classDetails, AttributeDetails attributeDetails) INTERNAL: Add a set method for the newly added ValueHolder.
void	addValueHolder(AttributeDetails attributeDetails) INTERNAL: Add a variable of type ValueHolderInterface to the class.
void	visit(int version, int access, java.lang.String name, java.lang.String superName, java.lang.String[] interfaces, java.lang.String sourceFile) Visits the header of the class.
void	visitAttribute(Attribute attr) Visits a non standard attribute of the class.
void	visitEnd() Visits the end of the class.
CodeVisitor	visitMethod(int access, java.lang.String methodName, java.lang.String desc, java.lang.String[] exceptions, Attribute attrs) INTERNAL: Construct a TopLinkMethodWeaver and allow it to process the method.

Methods inherited from class oracle.toplink.libraries.asm.ClassAdapter

visitField, visitInnerClass

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VHI_CLASSNAME

public static final java.lang.String VHI_CLASSNAME

See Also:

Constant Field Values

VH_SHORT_SIGNATURE

public static final java.lang.String VH_SHORT_SIGNATURE

See Also:

Constant Field Values

VHI_SHORT_SIGNATURE

public static final java.lang.String VHI_SHORT_SIGNATURE

See Also:

Constant Field Values

VHI_SIGNATURE

public static final java.lang.String VHI_SIGNATURE

See Also:

Constant Field Values

TW_SHORT_SIGNATURE

public static final java.lang.String TW_SHORT_SIGNATURE

See Also:

Constant Field Values

classDetails

protected ClassDetails classDetails

alreadyWeaved

public boolean alreadyWeaved

weavedVH

public boolean weavedVH

Constructor Detail

TopLinkClassWeaver

public TopLinkClassWeaver(ClassWriter classWriter,
                          ClassDetails classDetails)

Method Detail

addValueHolder

public void addValueHolder(AttributeDetails attributeDetails)

INTERNAL: Add a variable of type ValueHolderInterface to the class. When this method has been run, the class will contain a variable declaration similar to the following: private ValueHolderInterface _toplink_variableName_vh;

addGetterMethodForValueHolder

public void addGetterMethodForValueHolder(ClassDetails classDetails,
                                          AttributeDetails attributeDetails)

INTERNAL: Add a get method for the newly added valueholder. Adds a method of the following form: public WeavedAttributeValueHolderInterface _toplink_getfoo_vh(){ if (_toplink_foo_vh.isCoordinatedWithProperty() || _toplink_foo_vh.isNewlyWeavedValueHolder()){ EntityC object = getFoo(); if (object != _toplink_foo_vh.getValue()){ setFoo(object); } } return _toplink_foo_vh; }

addSetterMethodForValueHolder

public void addSetterMethodForValueHolder(ClassDetails classDetails,
                                          AttributeDetails attributeDetails)

INTERNAL: Add a set method for the newly added ValueHolder. Adds a method of this form: public void _toplink_setfoo_vh(WeavedAttributeValueHolderInterface valueholderinterface){ _toplink_foo_vh = valueholderinterface; if (valueholderinterface.isInstantiated()){ Object object = getFoo(); Object value = valueholderinterface.getValue(); if (object != value){ setFoo((EntityC)value); } } }

addSetterMethodForFieldAccess

public void addSetterMethodForFieldAccess(ClassDetails classDetails,
                                          AttributeDetails attributeDetails)

INTERNAL: Adds a convenience method used to replace a PUTFIELD when field access is used. The method follows the following form: public void _toplink_setvariableName( item) { _toplink_variableName_vh.setValue(item); this.item = item; }

addGetterMethodForFieldAccess

public void addGetterMethodForFieldAccess(ClassDetails classDetails,
                                          AttributeDetails attributeDetails)

INTERNAL: Adds a convenience method used to replace a GETFIELD when field access is used. The method follows the following form: public _toplink_getvariableName(){ this.item = ()_toplink_variableName_vh.getValue(); return this.item; }

visit

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

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 Constants). This parameter also indicates if the class is deprecated.

name - the internal name of the class (see getInternalName).

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 java.lang.Object class.

interfaces - the internal names of the class's interfaces (see getInternalName). May be null.

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

visitMethod

public CodeVisitor visitMethod(int access,
                               java.lang.String methodName,
                               java.lang.String desc,
                               java.lang.String[] exceptions,
                               Attribute attrs)

INTERNAL: Construct a TopLinkMethodWeaver and allow it to process the method.

Specified by:

visitMethod in interface ClassVisitor

Overrides:

visitMethod in class ClassAdapter

Parameters:

access - the method's access flags (see Constants). This parameter also indicates if the method is synthetic and/or deprecated.

methodName - the method's name.

desc - the method's descriptor (see Type).

exceptions - the internal names of the method's exception classes (see getInternalName). May be null.

attrs - the non standard method attributes, linked together by their next field. 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.

visitAttribute

public void visitAttribute(Attribute attr)

Description copied from interface: ClassVisitor

Visits a non standard attribute of the class. This method must visit only the first attribute in the given attribute list.

Specified by:

visitAttribute in interface ClassVisitor

Overrides:

visitAttribute in class ClassAdapter

Parameters:

attr - a non standard class attribute. Must not be null.

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