Top Description Methods
jakarta.persistence

public Interface PersistenceUnitUtil

extends PersistenceUtil
Utility interface between the application and the persistence provider managing the persistence unit.

The methods of this interface should only be invoked on entity instances obtained from or managed by entity managers for this persistence unit or on new entity instances.

Since
2.0

Method Summary

Modifier and TypeMethod and Description
public Object

Returns:

id of the entity
getIdentifier(Object
entity instance
entity)

Return the id of the entity.

public boolean

Returns:

false if entity's state has not been loaded or if the attribute state has not been loaded, else true
isLoaded(Object
entity instance containing the attribute
entity, String
name of attribute whose load state is to be determined
attributeName)

Redeclares jakarta.persistence.PersistenceUtil.isLoaded.

Determine the load state of a given persistent attribute of an entity belonging to the persistence unit.
public boolean

Returns:

false if the entity has not been loaded, else true
isLoaded(Object
entity instance whose load state is to be determined
entity)

Redeclares jakarta.persistence.PersistenceUtil.isLoaded.

Determine the load state of an entity belonging to the persistence unit.

Method Detail

getIdentifierback to summary
public Object getIdentifier(Object entity)

Return the id of the entity. A generated id is not guaranteed to be available until after the database insert has occurred. Returns null if the entity does not yet have an id.

Parameters
entity:Object

entity instance

Returns:Object

id of the entity

Exceptions
IllegalArgumentException:
if the object is found not to be an entity
isLoadedback to summary
public boolean isLoaded(Object entity, String attributeName)

Redeclares jakarta.persistence.PersistenceUtil.isLoaded.

Determine the load state of a given persistent attribute of an entity belonging to the persistence unit.

Parameters
entity:Object

entity instance containing the attribute

attributeName:String

name of attribute whose load state is to be determined

Returns:boolean

false if entity's state has not been loaded or if the attribute state has not been loaded, else true

isLoadedback to summary
public boolean isLoaded(Object entity)

Redeclares jakarta.persistence.PersistenceUtil.isLoaded.

Determine the load state of an entity belonging to the persistence unit. This method can be used to determine the load state of an entity passed as a reference. An entity is considered loaded if all attributes for which FetchType.EAGER has been specified have been loaded.

The isLoaded(Object, String) method should be used to determine the load state of an attribute. Not doing so might lead to unintended loading of state.

Parameters
entity:Object

entity instance whose load state is to be determined

Returns:boolean

false if the entity has not been loaded, else true