Jakarta EE 11.0.0 · jakarta.persistence.PersistenceUnitUtil

Method Summary

Modifier and Type	Method and Description
public <T> Class<? extends T>	Returns: an entity class belonging to the persistence unit getClass(T entity instance entity) Return the concrete entity class if the given entity belonging to the persistence unit and to an open persistence context.
public Object	Returns: id of the entity getIdentifier(Object entity instance entity) Return the id of the entity.
public Object	Returns: id of the entity getVersion(Object entity instance entity) Return the version of the entity.
public boolean	isInstance(Object entity instance entity, Class<?> an entity class belonging to the persistence unit entityClass) Return true if the given entity belonging to the persistence unit and to an open persistence context is an instance of the given entity class, or false otherwise.
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 <E> boolean	Returns: false if entity's state has not been loaded or if the attribute state has not been loaded, else true isLoaded(E entity instance containing the attribute entity, Attribute<? super E, ?> attribute whose load state is to be determined attribute) 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.
public void	load(Object entity instance entity, String the name of the attribute to be loaded attributeName) Load the persistent value of a given persistent attribute of an entity belonging to the persistence unit and to an open persistence context.
public <E> void	load(E entity instance to be loaded entity, Attribute<? super E, ?> the attribute to be loaded attribute) Load the persistent value of a given persistent attribute of an entity belonging to the persistence unit and to an open persistence context.
public void	load(Object entity instance to be loaded entity) Load the persistent state of an entity belonging to the persistence unit and to an open persistence context.

Method Detail

getClass	back to summary
public <T> Class<? extends T> getClass(T entity) Return the concrete entity class if the given entity belonging to the persistence unit and to an open persistence context. This method may, but is not required to, load the given entity by side effect. Parameters entity:T entity instance Returns:Class<? extends T> an entity class belonging to the persistence unit Exceptions IllegalArgumentException: if the given object is not an instance of an entity class belonging to the persistence unit PersistenceException: if the entity is not associated with an open persistence context or cannot be loaded from the database Since 3.2

getClass

back to summary

public <T> Class<? extends T> getClass(T entity)

Return the concrete entity class if the given entity belonging to the persistence unit and to an open persistence context. This method may, but is not required to, load the given entity by side effect.

Parameters

entity:T: entity instance

Returns:Class<? extends T>

an entity class belonging to the persistence unit

Exceptions

IllegalArgumentException:: if the given object is not an instance of an entity class belonging to the persistence unit
PersistenceException:: if the entity is not associated with an open persistence context or cannot be loaded from the database

Since

3.2

getIdentifier	back 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

getIdentifier

back 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

getVersion	back to summary
public Object getVersion(Object entity) Return the version of the entity. A generated version 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 Since 3.2

getVersion

back to summary

public Object getVersion(Object entity)

Return the version of the entity. A generated version 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

Since

3.2

isInstance	back to summary
public boolean isInstance(Object entity, Class<?> entityClass) Return true if the given entity belonging to the persistence unit and to an open persistence context is an instance of the given entity class, or false otherwise. This method may, but is not required to, load the given entity by side effect. Parameters entity:Object entity instance entityClass:Class<?> an entity class belonging to the persistence unit Exceptions IllegalArgumentException: if the given object is not an instance of an entity class belonging to the persistence unit or if the given class is not an entity class belonging to the persistence unit PersistenceException: if the entity is not associated with an open persistence context or cannot be loaded from the database Since 3.2

isInstance

back to summary

public boolean isInstance(Object entity, Class<?> entityClass)

Return true if the given entity belonging to the persistence unit and to an open persistence context is an instance of the given entity class, or false otherwise. This method may, but is not required to, load the given entity by side effect.

Parameters

entity:Object: entity instance
entityClass:Class<?>: an entity class belonging to the persistence unit

Exceptions

IllegalArgumentException:: if the given object is not an instance of an entity class belonging to the persistence unit or if the given class is not an entity class belonging to the persistence unit
PersistenceException:: if the entity is not associated with an open persistence context or cannot be loaded from the database

