org.hibernate.collection.internal

Class PersistentSet

java.lang.Object

org.hibernate.collection.internal.AbstractPersistentCollection

org.hibernate.collection.internal.PersistentSet

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable, java.util.Collection, java.util.Set, PersistentCollection

Direct Known Subclasses:

PersistentSortedSet

public class PersistentSet
extends AbstractPersistentCollection
implements java.util.Set

A persistent wrapper for a java.util.Set. The underlying collection is a HashSet.

See Also:

HashSet, Serialized Form

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set	set
protected java.util.List	tempList

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

UNKNOWN

Constructor Summary

Constructors

Constructor and Description
PersistentSet() Empty constructor.
PersistentSet(SessionImplementor session) Constructor matching super.
PersistentSet(SessionImplementor session, java.util.Set set) Instantiates a non-lazy set (the underlying set is constructed from the incoming set reference).

Method Summary

Modifier and Type	Method and Description
boolean	add(java.lang.Object value)
boolean	addAll(java.util.Collection coll)
void	beforeInitialize(CollectionPersister persister, int anticipatedSize) Called before any elements are read into the collection, allowing appropriate initializations to occur.
void	beginRead() Called just before reading any rows from the JDBC result set
void	clear()
boolean	contains(java.lang.Object object)
boolean	containsAll(java.util.Collection coll)
java.io.Serializable	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)
boolean	endRead() Called after reading all rows from the JDBC result set
java.util.Iterator	entries(CollectionPersister persister) Iterate all collection entries, during update of the database
boolean	entryExists(java.lang.Object key, int i) Does the given element/entry exist in the collection?
boolean	equals(java.lang.Object other)
boolean	equalsSnapshot(CollectionPersister persister) Does the current state exactly match the snapshot?
java.util.Iterator	getDeletes(CollectionPersister persister, boolean indexIsFormula) Get all the elements that need deleting
java.lang.Object	getElement(java.lang.Object entry) Get the value of the given collection entry.
java.lang.Object	getIndex(java.lang.Object entry, int i, CollectionPersister persister) Get the index of the given collection entry
java.util.Collection	getOrphans(java.io.Serializable snapshot, java.lang.String entityName) get all "orphaned" elements
java.io.Serializable	getSnapshot(CollectionPersister persister) Return a new snapshot of the current state of the collection
java.lang.Object	getSnapshotElement(java.lang.Object entry, int i) Get the snapshot value of the given collection entry
int	hashCode()
void	initializeFromCache(CollectionPersister persister, java.io.Serializable disassembled, java.lang.Object owner) Read the state of the collection from a disassembled cached value
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(java.io.Serializable snapshot) Is the snapshot empty?
boolean	isWrapper(java.lang.Object collection) Is this the wrapper for the given collection instance?
java.util.Iterator	iterator()
boolean	needsInserting(java.lang.Object entry, int i, Type elemType) Do we need to insert this element?
boolean	needsUpdating(java.lang.Object entry, int i, Type elemType) Do we need to update this element?
java.lang.Object	readFrom(java.sql.ResultSet rs, CollectionPersister persister, CollectionAliases descriptor, java.lang.Object owner) Read a row from the JDBC result set
boolean	remove(java.lang.Object value)
boolean	removeAll(java.util.Collection coll)
boolean	retainAll(java.util.Collection coll)
int	size()
java.lang.Object[]	toArray()
java.lang.Object[]	toArray(java.lang.Object[] array)
java.lang.String	toString()

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

afterInitialize, afterRowInsert, clearDirty, dirty, forceInitialization, getCachedSize, getIdentifier, getKey, getOrphans, getOwner, getQueuedOrphans, getRole, getSession, getSnapshot, getStoredSnapshot, getValue, hasQueuedOperations, identityRemove, initialize, isClearQueueEnabled, isConnectedToSession, isDirectlyAccessible, isDirty, isInitialized, 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.Set

spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

set

protected java.util.Set set

tempList

