Hibernate Core 3.6.10.Final · org.hibernate.collection.PersistentSet

Modifier and Type	Class and Description
pack-priv class	PersistentSet.Clear
pack-priv class	PersistentSet.SimpleAdd
pack-priv class	PersistentSet.SimpleRemove

Modifier and Type	Field and Description
protected Set<E>	set
protected transient List<E>	tempList

Access	Constructor and Description
public	PersistentSet() Empty constructor.
public	PersistentSet(SessionImplementor The session to which this set will belong. session) Constructor matching super.
public	PersistentSet(SessionImplementor The session to which this set will belong. session, Set<E> The underlying set data. set) Instantiates a non-lazy set (the underlying set is constructed from the incoming set reference).

Method Summary

Modifier and Type	Method and Description
public boolean	add(Object element to be added to this set value) Implements java.util.Set.add. Adds the specified element to this set if it is not already present (optional operation).
public boolean	addAll(Collection<E> collection containing elements to be added to this set coll) Implements java.util.Set.addAll. Adds all of the elements in the specified collection to this set if they're not already present (optional operation).
public void	beforeInitialize(CollectionPersister The underlying collection persister. persister, int The anticipated size of the collection after initilization is complete. anticipatedSize) Implements org.hibernate.collection.PersistentCollection.beforeInitialize. Called before any elements are read into the collection, allowing appropriate initializations to occur.
public void	beginRead() Overrides org.hibernate.collection.AbstractPersistentCollection.beginRead. Implements org.hibernate.collection.PersistentCollection.beginRead. Called just before reading any rows from the JDBC result set
public void	clear() Implements java.util.Set.clear. Removes all of the elements from this set (optional operation).
public boolean	contains(Object element whose presence in this set is to be tested object) Implements java.util.Set.contains. Returns `true` if this set contains the specified element.
public boolean	containsAll(Collection<E> collection to be checked for containment in this set coll) Implements java.util.Set.containsAll. Returns `true` if this set contains all of the elements of the specified collection.
public Serializable	disassemble(CollectionPersister persister) Implements org.hibernate.collection.PersistentCollection.disassemble. Disassemble the collection, ready for the cache
public boolean	empty() Implements abstract org.hibernate.collection.AbstractPersistentCollection.empty. Implements org.hibernate.collection.PersistentCollection.empty. Is the initialized collection empty?
public boolean	endRead() Overrides org.hibernate.collection.AbstractPersistentCollection.endRead. Implements org.hibernate.collection.PersistentCollection.endRead. Called after reading all rows from the JDBC result set
public Iterator<E>	entries(CollectionPersister persister) Implements org.hibernate.collection.PersistentCollection.entries. Iterate all collection entries, during update of the database
public boolean	entryExists(Object key, int i) Implements org.hibernate.collection.PersistentCollection.entryExists. Does an element exist at this entry in the collection?
public boolean	equals(Object object to be compared for equality with this set other) Overrides java.lang.Object.equals. Implements java.util.Set.equals. Compares the specified object with this set for equality.
public boolean	equalsSnapshot(CollectionPersister persister) Implements org.hibernate.collection.PersistentCollection.equalsSnapshot. Does the current state exactly match the snapshot?
public Iterator<E>	getDeletes(CollectionPersister persister, boolean indexIsFormula) Implements org.hibernate.collection.PersistentCollection.getDeletes. Get all the elements that need deleting
public Object	getElement(Object entry) Implements org.hibernate.collection.PersistentCollection.getElement. Get the value of the given collection entry
public Object	getIndex(Object entry, int i, CollectionPersister it was more elegant before we added this... persister) Implements org.hibernate.collection.PersistentCollection.getIndex. Get the index of the given collection entry
public Collection<E>	getOrphans(Serializable snapshot, String entityName) Implements abstract org.hibernate.collection.AbstractPersistentCollection.getOrphans. Implements org.hibernate.collection.PersistentCollection.getOrphans. get all "orphaned" elements
public Serializable	getSnapshot(CollectionPersister persister) Implements org.hibernate.collection.PersistentCollection.getSnapshot. Return a new snapshot of the current state of the collection
public Object	getSnapshotElement(Object entry, int i) Implements org.hibernate.collection.PersistentCollection.getSnapshotElement. Get the snapshot value of the given collection entry
public int	hashCode() Overrides java.lang.Object.hashCode. Implements java.util.Set.hashCode. Returns the hash code value for this set.
public void	initializeFromCache(CollectionPersister persister, Serializable disassembled, Object owner) Implements org.hibernate.collection.PersistentCollection.initializeFromCache. Read the state of the collection from a disassembled cached value
public boolean	isEmpty() Implements java.util.Set.isEmpty. Returns `true` if this set contains no elements.
public boolean	isRowUpdatePossible() Overrides org.hibernate.collection.AbstractPersistentCollection.isRowUpdatePossible. Implements org.hibernate.collection.PersistentCollection.isRowUpdatePossible.
public boolean	isSnapshotEmpty(Serializable snapshot) Implements org.hibernate.collection.PersistentCollection.isSnapshotEmpty. Is the snapshot empty?
public boolean	isWrapper(Object collection) Implements org.hibernate.collection.PersistentCollection.isWrapper. Is this the wrapper for the given underlying collection instance?
public Iterator<E>	iterator() Implements java.util.Set.iterator. Returns an iterator over the elements in this set.
public boolean	needsInserting(Object entry, int i, Type elemType) Implements org.hibernate.collection.PersistentCollection.needsInserting. Do we need to insert this element?
public boolean	needsUpdating(Object entry, int i, Type elemType) Implements org.hibernate.collection.PersistentCollection.needsUpdating. Do we need to update this element?
public Object	readFrom(ResultSet rs, CollectionPersister persister, CollectionAliases descriptor, Object owner) Implements org.hibernate.collection.PersistentCollection.readFrom. Read a row from the JDBC result set
public boolean	remove(Object object to be removed from this set, if present value) Implements java.util.Set.remove. Removes the specified element from this set if it is present (optional operation).
public boolean	removeAll(Collection<E> collection containing elements to be removed from this set coll) Implements java.util.Set.removeAll. Removes from this set all of its elements that are contained in the specified collection (optional operation).
public boolean	retainAll(Collection<E> collection containing elements to be retained in this set coll) Implements java.util.Set.retainAll. Retains only the elements in this set that are contained in the specified collection (optional operation).
public int	size() Implements java.util.Set.size. Returns the number of elements in this set (its cardinality).
public Object[]	toArray() Implements java.util.Set.toArray. Returns an array containing all of the elements in this set.
public Object[]	toArray(Object[] the array into which the elements of this set are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose. array) Implements java.util.Set.toArray. Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

