Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.bytecode.enhance.spi.EnhancementContext

Method Summary

Modifier and Type	Method and Description
public boolean	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. doBiDirectionalAssociationManagement(UnloadedField The field to check. field) Should we manage association of bi-directional persistent attributes for this field?
public boolean	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. doDirtyCheckingInline(UnloadedClass The descriptor of the class to check. classDescriptor) Deprecated for removal. Will be removed without replacement. See HHH-15641 Should we in-line dirty checking for persistent attributes for this class?
public boolean	Returns: `true` indicates that any direct access to fields of entities should be routed to the enhanced getter / setter method. doExtendedEnhancement(UnloadedClass The descriptor of the class to check. classDescriptor) Should we enhance field access to entities from this class?
public ClassLoader	Returns: The class loader that the enhancer can use. getLoadingClassLoader() Obtain access to the ClassLoader that can be used to load Class references.
public boolean	Returns: true/false hasLazyLoadableAttributes(UnloadedClass The class to check classDescriptor) Deprecated for removal. Will be removed without replacement. See HHH-15641 Does the given class define any lazy loadable attributes?
public boolean	Returns: `true` if the class is an embeddable/component; `false` otherwise. isCompositeClass(UnloadedClass The descriptor of the class to check. classDescriptor) Does the given class name represent an embeddable/component class?
public boolean	isDiscoveredType(UnloadedClass classDescriptor)
public boolean	Returns: `true` if the class is an entity; `false` otherwise. isEntityClass(UnloadedClass The descriptor of the class to check. classDescriptor) Does the given class descriptor represent an entity class?
public boolean	Returns: `true` if the field is lazy loadable; `false` otherwise. isLazyLoadable(UnloadedField The field to check field) Determine if a field is lazy loadable.
public boolean	Returns: `true` if the field is mapped isMappedCollection(UnloadedField the field to check field)
public boolean	Returns: `true` if the class is a mapped super class; `false` otherwise. isMappedSuperclassClass(UnloadedClass The descriptor of the class to check. classDescriptor) Does the given class name represent a MappedSuperclass class?
public boolean	Returns: `true` if the field is ; `false` otherwise. isPersistentField(UnloadedField The field reference. ctField) Does the field represent persistent state?
public UnloadedField[]	Returns: The ordered references. order(UnloadedField[] The persistent field references. persistentFields) For fields which are persistent (according to `isPersistentField`), determine the corresponding ordering maintained within the Hibernate metamodel.
public void	registerDiscoveredType(UnloadedClass classDescriptor, Type.PersistenceType type)

Method Detail

doBiDirectionalAssociationManagement back to summary

doBiDirectionalAssociationManagement	back to summary
public boolean doBiDirectionalAssociationManagement(UnloadedField field) Should we manage association of bi-directional persistent attributes for this field? Parameters field:UnloadedField The field to check. Returns:boolean `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.

public boolean doBiDirectionalAssociationManagement(UnloadedField field)

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

Parameters

field:UnloadedField: The field to check.

Returns:boolean

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 back to summary

doDirtyCheckingInline	back to summary
public boolean doDirtyCheckingInline(UnloadedClass classDescriptor) Deprecated for removal. Will be removed without replacement. See HHH-15641 Should we in-line dirty checking for persistent attributes for this class? Parameters classDescriptor:UnloadedClass The descriptor of the class to check. Returns:boolean `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. Annotations @Deprecated forRemoval:true

public boolean doDirtyCheckingInline(UnloadedClass classDescriptor)

Deprecated

for removal.

Will be removed without replacement. See HHH-15641

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

Parameters

classDescriptor:UnloadedClass: The descriptor of the class to check.

Returns:boolean

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.

Annotations

@Deprecated
forRemoval:true

doExtendedEnhancement back to summary

doExtendedEnhancement	back to summary
public boolean doExtendedEnhancement(UnloadedClass classDescriptor) Should we enhance field access to entities from this class? Parameters classDescriptor:UnloadedClass The descriptor of the class to check. Returns:boolean `true` indicates that any direct access to fields of entities should be routed to the enhanced getter / setter method.

public boolean doExtendedEnhancement(UnloadedClass classDescriptor)

Should we enhance field access to entities from this class?

Parameters

classDescriptor:UnloadedClass: The descriptor of the class to check.

Returns:boolean

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

getLoadingClassLoader back to summary

getLoadingClassLoader	back to summary
public 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 `jakarta.persistence.spi.PersistenceUnitInfo#getNewTempClassLoader()` Returns:ClassLoader The class loader that the enhancer can use.