protected transient java.util.List tempList

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(SessionImplementor 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(SessionImplementor session,
                     java.util.Set 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 java.io.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

Parameters:

persister - The collection persister

Returns:

The snapshot

Throws:

HibernateException

getOrphans

public java.util.Collection getOrphans(java.io.Serializable snapshot,
                                       java.lang.String entityName)
                                throws HibernateException

Description copied from interface: PersistentCollection

get all "orphaned" elements

Specified by:

getOrphans in interface PersistentCollection

Specified by:

getOrphans in class AbstractPersistentCollection

Parameters:

snapshot - The snapshot state

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

Returns:

The orphans

Throws:

HibernateException

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

Parameters:

persister - The collection persister

Returns:

true if the current state and the snapshot state match.

Throws:

HibernateException

isSnapshotEmpty

public boolean isSnapshotEmpty(java.io.Serializable snapshot)

Description copied from interface: PersistentCollection

Is the snapshot empty?

Specified by:

isSnapshotEmpty in interface PersistentCollection

Parameters:

snapshot - The snapshot to check

Returns:

true if the given snapshot is empty

beforeInitialize

public void beforeInitialize(CollectionPersister persister,
                             int anticipatedSize)

Description copied from interface: PersistentCollection

Called before any elements are read into the collection, allowing appropriate initializations to occur.

Specified by:

beforeInitialize in interface PersistentCollection

Parameters:

persister - The underlying collection persister.

anticipatedSize - The anticipated size of the collection after initialization is complete.

initializeFromCache

public void initializeFromCache(CollectionPersister persister,
                                java.io.Serializable disassembled,
                                java.lang.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

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

Specified by:

empty in class AbstractPersistentCollection

Returns:

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

size

public int size()

Specified by:

size in interface java.util.Collection

Specified by:

size in interface java.util.Set

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection

Specified by:

isEmpty in interface java.util.Set

contains

public boolean contains(java.lang.Object object)

Specified by:

contains in interface java.util.Collection

Specified by:

contains in interface java.util.Set

iterator

public java.util.Iterator iterator()

Specified by:

iterator in interface java.lang.Iterable

Specified by:

iterator in interface java.util.Collection

Specified by:

iterator in interface java.util.Set

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection

Specified by:

toArray in interface java.util.Set

toArray

public java.lang.Object[] toArray(java.lang.Object[] array)

Specified by:

toArray in interface java.util.Collection

Specified by:

toArray in interface java.util.Set

add

public boolean add(java.lang.Object value)

Specified by:

add in interface java.util.Collection

Specified by:

add in interface java.util.Set

remove

public boolean remove(java.lang.Object value)

Specified by:

remove in interface java.util.Collection

Specified by:

remove in interface java.util.Set

containsAll

public boolean containsAll(java.util.Collection coll)

Specified by:

containsAll in interface java.util.Collection

Specified by:

containsAll in interface java.util.Set

addAll

public boolean addAll(java.util.Collection coll)

Specified by:

addAll in interface java.util.Collection

Specified by:

addAll in interface java.util.Set

retainAll

public boolean retainAll(java.util.Collection coll)

Specified by:

retainAll in interface java.util.Collection

Specified by:

retainAll in interface java.util.Set

removeAll

public boolean removeAll(java.util.Collection coll)

Specified by:

removeAll in interface java.util.Collection

Specified by:

removeAll in interface java.util.Set

clear

public void clear()

Specified by:

clear in interface java.util.Collection

Specified by:

clear in interface java.util.Set

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

readFrom

public java.lang.Object readFrom(java.sql.ResultSet rs,
                                 CollectionPersister persister,
                                 CollectionAliases descriptor,
                                 java.lang.Object owner)
                          throws HibernateException,
                                 java.sql.SQLException

Description copied from interface: PersistentCollection

Read a row from the JDBC result set

Specified by:

readFrom in interface PersistentCollection

Parameters:

rs - The JDBC ResultSet

persister - The collection role

descriptor - The aliases used for the columns making up the collection

owner - The collection owner

Returns:

The read object

Throws:

HibernateException - Generally indicates a problem resolving data read from the ResultSet

java.sql.SQLException - Indicates a problem accessing the ResultSet

beginRead

public void beginRead()

Description copied from interface: PersistentCollection

Called just before reading any rows from the JDBC result set

Specified by:

beginRead in interface PersistentCollection

Overrides:

beginRead in class AbstractPersistentCollection

endRead

public boolean endRead()

Description copied from interface: PersistentCollection

Called after reading all rows from the JDBC result set

Specified by:

endRead in interface PersistentCollection

Overrides:

endRead in class AbstractPersistentCollection

Returns:

Whether to end the read.

entries

public java.util.Iterator entries(CollectionPersister persister)

Description copied from interface: PersistentCollection

Iterate all collection entries, during update of the database

Specified by:

entries in interface PersistentCollection

Parameters:

persister - The collection persister.

Returns:

The iterator

disassemble

public java.io.Serializable 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

Parameters:

persister - The collection persister

Returns:

The disassembled state

Throws:

HibernateException

getDeletes

public java.util.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

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(java.lang.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

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(java.lang.Object entry,
                             int i,
                             Type elemType)

Description copied from interface: PersistentCollection

Do we need to update this element?

Specified by:

needsUpdating in interface PersistentCollection

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

Overrides:

isRowUpdatePossible in class AbstractPersistentCollection

Returns:

true if the row for each element is known

getIndex

public java.lang.Object getIndex(java.lang.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

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 java.lang.Object getElement(java.lang.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

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 java.lang.Object getSnapshotElement(java.lang.Object entry,
                                           int i)

Description copied from interface: PersistentCollection

Get the snapshot value of the given collection entry

Specified by:

getSnapshotElement in interface PersistentCollection

Parameters:

entry - The entry

i - The index

Returns:

The snapshot state for that element

equals

public boolean equals(java.lang.Object other)

Specified by:

equals in interface java.util.Collection

Specified by:

equals in interface java.util.Set

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Collection

Specified by:

hashCode in interface java.util.Set

Overrides:

hashCode in class java.lang.Object

entryExists

public boolean entryExists(java.lang.Object key,
                           int i)

Description copied from interface: PersistentCollection

Does the given element/entry exist in the collection?

Specified by:

entryExists in interface PersistentCollection

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(java.lang.Object collection)

Description copied from interface: PersistentCollection

Is this the wrapper for the given collection instance?

Specified by:

isWrapper in interface PersistentCollection

Parameters:

collection - The collection to check whether this is wrapping it

Returns:

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