javax.persistence.spi

インタフェース ProviderUtil

public interface ProviderUtil

永続化プロバイダによって実装されるユーティリティインタフェース。 このインタフェースはPersistenceUtilの実装によって呼び出され、 エンティティまたはエンティティの属性のロード状態を測定します。

導入されたバージョン:

Java Persistence 2.0

メソッドのサマリー

修飾子とタイプ	メソッドと説明
LoadState	isLoaded(java.lang.Object entity) エンティティがそれ自身により提供されており、FetchType.EAGERが指定されているすべての属性がロードされている状態だとプロバイダが判断した場合、 このメソッドはLoadState.LOADEDを返します。
LoadState	isLoadedWithoutReference(java.lang.Object entity, java.lang.String attributeName) エンティティがそれ自身により提供されており、指定された属性がロードされている状態だとプロバイダが測定した場合、 このメソッドはLoadState.LOADEDを返します。
LoadState	isLoadedWithReference(java.lang.Object entity, java.lang.String attributeName) エンティティがそれ自身により提供されており、指定された属性がロードされている状態だとプロバイダが測定した場合、 このメソッドはLoadState.LOADEDを返します。

メソッドの詳細

isLoadedWithoutReference

LoadState isLoadedWithoutReference(java.lang.Object entity,
                                   java.lang.String attributeName)

エンティティがそれ自身により提供されており、指定された属性がロードされている状態だとプロバイダが測定した場合、 このメソッドはLoadState.LOADEDを返します。

エンティティがそれ自身により提供されており、FetchType.EAGERを持つエンティティの属性がロードされていないか、 指定された属性がロードされていない状態だとプロバイダが測定した場合、このメソッドはLoadState.NOT_LOADEDを返します。

プロバイダがロード状態を測定できない場合、このメソッドはLoadState.UNKNOWNを返します。

エンティティが別のプロバイダーによって提供された場合、エンティティの状態のローディングをトリガーしてしまう可能性があるため、 このメソッドのプロバイダの実装では、属性値への参照を取得してはなりません。

パラメータ:

entity - エンティティのインスタンス

attributeName - ロード状態を測定される属性の名前

戻り値:

属性のロード状態

isLoadedWithReference

LoadState isLoadedWithReference(java.lang.Object entity,
                                java.lang.String attributeName)

エンティティがそれ自身により提供されており、指定された属性がロードされている状態だとプロバイダが測定した場合、 このメソッドはLoadState.LOADEDを返します。

エンティティがそれ自身により提供されており、FetchType.EAGERを持つエンティティの属性がロードされていないか、 指定された属性がロードされていない状態だとプロバイダが測定した場合、このメソッドはLoadState.NOT_LOADEDを返します。

プロバイダがロード状態を測定できない場合、このメソッドはLoadState.UNKNOWNを返します。

エンティティが別のプロバイダーによって提供された場合、エンティティの状態のローディングをトリガーしてしまう可能性があるため、 このメソッドのプロバイダの実装では、属性値への参照を取得してはなりません。 (このアクセスは属性ステートのロードをトリガーしてもよいプロバイダーがisLoadedWithoutReferenceによって既に測定されているため安全です。)

パラメータ:

entity - エンティティのインスタンス

attributeName - ロード状態を測定される属性の名前

戻り値:

属性のロード状態

isLoaded

LoadState isLoaded(java.lang.Object entity)

エンティティがそれ自身により提供されており、FetchType.EAGERが指定されているすべての属性がロードされている状態だとプロバイダが判断した場合、 このメソッドはLoadState.LOADEDを返します。

エンティティがそれ自身により提供されており、FetchType.EAGERを指定された属性の一つでもロードされていないとプロバイダが判断した場合、 このメソッドはLoadState.NOT_LOADEDを返します。

プロバイダがエンティティがそれ自身により提供されているかどうかを判断できない場合、このメソッドはLoadState.UNKNOWNを返します。

エンティティが別のプロバイダーによって提供された場合、エンティティの状態のローディングをトリガーしてしまう可能性があるため、 このメソッドのプロバイダの実装では、任意の属性値への参照を取得してはなりません。

パラメータ:

entity - ロード状態を測定されるエンティティ

戻り値:

エンティティのロード状態