Top Description Fields Constructors Methods
org.hibernate.cache

public Class CacheKey

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Imports
java.io.Serializable, org.hibernate.EntityMode, org.hibernate.engine.SessionFactoryImplementor, org.hibernate.type.Type
Allows multiple entity classes / collection roles to be stored in the same cache region. Also allows for composite keys which do not properly implement equals()/hashCode().
Author
Gavin King

Field Summary

Modifier and TypeField and Description
private final EntityMode
entityMode

private final String
entityOrRoleName

private final int
hashCode

private final Serializable
key

private final Type
type

Constructor Summary

AccessConstructor and Description
public
CacheKey(final Serializable
The identifier associated with the cached data
id, final Type
The Hibernate type mapping
type, final String
The entity or collection-role name.
entityOrRoleName, final EntityMode
The entiyt mode of the originating session
entityMode, final SessionFactoryImplementor
The session factory for which we are caching
factory)

Construct a new key for a collection or entity instance.

Method Summary

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

Overrides java.lang.Object.equals.

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

public Serializable
getKey()

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public String
toString()

Overrides java.lang.Object.toString.

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

Field Detail

entityModeback to summary
private final EntityMode entityMode
entityOrRoleNameback to summary
private final String entityOrRoleName
hashCodeback to summary
private final int hashCode
keyback to summary
private final Serializable key
typeback to summary
private final Type type

Constructor Detail

CacheKeyback to summary
public CacheKey(final Serializable id, final Type type, final String entityOrRoleName, final EntityMode entityMode, final SessionFactoryImplementor factory)

Construct a new key for a collection or entity instance. Note that an entity name should always be the root entity name, not a subclass entity name.

Parameters
id:Serializable

The identifier associated with the cached data

type:Type

The Hibernate type mapping

entityOrRoleName:String

The entity or collection-role name.

entityMode:EntityMode

The entiyt mode of the originating session

factory:SessionFactoryImplementor

The session factory for which we are caching

Method Detail

equalsback to summary
public boolean equals(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:Object

the reference object with which to compare.

Returns:boolean

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

getEntityOrRoleNameback to summary
public String getEntityOrRoleName()
getKeyback to summary
public Serializable getKey()
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.

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.