Uses of Interface
org.hibernate.collection.spi.PersistentCollection

Packages that use PersistentCollection

Package	Description
org.hibernate.cache.spi.entry	This package defines formats for disassembled state kept in the second level cache.
org.hibernate.collection.spi	This package defines the SPI of a framework for lazy-initializing and state-tracking collection wrappers.
org.hibernate.engine.spi	This package defines some central internal SPI abstractions used throughout the implementation of Hibernate.
org.hibernate.envers.event.spi
org.hibernate.event.spi	Defines the event types and event listener interfaces for events produced by the stateful Session.
org.hibernate.loader.ast.spi
org.hibernate.persister.collection	This package abstracts persistence mechanisms for collections.
org.hibernate.persister.collection.mutation	Defines support for performing mutation operations against collections.
org.hibernate.pretty	Contains some functions for pretty-printing things for exception and log messages.
org.hibernate.sql.results.graph.collection
org.hibernate.type	A Hibernate Type is a strategy for mapping a Java property type to a JDBC type or types.
org.hibernate.usertype	An API for user-defined custom types which extend the set of built-in types defined in org.hibernate.type.

Uses of PersistentCollection in org.hibernate.cache.spi.entry

Methods in org.hibernate.cache.spi.entry with parameters of type PersistentCollection

Modifier and Type	Method	Description
void	CollectionCacheEntry.assemble(PersistentCollection<?> collection, CollectionPersister persister, Object owner)	Assembles the collection from the cached state.

Constructors in org.hibernate.cache.spi.entry with parameters of type PersistentCollection

Modifier	Constructor	Description
	CollectionCacheEntry(PersistentCollection<?> collection, CollectionPersister persister)	Constructs a CollectionCacheEntry

Uses of PersistentCollection in org.hibernate.collection.spi

Classes in org.hibernate.collection.spi that implement PersistentCollection

Modifier and Type	Class	Description
class	AbstractPersistentCollection<E>	Base class implementing PersistentCollection
class	PersistentArrayHolder<E>	A dummy collection wrapper for an array.
class	PersistentBag<E>	An unordered, un-keyed collection that can contain the same element multiple times.
class	PersistentIdentifierBag<E>	An "identifier bag" implements "bag" semantics more efficiently than a regular bag by adding a synthetic identifier column to the table.
class	PersistentList<E>	A persistent wrapper for a List.
class	PersistentMap<K,E>	A persistent wrapper for a Map.
class	PersistentSet<E>	A persistent wrapper for a Set.
class	PersistentSortedMap<K,E>	A persistent wrapper for a SortedMap.
class	PersistentSortedSet<E>	A persistent wrapper for a SortedSet.

Methods in org.hibernate.collection.spi that return PersistentCollection

Modifier and Type	Method	Description
PersistentCollection<E>	CollectionSemantics.instantiateWrapper(Object key, CollectionPersister collectionDescriptor, SharedSessionContractImplementor session)	Create a wrapper for the collection
PersistentCollection<E>	CollectionSemantics.wrap(CE rawCollection, CollectionPersister collectionDescriptor, SharedSessionContractImplementor session)	Wrap a raw collection in wrapper

Methods in org.hibernate.collection.spi with parameters of type PersistentCollection

Modifier and Type	Method	Description
static void	AbstractPersistentCollection.checkPersister(PersistentCollection<?> collection, CollectionPersister persister)
default boolean	PersistentCollection.includeInInsert(Object entry, int entryPosition, PersistentCollection<?> collection, PluralAttributeMapping attributeDescriptor)	Whether to include the entry for insertion operations
default boolean	PersistentCollection.includeInRecreate(Object entry, int i, PersistentCollection<?> collection, PluralAttributeMapping attributeDescriptor)	Whether the given entry should be included in recreation events

Uses of PersistentCollection in org.hibernate.engine.spi

Methods in org.hibernate.engine.spi that return PersistentCollection

