Empty constructor.

Constructor matching super. Instantiates a lazy set (the underlying set is un-initialized).

Parameters

session:SharedSessionContractImplementor

The session to which this set will belong.

Instantiates a non-lazy set (the underlying set is constructed from the incoming set reference).

Parameters

session:SharedSessionContractImplementor

The session to which this set will belong.

set:Set<E>

The underlying set data.

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:E

element to be added to this set

Returns:boolean

true if this set did not already contain the specified element

Annotations

@Override

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<? extends E>

collection containing elements to be added to this set

Returns:boolean

true if this set changed as a result of the call

Annotations

@Override

Implements java.util.Set.clear.

Doc from java.util.Set.clear.

Removes all of the elements from this set (optional operation). The set will be empty after this call returns.

Annotations

@Override

Implements java.util.Set.contains.

Doc from java.util.Set.contains.

Returns true if this set contains the specified element. More formally, returns true if and only if this set contains an element e such that Objects.equals(o, e).

Parameters

object:Object

element whose presence in this set is to be tested

Returns:boolean

true if this set contains the specified element

Annotations

@Override

Implements java.util.Set.containsAll.

Doc from java.util.Set.containsAll.

Returns true if this set contains all of the elements of the specified collection. If the specified collection is also a set, this method returns true if it is a subset of this set.

Parameters

coll:Collection<?>

collection to be checked for containment in this set

Returns:boolean

true if this set contains all of the elements of the specified collection

Annotations

@Override

Implements org.hibernate.collection.spi.PersistentCollection.disassemble.

Doc from org.hibernate.collection.spi.PersistentCollection.disassemble.

Disassemble the collection to get it ready for the cache

Parameters

persister:CollectionPersister

The collection persister

Returns:Object

The disassembled state

Annotations

@Override

Implements abstract org.hibernate.collection.spi.AbstractPersistentCollection.empty.

Implements org.hibernate.collection.spi.PersistentCollection.empty.

Doc from org.hibernate.collection.spi.PersistentCollection.empty.

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

Returns:boolean

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

Annotations

@Override

Implements org.hibernate.collection.spi.PersistentCollection.entries.

Doc from org.hibernate.collection.spi.PersistentCollection.entries.

Iterate all collection entries, during update of the database

Parameters

persister:CollectionPersister

The collection persister.

Returns:Iterator<E>

The iterator

Annotations

@Override

Implements org.hibernate.collection.spi.PersistentCollection.entryExists.

Doc from org.hibernate.collection.spi.PersistentCollection.entryExists.

Does the given element/entry exist in the collection?

Parameters

key:Object

The object to check if it exists as a collection element

i:int

Unused

Returns:boolean

true if the given entry is a collection element

Annotations

@Override

Overrides java.lang.Object.equals.

Implements java.util.Set.equals.

Doc from java.util.Set.equals.

Compares the specified object with this set for equality. Returns true if the specified object is also a set, the two sets have the same size, and every member of the specified set is contained in this set (or equivalently, every member of this set is contained in the specified set). This definition ensures that the equals method works properly across different implementations of the set interface.

Parameters

other:Object

object to be compared for equality with this set

Returns:boolean

true if the specified object is equal to this set

Annotations

@Override

@SuppressWarnings:EqualsWhichDoesntCheckParameterClass

Implements org.hibernate.collection.spi.PersistentCollection.equalsSnapshot.

Doc from org.hibernate.collection.spi.PersistentCollection.equalsSnapshot.

Does the current state exactly match the snapshot?

Parameters

persister:CollectionPersister

The collection persister

Returns:boolean

true if the current state and the snapshot state match.

Annotations

@Override

Implements org.hibernate.collection.spi.PersistentCollection.getDeletes.

Doc from org.hibernate.collection.spi.PersistentCollection.getDeletes.

Get all the elements that need deleting

Parameters

persister:CollectionPersister

The collection persister

indexIsFormula:boolean

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

Returns:Iterator<?>

An iterator over the elements to delete

Annotations

@Override

Implements org.hibernate.collection.spi.PersistentCollection.getElement.

Doc from org.hibernate.collection.spi.PersistentCollection.getElement.

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.

Parameters

entry:Object

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

Returns:Object

The corresponding object that is part of the collection elements.

Annotations

@Override

Implements org.hibernate.collection.spi.PersistentCollection.getIndex.

Doc from org.hibernate.collection.spi.PersistentCollection.getIndex.

Get the index of the given collection entry

Parameters

entry:Object

The collection entry/element

i:int

The assumed index

persister:CollectionPersister

it was more elegant before we added this...

Returns:Object

The index value

Annotations

@Override

Implements abstract org.hibernate.collection.spi.AbstractPersistentCollection.getOrphans.

Implements org.hibernate.collection.spi.PersistentCollection.getOrphans.

Doc from org.hibernate.collection.spi.PersistentCollection.getOrphans.

get all "orphaned" elements

Parameters

snapshot:Serializable

The snapshot state

entityName:String

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

Returns:Collection<E>

The orphans

Annotations

@Override

Implements org.hibernate.collection.spi.PersistentCollection.getSnapshot.

Doc from org.hibernate.collection.spi.PersistentCollection.getSnapshot.

Return a new snapshot of the current state of the collection

Parameters

persister:CollectionPersister

The collection persister

Returns:Serializable

The snapshot

Annotations

@Override

Implements org.hibernate.collection.spi.PersistentCollection.getSnapshotElement.

Doc from org.hibernate.collection.spi.PersistentCollection.getSnapshotElement.

Get the snapshot value of the given collection entry

Parameters

entry:Object

The entry

i:int

The index

