パッケージ jakarta.persistence
インターフェース PersistenceUnitUtil
- すべてのスーパーインターフェース:
PersistenceUtil
永続性ユニットを管理するアプリケーションと永続性プロバイダー間のユーティリティインターフェース。
このインターフェースのメソッドは、この永続性ユニットのエンティティマネージャーから取得または管理されるエンティティインスタンス、または新しいエンティティインスタンスでのみ呼び出す必要があります。
- 導入:
- 2.0
メソッドのサマリー
修飾子と型メソッド説明<T> ClassSE<? extends T>
getClass
(T entity) 指定されたエンティティが永続ユニットおよびオープン永続コンテキストに属している場合は、具体的なエンティティクラスを返します。getIdentifier
(ObjectSE entity) エンティティの ID を返します。getVersion
(ObjectSE entity) エンティティのバージョンを返します。boolean
isInstance
(ObjectSE entity, ClassSE<?> entityClass) 永続化ユニットおよびオープン永続化コンテキストに属する指定されたエンティティが指定されたエンティティクラスのインスタンスである場合は true を返し、それ以外の場合は false を返します。<E> boolean
永続性ユニットに属するエンティティの特定の永続的属性の負荷状態を判別します。boolean
永続性ユニットに属するエンティティのロード状態を判別します。boolean
永続性ユニットに属するエンティティの特定の永続的属性の負荷状態を判別します。<E> void
永続ユニットおよびオープン永続コンテキストに属するエンティティの特定の永続属性の永続値をロードします。void
永続ユニットおよびオープン永続コンテキストに属するエンティティの永続状態をロードします。void
永続ユニットおよびオープン永続コンテキストに属するエンティティの特定の永続属性の永続値をロードします。
メソッドの詳細
isLoaded
永続性ユニットに属するエンティティの特定の永続的属性の負荷状態を判別します。- 次で指定:
- インターフェース
PersistenceUtil
のisLoaded
- パラメーター:
entity
- 属性を含むエンティティインスタンスattributeName
- 負荷状態を決定する属性の名前- 戻り値:
- エンティティの状態がロードされていない場合、または属性の状態がロードされていない場合は false、それ以外の場合は true
isLoaded
永続性ユニットに属するエンティティの特定の永続的属性の負荷状態を判別します。- パラメーター:
entity
- 属性を含むエンティティインスタンスattribute
- 負荷状態を決定する属性- 戻り値:
- エンティティの状態がロードされていない場合、または属性の状態がロードされていない場合は false、それ以外の場合は true
- 導入:
- 3.2
isLoaded
永続化ユニットに属するエンティティのロード状態を確認します。このメソッドは、参照として渡されたエンティティの負荷状態を判断するために使用できます。FetchType.EAGER
が指定されているすべての属性がロードされている場合、エンティティはロードされているとみなされます。属性のロード状態を判断するには、
isLoaded(Object, String)
メソッドを使用する必要があります。そうしないと、意図しない状態のロードが発生する可能性があります。- 次で指定:
- インターフェース
PersistenceUtil
のisLoaded
- パラメーター:
entity
- 負荷状態が決定されるエンティティインスタンス- 戻り値:
- エンティティがロードされていない場合は false、それ以外の場合は true
load
永続ユニットおよびオープン永続コンテキストに属するエンティティの特定の永続属性の永続値をロードします。このメソッドが返された後、isLoaded(Object,String)
は指定されたエンティティインスタンスと属性を使用して true を返す必要があります。- パラメーター:
entity
- エンティティインスタンスattributeName
- ロードされる属性の名前- 例外:
IllegalArgumentExceptionSE
- 指定されたオブジェクトが永続化ユニットに属するエンティティクラスのインスタンスではない場合PersistenceException
- エンティティがオープン永続コンテキストに関連付けられていない場合、またはデータベースからロードできない場合- 導入:
- 3.2
load
永続ユニットおよびオープン永続コンテキストに属するエンティティの特定の永続属性の永続値をロードします。このメソッドが返された後、isLoaded(Object,Attribute)
は指定されたエンティティインスタンスと属性を使用して true を返す必要があります。- パラメーター:
entity
- ロードされるエンティティインスタンスattribute
- ロードされる属性- 例外:
IllegalArgumentExceptionSE
- 指定されたオブジェクトが永続化ユニットに属するエンティティクラスのインスタンスではない場合PersistenceException
- エンティティがオープン永続コンテキストに関連付けられていない場合、またはデータベースからロードできない場合- 導入:
- 3.2
load
永続ユニットおよびオープン永続コンテキストに属するエンティティの永続状態をロードします。このメソッドが戻った後、isLoaded(Object)
は指定されたエンティティインスタンスで true を返す必要があります。- パラメーター:
entity
- ロードされるエンティティインスタンス- 例外:
IllegalArgumentExceptionSE
- 指定されたオブジェクトが永続化ユニットに属するエンティティクラスのインスタンスではない場合PersistenceException
- エンティティがオープン永続コンテキストに関連付けられていない場合、またはデータベースからロードできない場合- 導入:
- 3.2
isInstance
永続化ユニットおよびオープン永続化コンテキストに属する指定されたエンティティが指定されたエンティティクラスのインスタンスである場合は true を返し、それ以外の場合は false を返します。このメソッドは、副作用として指定されたエンティティをロードする可能性がありますが、必ずロードする必要はありません。- パラメーター:
entity
- エンティティインスタンスentityClass
- 永続化ユニットに属するエンティティクラス- 例外:
IllegalArgumentExceptionSE
- 指定されたオブジェクトが永続化ユニットに属するエンティティクラスのインスタンスではない場合、または指定されたクラスが永続化ユニットに属するエンティティクラスではない場合PersistenceException
- エンティティがオープン永続コンテキストに関連付けられていない場合、またはデータベースからロードできない場合- 導入:
- 3.2
getClass
指定されたエンティティが永続ユニットおよびオープン永続コンテキストに属している場合は、具体的なエンティティクラスを返します。このメソッドは、副作用として指定されたエンティティをロードする可能性がありますが、必ずロードする必要はありません。- パラメーター:
entity
- エンティティインスタンス- 戻り値:
- 永続化ユニットに属するエンティティクラス
- 例外:
IllegalArgumentExceptionSE
- 指定されたオブジェクトが永続化ユニットに属するエンティティクラスのインスタンスではない場合PersistenceException
- エンティティがオープン永続コンテキストに関連付けられていない場合、またはデータベースからロードできない場合- 導入:
- 3.2
getIdentifier
エンティティの ID を返します。生成された ID は、データベースの挿入が行われるまで使用可能であることが保証されていません。エンティティにまだ ID がない場合は、null を返します。- パラメーター:
entity
- エンティティインスタンス- 戻り値:
- エンティティの ID
- 例外:
IllegalArgumentExceptionSE
- オブジェクトがエンティティではないことが判明した場合
getVersion
エンティティのバージョンを返します。生成されたバージョンは、データベースの挿入が行われるまで使用可能であることは保証されません。エンティティに ID がまだない場合は null を返します。- パラメーター:
entity
- エンティティインスタンス- 戻り値:
- エンティティの ID
- 例外:
IllegalArgumentExceptionSE
- オブジェクトがエンティティではないことが判明した場合- 導入:
- 3.2