Modifier and Type	Method	Description
PersistentCollection<?>	PersistenceContext.addCollectionByKey(CollectionKey collectionKey, PersistentCollection<?> persistentCollection)	Adds a collection in the collections-by-key map.
PersistentCollection<?>	PersistenceContext.getCollection(CollectionKey collectionKey)	Get the collection instance associated with the CollectionKey
PersistentCollection<?>	PersistenceContext.getCollectionHolder(Object array)	Get the PersistentCollection object for an array
PersistentCollection<?>	PersistenceContext.removeCollectionHolder(Object array)	Remove the mapping of collection to holder during eviction of the owning entity
PersistentCollection<?>	PersistenceContext.useUnownedCollection(CollectionKey key)	Take ownership of a previously unowned collection, if one.

Methods in org.hibernate.engine.spi that return types with arguments of type PersistentCollection

Modifier and Type	Method	Description
@Nullable Map<PersistentCollection<?>,CollectionEntry>	PersistenceContext.getCollectionEntries()	Doubly internal
Map<CollectionKey,PersistentCollection<?>>	PersistenceContext.getCollectionsByKey()	Deprecated. this method should be removed; alternative methods are available that better express the intent, allowing for better optimisations.

Methods in org.hibernate.engine.spi with parameters of type PersistentCollection

