Top Description Fields Constructors Methods
net.sf.ehcache.transaction

public final Class SoftLockID

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Imports
net.sf.ehcache.Element, java.io.Serializable

A soft lock ID is used to uniquely identify a soft lock
Author
Ludovic Orban

Field Summary

Modifier and TypeField and Description
private final Object
private final Element
private final Element
private static final int
private final TransactionID

Constructor Summary

AccessConstructor and Description
public
SoftLockID(TransactionID
the transaction ID
transactionID
,
Object
the element's key this soft lock is going to protect
key
,
Element
the new element, can be null
newElement
,
Element
the old element, can be null
oldElement
)

Create a new SoftLockID instance

Method Summary

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

Overrides java.lang.Object.equals.

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

Returns:

the key
getKey
()

Get the key of the element this soft lock is guarding

public Element

Returns:

the commit Element
getNewElement
()

Get the Element with which this soft lock should be replaced by on commit.

public Element

Returns:

the rollback Element
getOldElement
()

Get the Element with which this soft lock should be replaced by on rollback.

public TransactionID

Returns:

the TransactionID
getTransactionID
()

Get the ID of the transaction under which this soft lock is operating

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

keyback to summary
private final Object key
newElementback to summary
private final Element newElement
oldElementback to summary
private final Element oldElement
PRIMEback to summary
private static final int PRIME
transactionIDback to summary
private final TransactionID transactionID

Constructor Detail

SoftLockIDback to summary
public SoftLockID(TransactionID transactionID, Object key, Element newElement, Element oldElement)

Create a new SoftLockID instance

Parameters
transactionID:TransactionID

the transaction ID

key:Object

the element's key this soft lock is going to protect

newElement:Element

the new element, can be null

oldElement:Element

the old element, can be null

Method Detail

equalsback to summary
public boolean equals(Object object)

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
object: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
getKeyback to summary
public Object getKey()

Get the key of the element this soft lock is guarding

Returns:Object

the key

getNewElementback to summary
public Element getNewElement()

Get the Element with which this soft lock should be replaced by on commit.

Returns:Element

the commit Element

getOldElementback to summary
public Element getOldElement()

Get the Element with which this soft lock should be replaced by on rollback.

Returns:Element

the rollback Element

getTransactionIDback to summary
public TransactionID getTransactionID()

Get the ID of the transaction under which this soft lock is operating

Returns:TransactionID

the TransactionID

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