Package org.hibernate.collection.spi

Class PersistentBag<E>

java.lang.Object

org.hibernate.collection.spi.AbstractPersistentCollection<E>

org.hibernate.collection.spi.PersistentBag<E>

All Implemented Interfaces:

Serializable, Iterable<E>, Collection<E>, List<E>, SequencedCollection<E>, LazyInitializable, PersistentCollection<E>, InstanceIdentity

@Incubating
public class PersistentBag<E>
extends AbstractPersistentCollection<E>
implements List<E>

An unordered, un-keyed collection that can contain the same element multiple times. The Java Collections Framework, curiously, has no Bag interface. It is, however, common to use Lists to represent a collection with bag semantics, so Hibernate follows this practice.

See Also:

• Serialized Form

API Note:

Incubating in terms of making this non-internal. These contracts will be getting cleaned up in following releases.

Nested Class Summary

Nested classes/interfaces inherited from class org.hibernate.collection.spi.AbstractPersistentCollection

AbstractPersistentCollection.AbstractValueDelayedOperation, AbstractPersistentCollection.DelayedOperation<E>, AbstractPersistentCollection.IteratorProxy<E>, AbstractPersistentCollection.LazyInitializationWork<T>, AbstractPersistentCollection.ListIteratorProxy, AbstractPersistentCollection.ListProxy, AbstractPersistentCollection.SetProxy<E>, AbstractPersistentCollection.ValueDelayedOperation<E>

Field Summary

Fields

Modifier and Type	Field	Description
protected List<E>	bag	Deprecated, for removal: This API element is subject to removal in a future version. Use bagAsList() or collection instead.
protected Collection<E>	collection	The actual bag.

Fields inherited from class org.hibernate.collection.spi.AbstractPersistentCollection

elementRemoved, UNKNOWN

Constructor Summary

Constructors

Constructor	Description
PersistentBag()	Constructs a PersistentBag.
PersistentBag(SharedSessionContractImplementor session)	Constructs a PersistentBag
PersistentBag(SharedSessionContractImplementor session, Collection<E> coll)	Constructs a PersistentBag

Method Summary

