Class CollectionKey

java.lang.Object
org.hibernate.engine.spi.CollectionKey
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
TemporalCollectionKey
public sealed class CollectionKey extends Object implements Serializable permits TemporalCollectionKey
Uniquely identifies a collection instance in a particular session.

For temporal collections, use TemporalCollectionKey which includes a changeset identifier to isolate historical snapshots in the persistence context.

See Also:

  • Constructor Details

  • Method Details

    • getRole

      public String getRole()

    • getKey

      public Object getKey()

    • getChangesetId

      public @Nullable Object getChangesetId()
      The audit changeset identifier for this key, or null for non-temporal collections.

    • isTemporal

      public boolean isTemporal()
      Whether this key refers to a temporal (historical) collection snapshot.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(@Nullable Object other)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • serialize

      public void serialize(ObjectOutputStream oos) throws IOException
      Custom serialization routine used during serialization of a Session/PersistenceContext for increased performance.
      Parameters:
      oos - The stream to which we should write the serial data.
      Throws:
      IOException

    • deserialize

      public static CollectionKey deserialize(ObjectInputStream ois, SessionImplementor session) throws IOException, ClassNotFoundException
      Custom deserialization routine used during deserialization of a Session/PersistenceContext for increased performance.
      Parameters:
      ois - The stream from which to read the entry.
      session - The session being deserialized.
      Returns:
      The deserialized CollectionKey
      Throws:
      IOException
      ClassNotFoundException