public 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 jakarta.persistence.spi.PersistenceUnitInfo#getNewTempClassLoader()

Returns:ClassLoader: The class loader that the enhancer can use.

hasLazyLoadableAttributes	back to summary
public boolean hasLazyLoadableAttributes(UnloadedClass classDescriptor) Deprecated for removal. Will be removed without replacement. See HHH-15641 Does the given class define any lazy loadable attributes? Parameters classDescriptor:UnloadedClass The class to check Returns:boolean true/false Annotations @Deprecated forRemoval:true

hasLazyLoadableAttributes

back to summary

public boolean hasLazyLoadableAttributes(UnloadedClass classDescriptor)

Deprecated

for removal.

Will be removed without replacement. See HHH-15641

Does the given class define any lazy loadable attributes?

Parameters

classDescriptor:UnloadedClass: The class to check

Returns:boolean

true/false

Annotations

@Deprecated
forRemoval:true

isCompositeClass back to summary

isCompositeClass	back to summary
public boolean isCompositeClass(UnloadedClass classDescriptor) Does the given class name represent an embeddable/component class? Parameters classDescriptor:UnloadedClass The descriptor of the class to check. Returns:boolean `true` if the class is an embeddable/component; `false` otherwise.

public boolean isCompositeClass(UnloadedClass classDescriptor)

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

Parameters

classDescriptor:UnloadedClass: The descriptor of the class to check.

Returns:boolean

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

isDiscoveredType	back to summary
public boolean isDiscoveredType(UnloadedClass classDescriptor)

isEntityClass back to summary

isEntityClass	back to summary
public boolean isEntityClass(UnloadedClass classDescriptor) Does the given class descriptor represent an entity class? Parameters classDescriptor:UnloadedClass The descriptor of the class to check. Returns:boolean `true` if the class is an entity; `false` otherwise.

public boolean isEntityClass(UnloadedClass classDescriptor)

Does the given class descriptor represent an entity class?

Parameters

classDescriptor:UnloadedClass: The descriptor of the class to check.

Returns:boolean

true if the class is an entity; false otherwise.

isLazyLoadable back to summary

isLazyLoadable	back to summary
public boolean isLazyLoadable(UnloadedField field) Determine if a field is lazy loadable. Parameters field:UnloadedField The field to check Returns:boolean `true` if the field is lazy loadable; `false` otherwise.

public boolean isLazyLoadable(UnloadedField field)

Determine if a field is lazy loadable.

Parameters

field:UnloadedField: The field to check

Returns:boolean

true if the field is lazy loadable; false otherwise.

isMappedCollection	back to summary
public boolean isMappedCollection(UnloadedField field) Parameters field:UnloadedField the field to check Returns:boolean `true` if the field is mapped

isMappedSuperclassClass back to summary

isMappedSuperclassClass	back to summary
public boolean isMappedSuperclassClass(UnloadedClass classDescriptor) Does the given class name represent a MappedSuperclass class? Parameters classDescriptor:UnloadedClass The descriptor of the class to check. Returns:boolean `true` if the class is a mapped super class; `false` otherwise.

public boolean isMappedSuperclassClass(UnloadedClass classDescriptor)

Does the given class name represent a MappedSuperclass class?

Parameters

classDescriptor:UnloadedClass: The descriptor of the class to check.

Returns:boolean

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

isPersistentField back to summary

isPersistentField	back to summary
public boolean isPersistentField(UnloadedField 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:UnloadedField The field reference. Returns:boolean `true` if the field is ; `false` otherwise.

public boolean isPersistentField(UnloadedField 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:UnloadedField: The field reference.

Returns:boolean

true if the field is ; false otherwise.

order back to summary

order	back to summary
public UnloadedField[] order(UnloadedField[] persistentFields) For fields which are persistent (according to `isPersistentField`), determine the corresponding ordering maintained within the Hibernate metamodel. Parameters persistentFields:UnloadedField[] The persistent field references. Returns:UnloadedField[] The ordered references.

public UnloadedField[] order(UnloadedField[] persistentFields)

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

Parameters

persistentFields:UnloadedField[]: The persistent field references.

Returns:UnloadedField[]

The ordered references.

registerDiscoveredType	back to summary
public void registerDiscoveredType(UnloadedClass classDescriptor, Type.PersistenceType type)

public Interface EnhancementContext

Method Summary

Method Detail