# AtomicStampedReference

public class **AtomicStampedReference** extends [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)  
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.

### Public Constructor Summary

|---|---|
|   | [AtomicStampedReference](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicStampedReference.html#AtomicStampedReference(V,%20int))(V initialRef, int initialStamp) Creates a new `AtomicStampedReference` with the given initial values. |

### Public Method Summary

|---|---|
| boolean | [attemptStamp](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicStampedReference.html#attemptStamp(V,%20int))(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](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicStampedReference.html#compareAndSet(V,%20V,%20int,%20int))(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](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicStampedReference.html#get(int[]))(int\[\] stampHolder) Returns the current values of both the reference and the stamp. |
| V | [getReference](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicStampedReference.html#getReference())() Returns the current value of the reference. |
| int | [getStamp](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicStampedReference.html#getStamp())() Returns the current value of the stamp. |
| void | [set](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicStampedReference.html#set(V,%20int))(V newReference, int newStamp) Unconditionally sets the value of both the reference and stamp. |
| boolean | [weakCompareAndSet](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicStampedReference.html#weakCompareAndSet(V,%20V,%20int,%20int))(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. |

### Inherited Method Summary

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

## Public Constructors

#### public
**AtomicStampedReference**
(V initialRef, int initialStamp)

Creates a new `AtomicStampedReference` with the given
initial values.

##### Parameters

| initialRef | the initial reference |
| initialStamp | the initial stamp |
|---|---|

## Public Methods

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

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

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

#### public V
**getReference**
()

Returns the current value of the reference.

##### Returns

- the current value of the reference

#### public int
**getStamp**
()

Returns the current value of the stamp.

##### Returns

- the current value of the stamp

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

#### 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](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/package-summary#weakCompareAndSet), so is
only rarely an appropriate alternative to `compareAndSet`.

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