JavaEE API 8.0.1 · javax.persistence.spi.ProviderUtil

Method Summary

Modifier and Type	Method and Description
public LoadState	Returns: load status of the entity isLoaded(Object whose loaded status is to be determined entity) If the provider determines that the entity has been provided by itself and that the state of all attributes for which `FetchType.EAGER` has been specified have been loaded, this method returns `LoadState.LOADED`.
public LoadState	Returns: load status of the attribute isLoadedWithoutReference(Object entity instance entity, String name of attribute whose load status is to be determined attributeName) If the provider determines that the entity has been provided by itself and that the state of the specified attribute has been loaded, this method returns `LoadState.LOADED`.
public LoadState	Returns: load status of the attribute isLoadedWithReference(Object entity instance entity, String name of attribute whose load status is to be determined attributeName) If the provider determines that the entity has been provided by itself and that the state of the specified attribute has been loaded, this method returns `LoadState.LOADED`.

Method Detail

isLoaded back to summary

isLoaded	back to summary
public LoadState isLoaded(Object entity) If the provider determines that the entity has been provided by itself and that the state of all attributes for which `FetchType.EAGER` has been specified have been loaded, this method returns `LoadState.LOADED`. If the provider determines that the entity has been provided by itself and that not all attributes with `FetchType.EAGER` have been loaded, this method returns `LoadState.NOT_LOADED`. If the provider cannot determine if the entity has been provided by itself, this method returns `LoadState.UNKNOWN`. The provider's implementation of this method must not obtain a reference to any attribute value, as this could trigger the loading of entity state if the entity has been provided by a different provider. Parameters entity:Object whose loaded status is to be determined Returns:LoadState load status of the entity

public LoadState isLoaded(Object entity)

If the provider determines that the entity has been provided by itself and that the state of all attributes for which FetchType.EAGER has been specified have been loaded, this method returns LoadState.LOADED.

If the provider determines that the entity has been provided by itself and that not all attributes with FetchType.EAGER have been loaded, this method returns LoadState.NOT_LOADED.

If the provider cannot determine if the entity has been provided by itself, this method returns LoadState.UNKNOWN.

The provider's implementation of this method must not obtain a reference to any attribute value, as this could trigger the loading of entity state if the entity has been provided by a different provider.

Parameters

entity:Object: whose loaded status is to be determined

Returns:LoadState

load status of the entity

isLoadedWithoutReference back to summary

isLoadedWithoutReference	back to summary
public LoadState isLoadedWithoutReference(Object entity, String attributeName) If the provider determines that the entity has been provided by itself and that the state of the specified attribute has been loaded, this method returns `LoadState.LOADED`. If the provider determines that the entity has been provided by itself and that either entity attributes with `FetchType.EAGER` have not been loaded or that the state of the specified attribute has not been loaded, this methods returns `LoadState.NOT_LOADED`. If a provider cannot determine the load state, this method returns `LoadState.UNKNOWN`. The provider's implementation of this method must not obtain a reference to an attribute value, as this could trigger the loading of entity state if the entity has been provided by a different provider. Parameters entity:Object entity instance attributeName:String name of attribute whose load status is to be determined Returns:LoadState load status of the attribute

public LoadState isLoadedWithoutReference(Object entity, String attributeName)

If the provider determines that the entity has been provided by itself and that the state of the specified attribute has been loaded, this method returns LoadState.LOADED.

If the provider determines that the entity has been provided by itself and that either entity attributes with FetchType.EAGER have not been loaded or that the state of the specified attribute has not been loaded, this methods returns LoadState.NOT_LOADED.

If a provider cannot determine the load state, this method returns LoadState.UNKNOWN.

The provider's implementation of this method must not obtain a reference to an attribute value, as this could trigger the loading of entity state if the entity has been provided by a different provider.

Parameters

entity:Object: entity instance
attributeName:String: name of attribute whose load status is to be determined

Returns:LoadState

load status of the attribute

isLoadedWithReference back to summary

isLoadedWithReference	back to summary
public LoadState isLoadedWithReference(Object entity, String attributeName) If the provider determines that the entity has been provided by itself and that the state of the specified attribute has been loaded, this method returns `LoadState.LOADED`. If a provider determines that the entity has been provided by itself and that either the entity attributes with `FetchType.EAGER` have not been loaded or that the state of the specified attribute has not been loaded, this method returns return `LoadState.NOT_LOADED`. If the provider cannot determine the load state, this method returns `LoadState.UNKNOWN`. The provider's implementation of this method is permitted to obtain a reference to the attribute value. (This access is safe because providers which might trigger the loading of the attribute state will have already been determined by `isLoadedWithoutReference`. ) Parameters entity:Object entity instance attributeName:String name of attribute whose load status is to be determined Returns:LoadState load status of the attribute

public LoadState isLoadedWithReference(Object entity, String attributeName)

If the provider determines that the entity has been provided by itself and that the state of the specified attribute has been loaded, this method returns LoadState.LOADED.

If a provider determines that the entity has been provided by itself and that either the entity attributes with FetchType.EAGER have not been loaded or that the state of the specified attribute has not been loaded, this method returns return LoadState.NOT_LOADED.

If the provider cannot determine the load state, this method returns LoadState.UNKNOWN.

The provider's implementation of this method is permitted to obtain a reference to the attribute value. (This access is safe because providers which might trigger the loading of the attribute state will have already been determined by isLoadedWithoutReference. )

Parameters

entity:Object: entity instance
attributeName:String: name of attribute whose load status is to be determined

Returns:LoadState

load status of the attribute

public Interface ProviderUtil

Method Summary

Method Detail