Top Description Fields Constructors Methods
org.hibernate.cache.internal

public Class NaturalIdCacheKey

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Imports
java.io.IOException, .ObjectInputStream, .Serializable, java.util.Arrays, .Objects, org.hibernate.engine.spi.SessionFactoryImplementor, .SharedSessionContractImplementor, org.hibernate.internal.util.ValueHolder, org.hibernate.type.EntityType, .Type
Defines a key for caching natural identifier resolutions into the second level cache. This was named org.hibernate.cache.spi.NaturalIdCacheKey in Hibernate until version 5. Temporarily maintained as a reference while all components catch up with the refactoring to the caching interfaces.
Authors
Eric Dalquist, Steve Ebersole

Field Summary

Modifier and TypeField and Description
private final String
entityName

private final int
hashCode

private final Serializable[]
naturalIdValues

private final String
tenantId

private transient ValueHolder<String>
toString

Constructor Summary

AccessConstructor and Description
public
NaturalIdCacheKey(final Object[]
The naturalIdValues associated with the cached data
naturalIdValues, Type[] propertyTypes, int[] naturalIdPropertyIndexes, final String entityName, final SharedSessionContractImplementor
The originating session
session)

Construct a new key for a caching natural identifier resolutions into the second level cache.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public String
getEntityName()

public Serializable[]
getNaturalIdValues()

public String
getTenantId()

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
private void
initTransients()

private void
readObject(ObjectInputStream ois)

public String
toString()

Overrides java.lang.Object.toString.

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

Field Detail

entityNameback to summary
private final String entityName
hashCodeback to summary
private final int hashCode
naturalIdValuesback to summary
private final Serializable[] naturalIdValues
tenantIdback to summary
private final String tenantId
toStringback to summary
private transient ValueHolder<String> toString

Constructor Detail

NaturalIdCacheKeyback to summary
public NaturalIdCacheKey(final Object[] naturalIdValues, Type[] propertyTypes, int[] naturalIdPropertyIndexes, final String entityName, final SharedSessionContractImplementor session)

Construct a new key for a caching natural identifier resolutions into the second level cache.

Parameters
naturalIdValues:Object[]

The naturalIdValues associated with the cached data

session:SharedSessionContractImplementor

The originating session

Method Detail

equalsback to summary
public boolean equals(Object o)

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
o: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
getEntityNameback to summary
public String getEntityName()
Annotations
@SuppressWarnings:UnusedDeclaration
getNaturalIdValuesback to summary
public Serializable[] getNaturalIdValues()
Annotations
@SuppressWarnings:UnusedDeclaration
getTenantIdback to summary
public String getTenantId()
Annotations
@SuppressWarnings:UnusedDeclaration
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
initTransientsback to summary
private void initTransients()
readObjectback to summary
private void readObject(ObjectInputStream ois) throws ClassNotFoundException, IOException
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