java.lang.Object
- org.hibernate.collection.spi.AbstractPersistentCollection<E>
- - org.hibernate.collection.spi.PersistentSet<E>

All Implemented Interfaces:

Serializable, Iterable<E>, Collection<E>, Set<E>, LazyInitializable, PersistentCollection<E>

Direct Known Subclasses:

PersistentSortedSet
```
@Incubating
public class PersistentSet<E>
extends AbstractPersistentCollection<E>
implements Set<E>
```
A persistent wrapper for a Set. The underlying collection is a HashSet.

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 Set<E> set
- Fields inherited from class org.hibernate.collection.spi.AbstractPersistentCollection
  elementRemoved, UNKNOWN

Constructor Summary

Constructors
Constructor	Description
`PersistentSet()`	Empty constructor.
`PersistentSet(SharedSessionContractImplementor session)`	Constructor matching super.
`PersistentSet(SharedSessionContractImplementor session, Set<E> set)`	Instantiates a non-lazy set (the underlying set is constructed from the incoming set reference).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`add(E value)`
`boolean`	`addAll(Collection<? extends E> coll)`
`void`	`clear()`
`boolean`	`contains(Object object)`
`boolean`	`containsAll(Collection<?> coll)`
`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 key, int i)`	Does the given element/entry exist in the collection?
`boolean`	`equals(Object other)`
`boolean`	`equalsSnapshot(CollectionPersister persister)`	Does the current state exactly match the snapshot?
`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
`int`	`hashCode()`
`void`	`initializeEmptyCollection(CollectionPersister persister)`
`void`	`initializeFromCache(CollectionPersister persister, Object disassembled, Object owner)`	Read the state of the collection from a disassembled cached value
`void`	`injectLoadedState(PluralAttributeMapping attributeMapping, List<?> loadingStateList)`	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()`
`boolean`	`needsInserting(Object entry, int i, Type elemType)`	Do we need to insert this element?
`boolean`	`needsUpdating(Object entry, int i, Type elemType)`	Do we need to update this element?
`boolean`	`remove(Object value)`
`boolean`	`removeAll(Collection<?> coll)`
`boolean`	`retainAll(Collection<?> coll)`
`int`	`size()`
`Object[]`	`toArray()`
`<A> A[]`	`toArray(A[] array)`
`String`	`toString()`

Methods inherited from class org.hibernate.collection.spi.AbstractPersistentCollection
afterInitialize, afterRowInsert, beforeInitialize, beginRead, 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, needsRecreate, 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 org.hibernate.collection.spi.PersistentCollection
includeInInsert, includeInRecreate, isDirectlyProvidedCollection, isNewlyInstantiated, needsUpdating, render

Methods inherited from interface java.util.Set
spliterator

- Field Detail
  - set
```
protected Set<E> set
```
- Constructor Detail
  - PersistentSet
```
public PersistentSet()
```
    Empty constructor.
    Note: this form is not ever ever ever used by Hibernate; it is, however, needed for SOAP libraries and other such marshalling code.
  - PersistentSet
```
public PersistentSet(SharedSessionContractImplementor session)
```
    Constructor matching super. Instantiates a lazy set (the underlying set is un-initialized).
    
    Parameters:
    
    session - The session to which this set will belong.
  - PersistentSet
```
public PersistentSet(SharedSessionContractImplementor session,
                     Set<E> set)
```
    Instantiates a non-lazy set (the underlying set is constructed from the incoming set reference).
    
    Parameters:
    
    session - The session to which this set will belong.
    
    set - The underlying set data.
- Method Detail
  - 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>
  - 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
  - initializeFromCache
```
public void initializeFromCache(CollectionPersister persister,
                                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:
    
    persister - The collection persister
    
    disassembled - The disassembled cached state
    
    owner - The collection owner
    
    Throws:
    
    HibernateException
  - 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.
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<E>
    
    Specified by:
    
    size in interface Set<E>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection<E>
    
    Specified by:
    
    isEmpty in interface Set<E>
  - contains
```
public boolean contains(Object object)
```
    Specified by:
    
    contains in interface Collection<E>
    
    Specified by:
    
    contains in interface Set<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 Set<E>
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface Collection<E>
    
    Specified by:
    
    toArray in interface Set<E>
  - toArray
```
public <A> A[] toArray(A[] array)
```
    Specified by:
    
    toArray in interface Collection<E>
    
    Specified by:
    
    toArray in interface Set<E>
  - add
```
public boolean add(E value)
```
    Specified by:
    
    add in interface Collection<E>
    
    Specified by:
    
    add in interface Set<E>
  - remove
```
public boolean remove(Object value)
```
    Specified by:
    
    remove in interface Collection<E>
    
    Specified by:
    
    remove in interface Set<E>
  - containsAll
```
public boolean containsAll(Collection<?> coll)
```
    Specified by:
    
    containsAll in interface Collection<E>
    
    Specified by:
    
    containsAll in interface Set<E>
  - addAll
```
public boolean addAll(Collection<? extends E> coll)
```
    Specified by:
    
    addAll in interface Collection<E>
    
    Specified by:
    
    addAll in interface Set<E>
  - retainAll
```
public boolean retainAll(Collection<?> coll)
```
    Specified by:
    
    retainAll in interface Collection<E>
    
    Specified by:
    
    retainAll in interface Set<E>
  - removeAll
```
public boolean removeAll(Collection<?> coll)
```
    Specified by:
    
    removeAll in interface Collection<E>
    
    Specified by:
    
    removeAll in interface Set<E>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<E>
    
    Specified by:
    
    clear in interface Set<E>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - injectLoadedState
```
public void injectLoadedState(PluralAttributeMapping attributeMapping,
                              List<?> loadingStateList)
```
    Description copied from interface: PersistentCollection
    
    Inject the state loaded for a collection instance.
    
    Specified by:
    
    injectLoadedState in interface PersistentCollection<E>
  - 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
  - disassemble
```
public Object disassemble(CollectionPersister persister)
                   throws HibernateException
```
    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
    
    Throws:
    
    HibernateException
  - 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
  - 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
  - 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
  - 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
  - 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
  - equals
```
public boolean equals(Object other)
```
    Specified by:
    
    equals in interface Collection<E>
    
    Specified by:
    
    equals in interface Set<E>
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Collection<E>
    
    Specified by:
    
    hashCode in interface Set<E>
    
    Overrides:
    
    hashCode in class Object
  - entryExists
```
public boolean entryExists(Object key,
                           int i)
```
    Description copied from interface: PersistentCollection
    
    Does the given element/entry exist in the collection?
    
    Specified by:
    
    entryExists in interface PersistentCollection<E>
    
    Parameters:
    
    key - The object to check if it exists as a collection element
    
    i - Unused
    
    Returns:
    
    true if the given entry is a collection element
  - 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.

Class PersistentSet<E>

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

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

Methods inherited from interface java.util.Set

Field Detail

set

Constructor Detail

PersistentSet

PersistentSet

PersistentSet

Method Detail

getSnapshot

getOrphans

initializeEmptyCollection

equalsSnapshot

isSnapshotEmpty

initializeFromCache

empty

size

isEmpty

contains

iterator

toArray

toArray

add

remove

containsAll

addAll

retainAll

removeAll

clear

toString

injectLoadedState

entries

disassemble

getDeletes

needsInserting

needsUpdating

isRowUpdatePossible

getIndex

getElement

getSnapshotElement

equals

hashCode

entryExists

isWrapper