edu.emory.mathcs.backport.java.util.concurrent.atomic.AtomicStampedReference Maven / Gradle / Ivy
Show all versions of virtdata-lib-curves4 Show documentation
/*
* Written by Doug Lea with assistance from members of JCP JSR-166
* Expert Group and released to the public domain, as explained at
* http://creativecommons.org/licenses/publicdomain
*/
package edu.emory.mathcs.backport.java.util.concurrent.atomic;
/**
* An {@code 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
* @author Doug Lea
*/
public class AtomicStampedReference {
private static class ReferenceIntegerPair {
private final Object reference;
private final int integer;
ReferenceIntegerPair(Object r, int i) {
reference = r; integer = i;
}
}
private final AtomicReference atomicRef;
/**
* Creates a new {@code AtomicStampedReference} with the given
* initial values.
*
* @param initialRef the initial reference
* @param initialStamp the initial stamp
*/
public AtomicStampedReference(Object initialRef, int initialStamp) {
atomicRef = new AtomicReference(
new ReferenceIntegerPair(initialRef, initialStamp));
}
/**
* Returns the current value of the reference.
*
* @return the current value of the reference
*/
public Object getReference() {
return getPair().reference;
}
/**
* Returns the current value of the stamp.
*
* @return the current value of the stamp
*/
public int getStamp() {
return getPair().integer;
}
/**
* Returns the current values of both the reference and the stamp.
* Typical usage is {@code int[1] holder; ref = v.get(holder); }.
*
* @param stampHolder an array of size of at least one. On return,
* {@code stampholder[0]} will hold the value of the stamp.
* @return the current value of the reference
*/
public Object get(int[] stampHolder) {
ReferenceIntegerPair p = getPair();
stampHolder[0] = p.integer;
return p.reference;
}
/**
* Atomically sets the value of both the reference and stamp
* to the given update values if the
* current reference is {@code ==} 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 {@code compareAndSet}.
*
* @param expectedReference the expected value of the reference
* @param newReference the new value for the reference
* @param expectedStamp the expected value of the stamp
* @param newStamp the new value for the stamp
* @return true if successful
*/
public boolean weakCompareAndSet(Object expectedReference,
Object newReference,
int expectedStamp,
int newStamp) {
ReferenceIntegerPair current = getPair();
return expectedReference == current.reference &&
expectedStamp == current.integer &&
((newReference == current.reference &&
newStamp == current.integer) ||
atomicRef.weakCompareAndSet(current,
new ReferenceIntegerPair(newReference,
newStamp)));
}
/**
* Atomically sets the value of both the reference and stamp
* to the given update values if the
* current reference is {@code ==} to the expected reference
* and the current stamp is equal to the expected stamp.
*
* @param expectedReference the expected value of the reference
* @param newReference the new value for the reference
* @param expectedStamp the expected value of the stamp
* @param newStamp the new value for the stamp
* @return true if successful
*/
public boolean compareAndSet(Object expectedReference,
Object newReference,
int expectedStamp,
int newStamp) {
ReferenceIntegerPair current = getPair();
return expectedReference == current.reference &&
expectedStamp == current.integer &&
((newReference == current.reference &&
newStamp == current.integer) ||
atomicRef.compareAndSet(current,
new ReferenceIntegerPair(newReference,
newStamp)));
}
/**
* Unconditionally sets the value of both the reference and stamp.
*
* @param newReference the new value for the reference
* @param newStamp the new value for the stamp
*/
public void set(Object newReference, int newStamp) {
ReferenceIntegerPair current = getPair();
if (newReference != current.reference || newStamp != current.integer)
atomicRef.set(new ReferenceIntegerPair(newReference, newStamp));
}
/**
* Atomically sets the value of the stamp to the given update value
* if the current reference is {@code ==} to the expected
* reference. Any given invocation of this operation may fail
* (return {@code 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.
*
* @param expectedReference the expected value of the reference
* @param newStamp the new value for the stamp
* @return true if successful
*/
public boolean attemptStamp(Object expectedReference, int newStamp) {
ReferenceIntegerPair current = getPair();
return expectedReference == current.reference &&
(newStamp == current.integer ||
atomicRef.compareAndSet(current,
new ReferenceIntegerPair(expectedReference,
newStamp)));
}
private ReferenceIntegerPair getPair() {
return (ReferenceIntegerPair)atomicRef.get();
}
}