Since

3.2

isLoaded	back 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

isLoaded

back 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

isLoaded	back to summary
public <E> boolean isLoaded(E entity, Attribute<? super E, ?> attribute) Determine the load state of a given persistent attribute of an entity belonging to the persistence unit. Parameters entity:E entity instance containing the attribute attribute:Attribute<? super E, ?> 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 Since 3.2

isLoaded

back to summary

public <E> boolean isLoaded(E entity, Attribute<? super E, ?> attribute)

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

Parameters

entity:E: entity instance containing the attribute
attribute:Attribute<? super E, ?>: 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

Since

3.2

isLoaded back to summary

isLoaded	back 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

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

load back to summary

load	back to summary
public void load(Object entity, String attributeName) Load the persistent value of a given persistent attribute of an entity belonging to the persistence unit and to an open persistence context. After this method returns, `isLoaded(Object, String)` must return true with the given entity instance and attribute. Parameters entity:Object entity instance attributeName:String the name of the attribute to be loaded Exceptions IllegalArgumentException: if the given object is not an instance of an entity class belonging to the persistence unit PersistenceException: if the entity is not associated with an open persistence context or cannot be loaded from the database Since 3.2

public void load(Object entity, String attributeName)

Load the persistent value of a given persistent attribute of an entity belonging to the persistence unit and to an open persistence context. After this method returns, isLoaded(Object, String) must return true with the given entity instance and attribute.

Parameters

entity:Object: entity instance
attributeName:String: the name of the attribute to be loaded

Exceptions

IllegalArgumentException:: if the given object is not an instance of an entity class belonging to the persistence unit
PersistenceException:: if the entity is not associated with an open persistence context or cannot be loaded from the database

Since

3.2

load back to summary

load	back to summary
public <E> void load(E entity, Attribute<? super E, ?> attribute) Load the persistent value of a given persistent attribute of an entity belonging to the persistence unit and to an open persistence context. After this method returns, `isLoaded(Object, Attribute)` must return true with the given entity instance and attribute. Parameters entity:E entity instance to be loaded attribute:Attribute<? super E, ?> the attribute to be loaded Exceptions IllegalArgumentException: if the given object is not an instance of an entity class belonging to the persistence unit PersistenceException: if the entity is not associated with an open persistence context or cannot be loaded from the database Since 3.2

public <E> void load(E entity, Attribute<? super E, ?> attribute)

Load the persistent value of a given persistent attribute of an entity belonging to the persistence unit and to an open persistence context. After this method returns, isLoaded(Object, Attribute) must return true with the given entity instance and attribute.

Parameters

entity:E: entity instance to be loaded
attribute:Attribute<? super E, ?>: the attribute to be loaded

Exceptions

IllegalArgumentException:: if the given object is not an instance of an entity class belonging to the persistence unit
PersistenceException:: if the entity is not associated with an open persistence context or cannot be loaded from the database

Since

3.2

load back to summary

load	back to summary
public void load(Object entity) Load the persistent state of an entity belonging to the persistence unit and to an open persistence context. After this method returns, `isLoaded(Object)` must return true with the given entity instance. Parameters entity:Object entity instance to be loaded Exceptions IllegalArgumentException: if the given object is not an instance of an entity class belonging to the persistence unit PersistenceException: if the entity is not associated with an open persistence context or cannot be loaded from the database Since 3.2

public void load(Object entity)

Load the persistent state of an entity belonging to the persistence unit and to an open persistence context. After this method returns, isLoaded(Object) must return true with the given entity instance.

Parameters

entity:Object: entity instance to be loaded

Exceptions

IllegalArgumentException:: if the given object is not an instance of an entity class belonging to the persistence unit
PersistenceException:: if the entity is not associated with an open persistence context or cannot be loaded from the database

Since

3.2

public Interface PersistenceUnitUtil

Method Summary

Method Detail