set	back to summary
protected Set<E> set

tempList	back to summary
protected transient List<E> tempList

PersistentSet	back to summary
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	back to summary
public PersistentSet(SessionImplementor session) Constructor matching super. Instantiates a lazy set (the underlying set is un-initialized). Parameters session:SessionImplementor The session to which this set will belong.

PersistentSet	back to summary
public PersistentSet(SessionImplementor session, Set<E> set) Instantiates a non-lazy set (the underlying set is constructed from the incoming set reference). Parameters session:SessionImplementor The session to which this set will belong. set:Set<E> The underlying set data.

Method Detail

add back to summary

add	back to summary
public boolean add(Object value) Implements java.util.Set.add. Doc from java.util.Set.add. Adds the specified element to this set if it is not already present (optional operation). More formally, adds the specified element `e` to this set if the set contains no element `e2` such that `Objects.equals(e, e2)`. If this set already contains the element, the call leaves the set unchanged and returns `false`. In combination with the restriction on constructors, this ensures that sets never contain duplicate elements. The stipulation above does not imply that sets must accept all elements; sets may refuse to add any particular element, including `null`, and throw an exception, as described in the specification for `Collection.add`. Individual set implementations should clearly document any restrictions on the elements that they may contain. Parameters value:Object element to be added to this set Returns:boolean `true` if this set did not already contain the specified element See Also `java.util.Set#add(Object)`

public boolean add(Object value)

Implements java.util.Set.add.

Doc from java.util.Set.add.

Adds the specified element to this set if it is not already present (optional operation). More formally, adds the specified element e to this set if the set contains no element e2 such that Objects.equals(e, e2). If this set already contains the element, the call leaves the set unchanged and returns false. In combination with the restriction on constructors, this ensures that sets never contain duplicate elements.

The stipulation above does not imply that sets must accept all elements; sets may refuse to add any particular element, including null, and throw an exception, as described in the specification for Collection.add. Individual set implementations should clearly document any restrictions on the elements that they may contain.

Parameters

value:Object: element to be added to this set

Returns:boolean

true if this set did not already contain the specified element

See Also

java.util.Set#add(Object)

addAll back to summary

addAll	back to summary
public boolean addAll(Collection<E> coll) Implements java.util.Set.addAll. Doc from java.util.Set.addAll. Adds all of the elements in the specified collection to this set if they're not already present (optional operation). If the specified collection is also a set, the `addAll` operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. Parameters coll:Collection<E> collection containing elements to be added to this set Returns:boolean `true` if this set changed as a result of the call See Also `java.util.Set#addAll(Collection)`

public boolean addAll(Collection<E> coll)

Implements java.util.Set.addAll.

Doc from java.util.Set.addAll.

Adds all of the elements in the specified collection to this set if they're not already present (optional operation). If the specified collection is also a set, the addAll operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress.

Parameters

coll:Collection<E>: collection containing elements to be added to this set

Returns:boolean

true if this set changed as a result of the call

See Also

java.util.Set#addAll(Collection)

beforeInitialize	back to summary
public void beforeInitialize(CollectionPersister persister, int anticipatedSize) Implements org.hibernate.collection.PersistentCollection.beforeInitialize. Doc from org.hibernate.collection.PersistentCollection.beforeInitialize. Called before any elements are read into the collection, allowing appropriate initializations to occur. Parameters persister:CollectionPersister The underlying collection persister. anticipatedSize:int The anticipated size of the collection after initilization is complete.

beforeInitialize

Modifier and Type	Method and Description
public Object	getAddedInstance() Implements org.hibernate.collection.AbstractPersistentCollection.DelayedOperation.getAddedInstance.
public Object	getOrphan() Implements org.hibernate.collection.AbstractPersistentCollection.DelayedOperation.getOrphan.
public void	operate() Implements org.hibernate.collection.AbstractPersistentCollection.DelayedOperation.operate.

public Class PersistentSet

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class PersistentSet.Clear

Constructor Summary

Method Summary

Constructor Detail

Method Detail

pack-priv final Class PersistentSet.SimpleAdd

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class PersistentSet.SimpleRemove

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail