Eclipse
Eclipse
IDEA
IntelliJ
NetBeans
NetBeans
XpoLog
XpoLog
java.util.concurrent.atomic
Class AtomicStampedReference
Tab mode
public class AtomicStampedReference<V>
Type Parameters:
  • V - The type of object referred to by this reference
An AtomicStampedReference maintains an object reference along with an integer "stamp", that can be updated atomically.

Implementation note. This implementation maintains stamped references by creating internal objects representing "boxed" [reference, integer] pairs.

Since1.5
VersionNot specified.
AuthorDoug Lea
Wiki javadoc Use textile entry format.
Add your comments here.
Constructor Summary
AtomicStampedReference( V initialRef, int initialStamp )
Creates a new AtomicStampedReference with the given initial values.
Method Summary
boolean attemptStamp( V expectedReference, int newStamp )
Atomically sets the value of the stamp to the given update value if the current reference is == to the expected reference.
boolean compareAndSet( V expectedReference, V newReference, int expectedStamp, int newStamp )
Atomically sets the value of both the reference and stamp to the given update values if the current reference is == to the expected reference and the current stamp is equal to the expected stamp.
V get( int [] stampHolder )
Returns the current values of both the reference and the stamp.
V getReference()
Returns the current value of the reference.
int getStamp()
Returns the current value of the stamp.
void set( V newReference, int newStamp )
Unconditionally sets the value of both the reference and stamp.
boolean weakCompareAndSet( V expectedReference, V newReference, int expectedStamp, int newStamp )
Atomically sets the value of both the reference and stamp to the given update values if the current reference is == to the expected reference and the current stamp is equal to the expected stamp.
Methods inherited from java.langObject
Constructor Detail
AtomicStampedReference
public AtomicStampedReference ( V initialRef, int initialStamp )
Creates a new AtomicStampedReference with the given initial values.
Parameters
TypeNameDescription
V initialRef the initial reference
int initialStamp the initial stamp
Wiki javadoc Use textile entry format.
Add your comments here.
Method Detail
attemptStamp
public boolean attemptStamp ( V expectedReference, int newStamp )
Atomically sets the value of the stamp to the given update value if the current reference is == to the expected reference. Any given invocation of this operation may fail (return false ) spuriously, but repeated invocation when the current value holds the expected value and no other thread is also attempting to set the value will eventually succeed.
Parameters
TypeNameDescription
V expectedReference the expected value of the reference
int newStamp the new value for the stamp
Wiki javadoc Use textile entry format.
Add your comments here.
compareAndSet
public boolean compareAndSet ( V expectedReference, V newReference, int expectedStamp, int newStamp )
Atomically sets the value of both the reference and stamp to the given update values if the current reference is == to the expected reference and the current stamp is equal to the expected stamp.
Parameters
TypeNameDescription
V expectedReference the expected value of the reference
V newReference the new value for the reference
int expectedStamp the expected value of the stamp
int newStamp the new value for the stamp
Wiki javadoc Use textile entry format.
Add your comments here.
get
public V get ( int [] stampHolder )
Returns the current values of both the reference and the stamp. Typical usage is int[1] holder; ref = v.get(holder); .
Parameters
TypeNameDescription
int[] stampHolder an array of size of at least one. On return, stampholder[0] will hold the value of the stamp.
Wiki javadoc Use textile entry format.
Add your comments here.
getReference
public V getReference ( )
Returns the current value of the reference.
Wiki javadoc Use textile entry format.
Add your comments here.
getStamp
public int getStamp ( )
Returns the current value of the stamp.
Wiki javadoc Use textile entry format.
Add your comments here.
set
public void set ( V newReference, int newStamp )
Unconditionally sets the value of both the reference and stamp.
Parameters
TypeNameDescription
V newReference the new value for the reference
int newStamp the new value for the stamp
Returns void No description provided.
Wiki javadoc Use textile entry format.
Add your comments here.
weakCompareAndSet
public boolean weakCompareAndSet ( V expectedReference, V newReference, int expectedStamp, int newStamp )
Atomically sets the value of both the reference and stamp to the given update values if the current reference is == to the expected reference and the current stamp is equal to the expected stamp.

May fail spuriously and does not provide ordering guarantees, so is only rarely an appropriate alternative to compareAndSet .

Parameters
TypeNameDescription
V expectedReference the expected value of the reference
V newReference the new value for the reference
int expectedStamp the expected value of the stamp
int newStamp the new value for the stamp
Wiki javadoc Use textile entry format.
Add your comments here.