Modifier and Type	Method	Description
void	add(int i, E o)
boolean	add(E object)
boolean	addAll(int i, Collection<? extends E> c)
boolean	addAll(Collection<? extends E> values)
protected List<E>	bagAsList()
void	clear()
boolean	contains(Object object)
boolean	containsAll(Collection<?> c)
Object	disassemble(CollectionPersister persister)	Disassemble the collection to get it ready for the cache
boolean	empty()	Is the collection empty? (don't try to initialize the collection)
Iterator<E>	entries(CollectionPersister persister)	Iterate all collection entries, during update of the database
boolean	entryExists(Object entry, int i)	Does the given element/entry exist in the collection?
boolean	equals(Object obj)	For efficiency, bag does not respect the semantics of List.equals(Object) as specified by the supertype List.
boolean	equalsSnapshot(CollectionPersister persister)	Does the current state exactly match the snapshot?
E	get(int i)
Iterator<?>	getDeletes(CollectionPersister persister, boolean indexIsFormula)	Get all the elements that need deleting
Object	getElement(Object entry)	Get the value of the given collection entry.
Object	getIndex(Object entry, int i, CollectionPersister persister)	Get the index of the given collection entry
Collection<E>	getOrphans(Serializable snapshot, String entityName)	get all "orphaned" elements
Serializable	getSnapshot(CollectionPersister persister)	Return a new snapshot of the current state of the collection
Object	getSnapshotElement(Object entry, int i)	Get the snapshot value of the given collection entry
boolean	hasDeletes(CollectionPersister persister)	Does this collection have any elements which must be deleted?
int	hashCode()
int	indexOf(Object o)
void	initializeEmptyCollection(CollectionPersister persister)
void	initializeFromCache(CollectionPersister collectionDescriptor, Object disassembled, Object owner)	Read the state of the collection from a disassembled cached value
void	injectLoadedState(PluralAttributeMapping attributeMapping, List<?> loadingState)	Inject the state loaded for a collection instance.
boolean	isEmpty()
boolean	isRowUpdatePossible()	Can each element in the collection be mapped unequivocally to a single row in the database? Generally bags and sets are the only collections that cannot be.
boolean	isSnapshotEmpty(Serializable snapshot)	Is the snapshot empty?
boolean	isWrapper(Object collection)	Is this the wrapper for the given collection instance?
Iterator<E>	iterator()
int	lastIndexOf(Object o)
ListIterator<E>	listIterator()
ListIterator<E>	listIterator(int i)
boolean	needsInserting(Object entry, int i, Type elemType)	Do we need to insert this element?
boolean	needsRecreate(CollectionPersister persister)	Do we need to completely recreate this collection when it changes?
boolean	needsUpdating(Object entry, int i, Type elemType)	Do we need to update this element?
int	occurrences(Object o)	Count how many times the given object occurs in the elements
E	remove(int i)
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
E	set(int i, E o)
int	size()
List<E>	subList(int start, int end)
Object[]	toArray()
<A> A[]	toArray(A[] a)
String	toString()

Methods inherited from class org.hibernate.collection.spi.AbstractPersistentCollection

$$_hibernate_getInstanceId, $$_hibernate_setInstanceId, afterInitialize, afterRowInsert, beforeInitialize, beginRead, checkPersister, clearDirty, clearOperationQueue, dirty, elementByIndex, elementExists, endRead, forceInitialization, getCachedSize, getIdentifier, getKey, getOrphans, getOwner, getQueuedOrphans, getRole, getSession, getSize, getSnapshot, getStoredSnapshot, getValue, hasQueuedOperations, identityRemove, initialize, isClearQueueEnabled, isConnectedToSession, isDirectlyAccessible, isDirty, isElementRemoved, isInitialized, isInitializing, isInverseCollection, isInverseCollectionNoOrphanDelete, isInverseOneToManyOrNoOrphanDelete, isOperationQueueEnabled, isPutQueueEnabled, isUnreferenced, performQueuedOperations, postAction, preInsert, prepareForPossibleLoadingOutsideTransaction, queuedAdditionIterator, queueOperation, read, readElementByIndex, readElementExistence, readIndexExistence, readSize, replaceQueuedOperationValues, setCurrentSession, setDirectlyAccessible, setInitialized, setOwner, setSnapshot, unsetSession, wasInitialized, write

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addFirst, addLast, getFirst, getLast, removeFirst, removeLast, replaceAll, reversed, sort, spliterator

Methods inherited from interface org.hibernate.collection.spi.PersistentCollection

includeInInsert, includeInRecreate, isDirectlyProvidedCollection, isNewlyInstantiated, needsUpdating, render

Field Details

bag

@Deprecated(forRemoval=true,
            since="7")
protected List<E> bag

Deprecated, for removal: This API element is subject to removal in a future version.

Use bagAsList() or collection instead.

collection

protected Collection<E> collection

The actual bag. For backwards compatibility reasons, the bag field remains as List, but might be null when the bag does not implement the List interface, whereas this collection field will always contain the actual bag instance.

Constructor Details

PersistentBag

public PersistentBag()

Constructs a PersistentBag. Needed for SOAP libraries, etc

PersistentBag

public PersistentBag(SharedSessionContractImplementor session)

Constructs a PersistentBag

Parameters:

session - The session

PersistentBag

public PersistentBag(SharedSessionContractImplementor session,
 Collection<E> coll)

Constructs a PersistentBag

Parameters:

session - The session

coll - The base elements.

Method Details

bagAsList

protected List<E> bagAsList()

isWrapper

public boolean isWrapper(Object collection)

Description copied from interface: PersistentCollection

Is this the wrapper for the given collection instance?

Specified by:

isWrapper in interface PersistentCollection<E>

Parameters:

collection - The collection to check whether this is wrapping it

Returns:

true if this is a wrapper around that given collection instance.

empty

public boolean empty()

Description copied from interface: PersistentCollection

Is the collection empty? (don't try to initialize the collection)

Specified by:

empty in interface PersistentCollection<E>

Specified by:

empty in class AbstractPersistentCollection<E>

Returns:

false if the collection is non-empty; true otherwise.

entries

public Iterator<E> entries(CollectionPersister persister)

Description copied from interface: PersistentCollection

Iterate all collection entries, during update of the database

Specified by:

entries in interface PersistentCollection<E>

Parameters:

persister - The collection persister.

Returns:

The iterator

injectLoadedState

public void injectLoadedState(PluralAttributeMapping attributeMapping,
 List<?> loadingState)

Description copied from interface: PersistentCollection

Inject the state loaded for a collection instance.

Specified by:

injectLoadedState in interface PersistentCollection<E>

equalsSnapshot

public boolean equalsSnapshot(CollectionPersister persister)
                       throws HibernateException

Description copied from interface: PersistentCollection

Does the current state exactly match the snapshot?

Specified by:

equalsSnapshot in interface PersistentCollection<E>

Parameters:

persister - The collection persister

Returns:

true if the current state and the snapshot state match.

Throws:

HibernateException

isSnapshotEmpty

public boolean isSnapshotEmpty(Serializable snapshot)

Description copied from interface: PersistentCollection

Is the snapshot empty?

Specified by:

isSnapshotEmpty in interface PersistentCollection<E>

Parameters:

snapshot - The snapshot to check

Returns:

true if the given snapshot is empty

getSnapshot

public Serializable getSnapshot(CollectionPersister persister)
                         throws HibernateException

Description copied from interface: PersistentCollection

Return a new snapshot of the current state of the collection

Specified by:

getSnapshot in interface PersistentCollection<E>

Parameters:

persister - The collection persister

Returns:

The snapshot

Throws:

HibernateException

getOrphans

public Collection<E> getOrphans(Serializable snapshot,
 String entityName)
                         throws HibernateException

Description copied from interface: PersistentCollection

get all "orphaned" elements

Specified by:

getOrphans in interface PersistentCollection<E>

Specified by:

getOrphans in class AbstractPersistentCollection<E>

Parameters:

snapshot - The snapshot state

entityName - The name of the entity that are the elements of the collection

Returns:

The orphans

Throws:

HibernateException

initializeEmptyCollection

public void initializeEmptyCollection(CollectionPersister persister)

Specified by:

initializeEmptyCollection in interface PersistentCollection<E>

disassemble

public Object disassemble(CollectionPersister persister)

Description copied from interface: PersistentCollection

Disassemble the collection to get it ready for the cache

Specified by:

disassemble in interface PersistentCollection<E>

Parameters:

persister - The collection persister

Returns:

The disassembled state

initializeFromCache

public void initializeFromCache(CollectionPersister collectionDescriptor,
 Object disassembled,
 Object owner)
                         throws HibernateException

Description copied from interface: PersistentCollection

Read the state of the collection from a disassembled cached value

Specified by:

initializeFromCache in interface PersistentCollection<E>

Parameters:

collectionDescriptor - The collection persister

disassembled - The disassembled cached state

owner - The collection owner

Throws:

HibernateException

needsRecreate

public boolean needsRecreate(CollectionPersister persister)

Description copied from interface: PersistentCollection

Do we need to completely recreate this collection when it changes?

Specified by:

needsRecreate in interface PersistentCollection<E>

Overrides:

needsRecreate in class AbstractPersistentCollection<E>

Parameters:

persister - The collection persister

Returns:

true if a change requires a recreate.

getDeletes

public Iterator<?> getDeletes(CollectionPersister persister,
 boolean indexIsFormula)
                       throws HibernateException

Description copied from interface: PersistentCollection

Get all the elements that need deleting

Specified by:

getDeletes in interface PersistentCollection<E>

Parameters:

persister - The collection persister

indexIsFormula - For indexed collections, tells whether the index is a formula (calculated value) mapping

Returns:

An iterator over the elements to delete

Throws:

HibernateException

hasDeletes

public boolean hasDeletes(CollectionPersister persister)

Description copied from interface: PersistentCollection

Does this collection have any elements which must be deleted?

Specified by:

hasDeletes in interface PersistentCollection<E>

Parameters:

persister - The collection persister

Returns:

true if elements were removed

needsInserting

public boolean needsInserting(Object entry,
 int i,
 Type elemType)
                       throws HibernateException

Description copied from interface: PersistentCollection

Do we need to insert this element?

Specified by:

needsInserting in interface PersistentCollection<E>

Parameters:

entry - The collection element to check

i - The index (for indexed collections)

elemType - The type for the element

Returns:

true if the element needs inserting

Throws:

HibernateException

isRowUpdatePossible

public boolean isRowUpdatePossible()

Description copied from interface: PersistentCollection

Can each element in the collection be mapped unequivocally to a single row in the database? Generally bags and sets are the only collections that cannot be.

Specified by:

isRowUpdatePossible in interface PersistentCollection<E>

Overrides:

isRowUpdatePossible in class AbstractPersistentCollection<E>

Returns:

true if the row for each element is known

needsUpdating

public boolean needsUpdating(Object entry,
 int i,
 Type elemType)

Description copied from interface: PersistentCollection

Do we need to update this element?

Specified by:

needsUpdating in interface PersistentCollection<E>

Parameters:

entry - The collection element to check

i - The index (for indexed collections)

elemType - The type for the element

Returns:

true if the element needs updating

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface List<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface List<E>

contains

public boolean contains(Object object)

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface List<E>

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface List<E>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface List<E>

toArray

public <A> A[] toArray(A[] a)

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface List<E>

add

public boolean add(E object)

Specified by:

add in interface Collection<E>

Specified by:

add in interface List<E>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface List<E>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<E>

Specified by:

containsAll in interface List<E>

addAll

public boolean addAll(Collection<? extends E> values)

Specified by:

addAll in interface Collection<E>

Specified by:

addAll in interface List<E>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<E>

Specified by:

removeAll in interface List<E>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<E>

Specified by:

retainAll in interface List<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface List<E>

getIndex

public Object getIndex(Object entry,
 int i,
 CollectionPersister persister)

Description copied from interface: PersistentCollection

Get the index of the given collection entry

Specified by:

getIndex in interface PersistentCollection<E>

Parameters:

entry - The collection entry/element

i - The assumed index

persister - it was more elegant before we added this...

Returns:

The index value

getElement

public Object getElement(Object entry)

Description copied from interface: PersistentCollection

Get the value of the given collection entry. Generally the given entry parameter value will just be returned. Might get a different value for a duplicate entries in a Set.

Specified by:

getElement in interface PersistentCollection<E>

Parameters:

entry - The object instance for which to get the collection element instance.

Returns:

The corresponding object that is part of the collection elements.

getSnapshotElement

public Object getSnapshotElement(Object entry,
 int i)

Description copied from interface: PersistentCollection

Get the snapshot value of the given collection entry

Specified by:

getSnapshotElement in interface PersistentCollection<E>

Parameters:

entry - The entry

i - The index

Returns:

The snapshot state for that element

occurrences

public int occurrences(Object o)

Count how many times the given object occurs in the elements

Parameters:

o - The object to check

Returns:

The number of occurrences.

add

public void add(int i,
 E o)

Specified by:

add in interface List<E>

addAll

public boolean addAll(int i,
 Collection<? extends E> c)

Specified by:

addAll in interface List<E>

get

public E get(int i)

Specified by:

get in interface List<E>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<E>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<E>

listIterator

public ListIterator<E> listIterator()

Specified by:

listIterator in interface List<E>

listIterator

public ListIterator<E> listIterator(int i)

Specified by:

listIterator in interface List<E>

remove

public E remove(int i)

Specified by:

remove in interface List<E>

set

public E set(int i,
 E o)

Specified by:

set in interface List<E>

subList

public List<E> subList(int start,
 int end)

Specified by:

subList in interface List<E>

entryExists

public boolean entryExists(Object entry,
 int i)

Description copied from interface: PersistentCollection

Does the given element/entry exist in the collection?

Specified by:

entryExists in interface PersistentCollection<E>

Parameters:

entry - The object to check if it exists as a collection element

i - Unused

Returns:

true if the given entry is a collection element

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

For efficiency, bag does not respect the semantics of List.equals(Object) as specified by the supertype List. Instead, instance equality is used, to avoid the need to fetch the elements of the bag.

Specified by:

equals in interface Collection<E>

Specified by:

equals in interface List<E>

Overrides:

equals in class Object

See Also:

• Object.equals(Object)

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<E>

Specified by:

hashCode in interface List<E>

Overrides:

hashCode in class Object