Top Description Fields Constructors Methods
org.hibernate.engine.spi

public final Class EntityKey

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Imports
java.io.IOException, .ObjectInputStream, .ObjectOutputStream, .Serializable, org.hibernate.AssertionFailure, org.hibernate.persister.entity.EntityPersister, org.hibernate.pretty.MessageHelper, org.checkerframework.checker.nullness.qual.Nullable
Uniquely identifies of an entity instance in a particular Session by identifier. Note that it's only safe to be used within the scope of a Session: it doesn't consider for example the tenantId as part of the equality definition.

Information used to determine uniqueness consists of the entity-name and the identifier value (see equals).

Performance considerations: lots of instances of this type are created at runtime. Make sure each one is as small as possible by storing just the essential needed.

Authors
Gavin King, Sanne Grinovero

Field Summary

Modifier and TypeField and Description
private final int
hashCode

private final Object
identifier

private final EntityPersister
persister

Constructor Summary

AccessConstructor and Description
public
EntityKey(@Nullable Object
The entity id
id, EntityPersister
The entity persister
persister)

Construct a unique identifier for an entity class instance.

Method Summary

Modifier and TypeMethod and Description
public static EntityKey

Returns:

The deserialized EntityEntry
deserialize(ObjectInputStream
The stream from which to read the entry.
ois, SessionFactoryImplementor
The SessionFactory owning the Session being deserialized.
sessionFactory)

Deprecated as a consequence of SessionFactoryImplementor being deprecated.
Custom deserialization routine used during deserialization of a Session/PersistenceContext for increased performance.
public boolean
equals(@Nullable Object
the reference object with which to compare.
other)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
private int
generateHashCode()

public String
getEntityName()

public Object
getIdentifier()

public Object
getIdentifierValue()

public EntityPersister
getPersister()

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public boolean
isBatchLoadable(LoadQueryInfluencers influencers)

private boolean
sameIdentifier(final EntityKey otherKey)

private boolean
samePersistentType(final EntityKey otherKey)

public void
serialize(ObjectOutputStream
The stream to which we should write the serial data.
oos)

Custom serialization routine used during serialization of a Session/PersistenceContext for increased performance.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

hashCodeback to summary
private final int hashCode
identifierback to summary
private final Object identifier
persisterback to summary
private final EntityPersister persister

Constructor Detail

EntityKeyback to summary
public EntityKey(@Nullable Object id, EntityPersister persister)

Construct a unique identifier for an entity class instance.

API Note

This signature has changed to accommodate both entity mode and multi-tenancy, both of which relate to the session to which this key belongs. To help minimize the impact of these changes in the future, the SessionImplementor#generateEntityKey method was added to hide the session-specific changes.

Parameters
id:@Nullable Object

The entity id

persister:EntityPersister

The entity persister

Method Detail

deserializeback to summary
public static EntityKey deserialize(ObjectInputStream ois, SessionFactoryImplementor sessionFactory) throws IOException, ClassNotFoundException

Deprecated

as a consequence of SessionFactoryImplementor being deprecated. See corresponding docs for further information.

Custom deserialization routine used during deserialization of a Session/PersistenceContext for increased performance.

Parameters
ois:ObjectInputStream

The stream from which to read the entry.

sessionFactory:SessionFactoryImplementor

The SessionFactory owning the Session being deserialized.

Returns:EntityKey

The deserialized EntityEntry

Exceptions
IOException:
Thrown by Java I/O
ClassNotFoundException:
Thrown by Java I/O
equalsback to summary
public boolean equals(@Nullable Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
other:@Nullable Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
generateHashCodeback to summary
private int generateHashCode()
getEntityNameback to summary
public String getEntityName()
getIdentifierback to summary
public Object getIdentifier()
getIdentifierValueback to summary
public Object getIdentifierValue()
getPersisterback to summary
public EntityPersister getPersister()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
isBatchLoadableback to summary
public boolean isBatchLoadable(LoadQueryInfluencers influencers)
sameIdentifierback to summary
private boolean sameIdentifier(final EntityKey otherKey)
samePersistentTypeback to summary
private boolean samePersistentType(final EntityKey otherKey)
serializeback to summary
public void serialize(ObjectOutputStream oos) throws IOException

Custom serialization routine used during serialization of a Session/PersistenceContext for increased performance.

Parameters
oos:ObjectOutputStream

The stream to which we should write the serial data.

Exceptions
IOException:
Thrown by Java I/O
toStringback to summary
public String toString()

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