Returns:Object

The snapshot state for that element

Annotations

@Override

Overrides java.lang.Object.hashCode.

Implements java.util.Set.hashCode.

Doc from java.util.Set.hashCode.

Returns the hash code value for this set. The hash code of a set is defined to be the sum of the hash codes of the elements in the set, where the hash code of a null element is defined to be zero. This ensures that s1.equals(s2) implies that s1.hashCode()==s2.hashCode() for any two sets s1 and s2, as required by the general contract of Object#hashCode.

Returns:int

the hash code value for this set

Annotations

@Override

Implements org.hibernate.collection.spi.PersistentCollection.initializeEmptyCollection.

Annotations

@Override

Implements org.hibernate.collection.spi.PersistentCollection.initializeFromCache.

Doc from org.hibernate.collection.spi.PersistentCollection.initializeFromCache.

Read the state of the collection from a disassembled cached value

Parameters

persister:CollectionPersister

The collection persister

disassembled:Object

The disassembled cached state

owner:Object

The collection owner

Annotations

@Override

Implements org.hibernate.collection.spi.PersistentCollection.injectLoadedState.

Doc from org.hibernate.collection.spi.PersistentCollection.injectLoadedState.

Inject the state loaded for a collection instance.

Implements java.util.Set.isEmpty.

Doc from java.util.Set.isEmpty.

Returns true if this set contains no elements.

Returns:boolean

true if this set contains no elements

Annotations

@Override

Overrides org.hibernate.collection.spi.AbstractPersistentCollection.isRowUpdatePossible.

Implements org.hibernate.collection.spi.PersistentCollection.isRowUpdatePossible.

Doc from org.hibernate.collection.spi.PersistentCollection.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.

Returns:boolean

true if the row for each element is known

Annotations

@Override

Implements org.hibernate.collection.spi.PersistentCollection.isSnapshotEmpty.

Doc from org.hibernate.collection.spi.PersistentCollection.isSnapshotEmpty.

Is the snapshot empty?

Parameters

snapshot:Serializable

The snapshot to check

Returns:boolean

true if the given snapshot is empty

Annotations

@Override

Implements org.hibernate.collection.spi.PersistentCollection.isWrapper.

Doc from org.hibernate.collection.spi.PersistentCollection.isWrapper.

Is this the wrapper for the given collection instance?

Parameters

collection:Object

The collection to check whether this is wrapping it

Returns:boolean

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

Annotations

@Override

Implements java.util.Set.iterator.

Doc from java.util.Set.iterator.

Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee).

Returns:Iterator<E>

an iterator over the elements in this set

Annotations

@Override

Implements org.hibernate.collection.spi.PersistentCollection.needsInserting.

Doc from org.hibernate.collection.spi.PersistentCollection.needsInserting.

Do we need to insert this element?

Parameters

entry:Object

The collection element to check

i:int

The index (for indexed collections)

elemType:Type

The type for the element

Returns:boolean

true if the element needs inserting

Annotations

@Override

Implements org.hibernate.collection.spi.PersistentCollection.needsUpdating.

Doc from org.hibernate.collection.spi.PersistentCollection.needsUpdating.

Do we need to update this element?

Parameters

entry:Object

The collection element to check

i:int

The index (for indexed collections)

elemType:Type

The type for the element

Returns:boolean

true if the element needs updating

Annotations

@Override

Implements java.util.Set.remove.

Doc from java.util.Set.remove.

Removes the specified element from this set if it is present (optional operation). More formally, removes an element e such that Objects.equals(o, e), if this set contains such an element. Returns true if this set contained the element (or equivalently, if this set changed as a result of the call). (This set will not contain the element once the call returns.)

Parameters

value:Object

object to be removed from this set, if present

Returns:boolean

true if this set contained the specified element

Annotations

@Override

Implements java.util.Set.removeAll.

Doc from java.util.Set.removeAll.

Removes from this set all of its elements that are contained in the specified collection (optional operation). If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets.

Parameters

coll:Collection<?>

collection containing elements to be removed from this set

Returns:boolean

true if this set changed as a result of the call

Annotations

@Override

Implements java.util.Set.retainAll.

Doc from java.util.Set.retainAll.

Retains only the elements in this set that are contained in the specified collection (optional operation). In other words, removes from this set all of its elements that are not contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the intersection of the two sets.

Parameters

coll:Collection<?>

collection containing elements to be retained in this set

Returns:boolean

true if this set changed as a result of the call

Annotations

@Override

Implements java.util.Set.size.

Doc from java.util.Set.size.

Returns the number of elements in this set (its cardinality). If this set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:int

the number of elements in this set (its cardinality)

Annotations

@Override

Implements java.util.Set.toArray.

Doc from java.util.Set.toArray.

Returns an array containing all of the elements in this set. If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

The returned array will be "safe" in that no references to it are maintained by this set. (In other words, this method must allocate a new array even if this set is backed by an array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

Returns:Object[]

an array containing all the elements in this set

Annotations

@Override

Implements java.util.Set.toArray.

Doc from 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. If the set fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this set.

If this set fits in the specified array with room to spare (i.e., the array has more elements than this set), the element in the array immediately following the end of the set is set to null. (This is useful in determining the length of this set only if the caller knows that this set does not contain any null elements.)

If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

Like the toArray() method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs.

Suppose x is a set known to contain only strings. The following code can be used to dump the set into a newly allocated array of String:

    String[] y = x.toArray(new String[0]);

Parameters

<A>

Doc from java.util.Collection.toArray. the component type of the array to contain the collection

array:A[]

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.

Returns:A[]

an array containing all the elements in this set

Annotations

@Override

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override