java.util.concurrent.atomic
Class AtomicStampedReference<V>

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.util.concurrent.atomic.AtomicStampedReference<V>
Type Parameters:
V - The type of object referred to by this reference

public class AtomicStampedReference<V>
extends Object sample code for java.lang.Object definition code for java.lang.Object

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.

Since:
1.5

Constructor Summary
AtomicStampedReference sample code for java.util.concurrent.atomic.AtomicStampedReference.AtomicStampedReference(V, int) definition code for java.util.concurrent.atomic.AtomicStampedReference.AtomicStampedReference(V, int) (V initialRef, int initialStamp)
          Creates a new AtomicStampedReference with the given initial values.
 
Method Summary
 boolean attemptStamp sample code for java.util.concurrent.atomic.AtomicStampedReference.attemptStamp(V, int) definition code for java.util.concurrent.atomic.AtomicStampedReference.attemptStamp(V, int) (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 sample code for java.util.concurrent.atomic.AtomicStampedReference.compareAndSet(V, V, int, int) definition code for java.util.concurrent.atomic.AtomicStampedReference.compareAndSet(V, V, int, int) (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 sample code for java.util.concurrent.atomic.AtomicStampedReference.get(int[]) definition code for java.util.concurrent.atomic.AtomicStampedReference.get(int[]) (int[] stampHolder)
          Returns the current values of both the reference and the stamp.
 V getReference sample code for java.util.concurrent.atomic.AtomicStampedReference.getReference() definition code for java.util.concurrent.atomic.AtomicStampedReference.getReference() ()
          Returns the current value of the reference.
 int getStamp sample code for java.util.concurrent.atomic.AtomicStampedReference.getStamp() definition code for java.util.concurrent.atomic.AtomicStampedReference.getStamp() ()
          Returns the current value of the stamp.
 void set sample code for java.util.concurrent.atomic.AtomicStampedReference.set(V, int) definition code for java.util.concurrent.atomic.AtomicStampedReference.set(V, int) (V newReference, int newStamp)
          Unconditionally sets the value of both the reference and stamp.
 boolean weakCompareAndSet sample code for java.util.concurrent.atomic.AtomicStampedReference.weakCompareAndSet(V, V, int, int) definition code for java.util.concurrent.atomic.AtomicStampedReference.weakCompareAndSet(V, V, int, int) (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 class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

AtomicStampedReference sample code for java.util.concurrent.atomic.AtomicStampedReference(V, int) definition code for java.util.concurrent.atomic.AtomicStampedReference(V, int)

public AtomicStampedReference(V initialRef,
                              int initialStamp)
Creates a new AtomicStampedReference with the given initial values.

Parameters:
initialRef - the initial reference
initialStamp - the initial stamp
Method Detail

getReference sample code for java.util.concurrent.atomic.AtomicStampedReference.getReference() definition code for java.util.concurrent.atomic.AtomicStampedReference.getReference()

public V getReference()
Returns the current value of the reference.

Returns:
the current value of the reference

getStamp sample code for java.util.concurrent.atomic.AtomicStampedReference.getStamp() definition code for java.util.concurrent.atomic.AtomicStampedReference.getStamp()

public int getStamp()
Returns the current value of the stamp.

Returns:
the current value of the stamp

get sample code for java.util.concurrent.atomic.AtomicStampedReference.get(int[]) definition code for java.util.concurrent.atomic.AtomicStampedReference.get(int[])

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:
stampHolder - an array of size of at least one. On return, stampholder[0] will hold the value of the stamp.
Returns:
the current value of the reference

weakCompareAndSet sample code for java.util.concurrent.atomic.AtomicStampedReference.weakCompareAndSet(V, V, int, int) definition code for java.util.concurrent.atomic.AtomicStampedReference.weakCompareAndSet(V, V, int, int)

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. 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:
expectedReference - the expected value of the reference
newReference - the new value for the reference
expectedStamp - the expected value of the stamp
newStamp - the new value for the stamp
Returns:
true if successful

compareAndSet sample code for java.util.concurrent.atomic.AtomicStampedReference.compareAndSet(V, V, int, int) definition code for java.util.concurrent.atomic.AtomicStampedReference.compareAndSet(V, V, int, int)

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:
expectedReference - the expected value of the reference
newReference - the new value for the reference
expectedStamp - the expected value of the stamp
newStamp - the new value for the stamp
Returns:
true if successful

set sample code for java.util.concurrent.atomic.AtomicStampedReference.set(V, int) definition code for java.util.concurrent.atomic.AtomicStampedReference.set(V, int)

public void set(V newReference,
                int newStamp)
Unconditionally sets the value of both the reference and stamp.

Parameters:
newReference - the new value for the reference
newStamp - the new value for the stamp

attemptStamp sample code for java.util.concurrent.atomic.AtomicStampedReference.attemptStamp(V, int) definition code for java.util.concurrent.atomic.AtomicStampedReference.attemptStamp(V, int)

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:
expectedReference - the expected value of the reference
newStamp - the new value for the stamp
Returns:
true if successful