Modifier and Type	Method	Description
void	BatchFetchQueue.addBatchLoadableCollection(PersistentCollection<?> collection, CollectionEntry ce)	If a CollectionEntry represents a batch loadable collection, add it to the queue.
PersistentCollection<?>	PersistenceContext.addCollectionByKey(CollectionKey collectionKey, PersistentCollection<?> persistentCollection)	Adds a collection in the collections-by-key map.
void	PersistenceContext.addCollectionHolder(PersistentCollection<?> holder)	Register a PersistentCollection object for an array.
CollectionEntry	PersistenceContext.addInitializedCollection(CollectionPersister persister, PersistentCollection<?> collection, Object id)	add a collection we just pulled out of the cache (does not need initializing)
void	PersistenceContext.addInitializedDetachedCollection(CollectionPersister collectionPersister, PersistentCollection<?> collection)	add an (initialized) collection that was created by another session and passed into update() (ie.
void	PersistenceContext.addNewCollection(CollectionPersister persister, PersistentCollection<?> collection)	Add a new collection (ie.
void	PersistenceContext.addNonLazyCollection(PersistentCollection<?> collection)	Register a collection for non-lazy loading at the end of the two-phase load
void	PersistenceContext.addUninitializedCollection(CollectionPersister persister, PersistentCollection<?> collection, Object id)	add a collection we just loaded up (still needs initializing)
void	PersistenceContext.addUninitializedDetachedCollection(CollectionPersister persister, PersistentCollection<?> collection)	add a detached uninitialized collection
void	CollectionEntry.afterAction(PersistentCollection<?> collection)	Called after execution of an action
boolean	PersistenceContext.containsCollection(PersistentCollection<?> collection)	Is the given collection associated with this persistence context?
CollectionEntry	PersistenceContext.getCollectionEntry(PersistentCollection<?> coll)	Get the collection entry for a persistent collection
Object	PersistenceContext.getLoadedCollectionOwnerIdOrNull(PersistentCollection<?> collection)	Get the ID for the entity that owned this persistent collection when it was loaded
Object	PersistenceContext.getLoadedCollectionOwnerOrNull(PersistentCollection<?> collection)	Get the entity that owned this persistent collection when it was loaded
Collection<?>	CollectionEntry.getOrphans(String entityName, PersistentCollection<?> collection)	Get the collection orphans (entities which were removed from the collection)
Serializable	PersistenceContext.getSnapshot(PersistentCollection<?> coll)	Get the snapshot of the pre-flush collection state
void	SessionDelegatorBaseImpl.initializeCollection(PersistentCollection<?> collection, boolean writing)
void	SharedSessionContractImplementor.initializeCollection(PersistentCollection<?> collection, boolean writing)	Initialize the given collection (if not already initialized).
void	SharedSessionDelegatorBaseImpl.initializeCollection(PersistentCollection<?> collection, boolean writing)
boolean	CollectionEntry.isSnapshotEmpty(PersistentCollection<?> collection)
void	EntityEntry.overwriteLoadedStateCollectionValue(String propertyName, PersistentCollection<?> collection)
void	CollectionEntry.postFlush(PersistentCollection<?> collection)	Called after a successful flush
void	CollectionEntry.postInitialize(PersistentCollection<?> collection, SharedSessionContractImplementor session)
void	CollectionEntry.preFlush(PersistentCollection<?> collection)
CollectionEntry	PersistenceContext.removeCollectionEntry(PersistentCollection<?> collection)	Remove a PersistentCollection from the PersistenceContext.
void	PersistenceContext.replaceCollection(CollectionPersister persister, PersistentCollection<?> oldCollection, PersistentCollection<?> collection)	Replaces a directly accessible collection with the given one
void	CollectionEntry.resetStoredSnapshot(PersistentCollection<?> collection, Serializable storedSnapshot)	Reset the stored snapshot for both the persistent collection and this collection entry.

Method parameters in org.hibernate.engine.spi with type arguments of type PersistentCollection

Modifier and Type	Method	Description
void	PersistenceContext.forEachCollectionEntry(BiConsumer<PersistentCollection<?>,CollectionEntry> action, boolean concurrent)	Execute some action on each entry of the collectionEntries map, optionally iterating on a defensive copy.
void	PersistenceContext.initializeNonLazyCollections(Consumer<PersistentCollection<?>> initializeAction)	Force initialization of all non-lazy collections encountered during the current two-phase load (actually, this is a no-op, unless this is the "outermost" load) allowing to customize how the initialization should occur

Constructors in org.hibernate.engine.spi with parameters of type PersistentCollection

Modifier	Constructor	Description
	CollectionEntry(PersistentCollection<?> collection, SessionFactoryImplementor factory)	For initialized detached collections
	CollectionEntry(PersistentCollection<?> collection, CollectionPersister loadedPersister, Object loadedKey, boolean ignore)	For collections just loaded from the database
	CollectionEntry(CollectionPersister persister, PersistentCollection<?> collection)	For newly wrapped collections, or dereferenced collection wrappers

Uses of PersistentCollection in org.hibernate.envers.event.spi

Methods in org.hibernate.envers.event.spi with parameters of type PersistentCollection

Modifier and Type	Method	Description
protected final void	BaseEnversCollectionEventListener.onCollectionAction(AbstractCollectionEvent event, PersistentCollection newColl, Serializable oldColl, CollectionEntry collectionEntry)
protected final void	BaseEnversCollectionEventListener.onCollectionActionInversed(AbstractCollectionEvent event, PersistentCollection newColl, Serializable oldColl, CollectionEntry collectionEntry)

Uses of PersistentCollection in org.hibernate.event.spi

Methods in org.hibernate.event.spi that return PersistentCollection

Modifier and Type	Method	Description
PersistentCollection<?>	AbstractCollectionEvent.getCollection()

Methods in org.hibernate.event.spi with parameters of type PersistentCollection

Modifier and Type	Method	Description
protected static CollectionPersister	AbstractCollectionEvent.getLoadedCollectionPersister(PersistentCollection<?> collection, EventSource source)
protected static Object	AbstractCollectionEvent.getLoadedOwnerIdOrNull(PersistentCollection<?> collection, EventSource source)
protected static Object	AbstractCollectionEvent.getLoadedOwnerOrNull(PersistentCollection<?> collection, EventSource source)

Constructors in org.hibernate.event.spi with parameters of type PersistentCollection

Modifier	Constructor	Description
	AbstractCollectionEvent(PersistentCollection<?> collection, String entityName, Object affectedOwner, Object affectedOwnerId)	Constructs an instance for a stateless session.
	AbstractCollectionEvent(CollectionPersister collectionPersister, PersistentCollection<?> collection, EventSource source, Object affectedOwner, Object affectedOwnerId)	Constructs an instance for a stateful session.
	InitializeCollectionEvent(PersistentCollection<?> collection, EventSource source)
	PostCollectionRecreateEvent(PersistentCollection<?> collection, Object id, String entityName, Object loadedOwner)
	PostCollectionRecreateEvent(CollectionPersister collectionPersister, PersistentCollection<?> collection, EventSource source)
	PostCollectionRemoveEvent(PersistentCollection<?> collection, Object id, String entityName, Object loadedOwner)
	PostCollectionRemoveEvent(CollectionPersister collectionPersister, PersistentCollection<?> collection, EventSource source, Object loadedOwner)
	PostCollectionUpdateEvent(PersistentCollection<?> collection, Object id, String entityName, Object loadedOwner)
	PostCollectionUpdateEvent(CollectionPersister collectionPersister, PersistentCollection<?> collection, EventSource source)
	PreCollectionRecreateEvent(PersistentCollection<?> collection, Object id, String entityName, Object loadedOwner)
	PreCollectionRecreateEvent(CollectionPersister collectionPersister, PersistentCollection<?> collection, EventSource source)
	PreCollectionRemoveEvent(PersistentCollection<?> collection, Object id, String entityName, Object loadedOwner)
	PreCollectionRemoveEvent(CollectionPersister collectionPersister, PersistentCollection<?> collection, EventSource source, Object loadedOwner)
	PreCollectionUpdateEvent(PersistentCollection<?> collection, Object id, String entityName, Object loadedOwner)
	PreCollectionUpdateEvent(CollectionPersister collectionPersister, PersistentCollection<?> collection, EventSource source)

Uses of PersistentCollection in org.hibernate.loader.ast.spi

Methods in org.hibernate.loader.ast.spi that return PersistentCollection

Modifier and Type	Method	Description
PersistentCollection<?>	CollectionLoader.load(Object key, SharedSessionContractImplementor session)	Load a collection by its key (not necessarily the same as its owner's PK).

Uses of PersistentCollection in org.hibernate.persister.collection

Methods in org.hibernate.persister.collection with parameters of type PersistentCollection

Modifier and Type	Method	Description
void	BasicCollectionPersister.deleteRows(PersistentCollection<?> collection, Object id, SharedSessionContractImplementor session)
void	CollectionPersister.deleteRows(PersistentCollection<?> collection, Object key, SharedSessionContractImplementor session)	Delete the persistent state of any elements that were removed from the collection
void	OneToManyPersister.deleteRows(PersistentCollection<?> collection, Object key, SharedSessionContractImplementor session)
protected abstract void	AbstractCollectionPersister.doProcessQueuedOps(PersistentCollection<?> collection, Object key, SharedSessionContractImplementor session)
protected void	BasicCollectionPersister.doProcessQueuedOps(PersistentCollection<?> collection, Object id, SharedSessionContractImplementor session)
protected void	OneToManyPersister.doProcessQueuedOps(PersistentCollection<?> collection, Object id, SharedSessionContractImplementor session)
void	BasicCollectionPersister.insertRows(PersistentCollection<?> collection, Object id, SharedSessionContractImplementor session)
void	CollectionPersister.insertRows(PersistentCollection<?> collection, Object key, SharedSessionContractImplementor session)	Insert the persistent state of any new collection elements
void	OneToManyPersister.insertRows(PersistentCollection<?> collection, Object id, SharedSessionContractImplementor session)
void	AbstractCollectionPersister.processQueuedOps(PersistentCollection<?> collection, Object key, SharedSessionContractImplementor session)
void	CollectionPersister.processQueuedOps(PersistentCollection<?> collection, Object key, SharedSessionContractImplementor session)	Process queued operations within the PersistentCollection.
void	BasicCollectionPersister.recreate(PersistentCollection<?> collection, Object id, SharedSessionContractImplementor session)
void	CollectionPersister.recreate(PersistentCollection<?> collection, Object key, SharedSessionContractImplementor session)	(Re)create the collection's persistent state
void	OneToManyPersister.recreate(PersistentCollection<?> collection, Object id, SharedSessionContractImplementor session)
void	BasicCollectionPersister.updateRows(PersistentCollection<?> collection, Object id, SharedSessionContractImplementor session)
void	CollectionPersister.updateRows(PersistentCollection<?> collection, Object key, SharedSessionContractImplementor session)	Update the persistent state of any elements that were modified
void	OneToManyPersister.updateRows(PersistentCollection<?> collection, Object id, SharedSessionContractImplementor session)

Uses of PersistentCollection in org.hibernate.persister.collection.mutation

Methods in org.hibernate.persister.collection.mutation with parameters of type PersistentCollection

Modifier and Type	Method	Description
void	RowMutationOperations.Restrictions.applyRestrictions(PersistentCollection<?> collection, Object key, Object rowValue, int rowPosition, SharedSessionContractImplementor session, JdbcValueBindings jdbcValueBindings)
void	RowMutationOperations.Values.applyValues(PersistentCollection<?> collection, Object key, Object rowValue, int rowPosition, SharedSessionContractImplementor session, JdbcValueBindings jdbcValueBindings)
void	DeleteRowsCoordinator.deleteRows(PersistentCollection<?> collection, Object key, SharedSessionContractImplementor session)	Perform the deletions
void	DeleteRowsCoordinatorNoOp.deleteRows(PersistentCollection<?> collection, Object key, SharedSessionContractImplementor session)
void	DeleteRowsCoordinatorStandard.deleteRows(PersistentCollection<?> collection, Object key, SharedSessionContractImplementor session)
void	DeleteRowsCoordinatorTablePerSubclass.deleteRows(PersistentCollection<?> collection, Object key, SharedSessionContractImplementor session)
protected abstract int	AbstractUpdateRowsCoordinator.doUpdate(Object key, PersistentCollection<?> collection, SharedSessionContractImplementor session)
protected int	UpdateRowsCoordinatorOneToMany.doUpdate(Object key, PersistentCollection<?> collection, SharedSessionContractImplementor session)
protected int	UpdateRowsCoordinatorStandard.doUpdate(Object key, PersistentCollection<?> collection, SharedSessionContractImplementor session)
protected int	UpdateRowsCoordinatorTablePerSubclass.doUpdate(Object key, PersistentCollection<?> collection, SharedSessionContractImplementor session)
default boolean	InsertRowsCoordinator.EntryFilter.exclude(Object entry, int i, PersistentCollection<?> collection, PluralAttributeMapping attributeDescriptor)	The inverse of InsertRowsCoordinator.EntryFilter.include(java.lang.Object, int, org.hibernate.collection.spi.PersistentCollection<?>, org.hibernate.metamodel.mapping.PluralAttributeMapping).
boolean	InsertRowsCoordinator.EntryFilter.include(Object entry, int position, PersistentCollection<?> collection, PluralAttributeMapping attributeDescriptor)	Whether the entry should be included
void	InsertRowsCoordinator.insertRows(PersistentCollection<?> collection, Object id, InsertRowsCoordinator.EntryFilter entryChecker, SharedSessionContractImplementor session)	Perform the creation.
void	InsertRowsCoordinatorNoOp.insertRows(PersistentCollection<?> collection, Object id, InsertRowsCoordinator.EntryFilter entryChecker, SharedSessionContractImplementor session)
void	InsertRowsCoordinatorStandard.insertRows(PersistentCollection<?> collection, Object id, InsertRowsCoordinator.EntryFilter entryChecker, SharedSessionContractImplementor session)
void	InsertRowsCoordinatorTablePerSubclass.insertRows(PersistentCollection<?> collection, Object id, InsertRowsCoordinator.EntryFilter entryChecker, SharedSessionContractImplementor session)
void	AbstractUpdateRowsCoordinator.updateRows(Object key, PersistentCollection<?> collection, SharedSessionContractImplementor session)
void	UpdateRowsCoordinator.updateRows(Object key, PersistentCollection<?> collection, SharedSessionContractImplementor session)
void	UpdateRowsCoordinatorNoOp.updateRows(Object key, PersistentCollection<?> collection, SharedSessionContractImplementor session)

Uses of PersistentCollection in org.hibernate.pretty

Methods in org.hibernate.pretty with parameters of type PersistentCollection

Modifier and Type	Method	Description
static String	MessageHelper.collectionInfoString(@Nullable CollectionPersister persister, @Nullable PersistentCollection<?> collection, Object collectionKey, SharedSessionContractImplementor session)	Generate an info message string relating to a particular managed collection.

Uses of PersistentCollection in org.hibernate.sql.results.graph.collection

Methods in org.hibernate.sql.results.graph.collection that return PersistentCollection

Modifier and Type	Method	Description
@Nullable PersistentCollection<?>	CollectionInitializer.getCollectionInstance(Data data)
default @Nullable PersistentCollection<?>	CollectionInitializer.getCollectionInstance(RowProcessingState rowProcessingState)
PersistentCollection<?>	LoadingCollectionEntry.getCollectionInstance()	The collection instance being loaded

Uses of PersistentCollection in org.hibernate.type

Methods in org.hibernate.type that return PersistentCollection

Modifier and Type	Method	Description
PersistentCollection<?>	ArrayType.instantiate(SharedSessionContractImplementor session, CollectionPersister persister, Object key)
PersistentCollection<?>	BagType.instantiate(SharedSessionContractImplementor session, CollectionPersister persister, Object key)
abstract PersistentCollection<?>	CollectionType.instantiate(SharedSessionContractImplementor session, CollectionPersister persister, Object key)	Instantiate an uninitialized collection wrapper or holder.
PersistentCollection<?>	CustomCollectionType.instantiate(SharedSessionContractImplementor session, CollectionPersister persister, Object key)
PersistentCollection<?>	IdentifierBagType.instantiate(SharedSessionContractImplementor session, CollectionPersister persister, Object key)
PersistentCollection<?>	ListType.instantiate(SharedSessionContractImplementor session, CollectionPersister persister, Object key)
PersistentCollection<?>	MapType.instantiate(SharedSessionContractImplementor session, CollectionPersister persister, Object key)
PersistentCollection<?>	SetType.instantiate(SharedSessionContractImplementor session, CollectionPersister persister, Object key)
PersistentCollection<?>	SortedMapType.instantiate(SharedSessionContractImplementor session, CollectionPersister persister, Object key)
PersistentCollection<?>	SortedSetType.instantiate(SharedSessionContractImplementor session, CollectionPersister persister, Object key)
PersistentCollection<?>	ArrayType.wrap(SharedSessionContractImplementor session, Object array)
PersistentCollection<?>	BagType.wrap(SharedSessionContractImplementor session, Object collection)
abstract PersistentCollection<?>	CollectionType.wrap(SharedSessionContractImplementor session, Object collection)	Wrap the naked collection instance in a wrapper, or instantiate a holder.
PersistentCollection<?>	CustomCollectionType.wrap(SharedSessionContractImplementor session, Object collection)
PersistentCollection<?>	IdentifierBagType.wrap(SharedSessionContractImplementor session, Object collection)
PersistentCollection<?>	ListType.wrap(SharedSessionContractImplementor session, Object collection)
PersistentCollection<?>	MapType.wrap(SharedSessionContractImplementor session, Object collection)
PersistentCollection<?>	SetType.wrap(SharedSessionContractImplementor session, Object collection)
PersistentCollection<?>	SortedMapType.wrap(SharedSessionContractImplementor session, Object collection)
PersistentCollection<?>	SortedSetType.wrap(SharedSessionContractImplementor session, Object collection)

Uses of PersistentCollection in org.hibernate.usertype

Methods in org.hibernate.usertype that return PersistentCollection

Modifier and Type	Method	Description
PersistentCollection<?>	UserCollectionType.instantiate(SharedSessionContractImplementor session, CollectionPersister persister)	Instantiate an uninitialized instance of the collection wrapper
PersistentCollection<?>	UserCollectionType.wrap(SharedSessionContractImplementor session, Object collection)	Wrap an instance of a collection