org.hibernate.bytecode.enhance.spi

Interface EnhancementContext

All Known Implementing Classes:

DefaultEnhancementContext

public interface EnhancementContext

The context for performing an enhancement. Enhancement can happen in any number of ways:

• Build time, via Ant
• Build time, via Maven
• Build time, via Gradle
• Runtime, via agent
• Runtime, via JPA constructs

This interface isolates the code that actually does the enhancement from the underlying context in which the enhancement is being performed.

Author:

Steve Ebersole

Method Summary

Modifier and Type	Method and Description
boolean	doBiDirectionalAssociationManagement(javassist.CtField field) Should we manage association of bi-directional persistent attributes for this field?
boolean	doDirtyCheckingInline(javassist.CtClass classDescriptor) Should we in-line dirty checking for persistent attributes for this class?
boolean	doExtendedEnhancement(javassist.CtClass classDescriptor) Should we enhance field access to entities from this class?
ClassLoader	getLoadingClassLoader() Obtain access to the ClassLoader that can be used to load Class references.
boolean	hasLazyLoadableAttributes(javassist.CtClass classDescriptor) Does the given class define any lazy loadable attributes?
boolean	isCompositeClass(javassist.CtClass classDescriptor) Does the given class name represent an embeddable/component class?
boolean	isEntityClass(javassist.CtClass classDescriptor) Does the given class descriptor represent a entity class?
boolean	isLazyLoadable(javassist.CtField field) Determine if a field is lazy loadable.
boolean	isMappedCollection(javassist.CtField field)
boolean	isMappedSuperclassClass(javassist.CtClass classDescriptor) Does the given class name represent an MappedSuperclass class?
boolean	isPersistentField(javassist.CtField ctField) Does the field represent persistent state? Persistent fields will be "enhanced".
javassist.CtField[]	order(javassist.CtField[] persistentFields) For fields which are persistent (according to isPersistentField(javassist.CtField)), determine the corresponding ordering maintained within the Hibernate metamodel.

Method Detail

getLoadingClassLoader

ClassLoader getLoadingClassLoader()

Obtain access to the ClassLoader that can be used to load Class references. In JPA SPI terms, this should be a "temporary class loader" as defined by PersistenceUnitInfo.getNewTempClassLoader()

Returns:

The class loader that the enhancer can use.

isEntityClass

boolean isEntityClass(javassist.CtClass classDescriptor)

Does the given class descriptor represent a entity class?

Parameters:

classDescriptor - The descriptor of the class to check.

Returns:

true if the class is an entity; false otherwise.

isCompositeClass

boolean isCompositeClass(javassist.CtClass classDescriptor)

Does the given class name represent an embeddable/component class?

Parameters:

classDescriptor - The descriptor of the class to check.

Returns:

true if the class is an embeddable/component; false otherwise.

isMappedSuperclassClass

boolean isMappedSuperclassClass(javassist.CtClass classDescriptor)

Does the given class name represent an MappedSuperclass class?

Parameters:

classDescriptor - The descriptor of the class to check.

Returns:

true if the class is an mapped super class; false otherwise.

doBiDirectionalAssociationManagement

boolean doBiDirectionalAssociationManagement(javassist.CtField field)

Should we manage association of bi-directional persistent attributes for this field?

Parameters:

field - The field to check.

Returns:

true indicates that the field is enhanced so that for bi-directional persistent fields the association is managed, i.e. the associations are automatically set; false indicates that the management is handled by the user.

doDirtyCheckingInline

boolean doDirtyCheckingInline(javassist.CtClass classDescriptor)

Should we in-line dirty checking for persistent attributes for this class?

Parameters:

classDescriptor - The descriptor of the class to check.

Returns:

true indicates that dirty checking should be in-lined within the entity; false indicates it should not. In-lined is more easily serializable and probably more performant.

doExtendedEnhancement

boolean doExtendedEnhancement(javassist.CtClass classDescriptor)

Should we enhance field access to entities from this class?

Parameters:

classDescriptor - The descriptor of the class to check.

Returns:

true indicates that any direct access to fields of entities should be routed to the enhanced getter / setter method.

hasLazyLoadableAttributes

boolean hasLazyLoadableAttributes(javassist.CtClass classDescriptor)

Does the given class define any lazy loadable attributes?

Parameters:

classDescriptor - The class to check

Returns:

true/false

isPersistentField

boolean isPersistentField(javassist.CtField ctField)

Does the field represent persistent state? Persistent fields will be "enhanced".

may be better to perform basic checks in the caller (non-static, etc) and call out with just the Class name and field name...

Parameters:

ctField - The field reference.

Returns:

true if the field is ; false otherwise.

order

javassist.CtField[] order(javassist.CtField[] persistentFields)

For fields which are persistent (according to isPersistentField(javassist.CtField)), determine the corresponding ordering maintained within the Hibernate metamodel.

Parameters:

persistentFields - The persistent field references.

Returns:

The ordered references.

isLazyLoadable

boolean isLazyLoadable(javassist.CtField field)

Determine if a field is lazy loadable.

Parameters:

field - The field to check

Returns:

true if the field is lazy loadable; false otherwise.

isMappedCollection

boolean isMappedCollection(javassist.CtField field)

Parameters:

field - the field to check

Returns:

true if the field is mapped