# AtomicMarkableReference

public class **AtomicMarkableReference** extends [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)  
An `AtomicMarkableReference` maintains an object reference
along with a mark bit, that can be updated atomically.

Implementation note: This implementation maintains markable
references by creating internal objects representing "boxed"
\[reference, boolean\] pairs.

### Public Constructor Summary

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

### Public Method Summary

|---|---|
| boolean | [attemptMark](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicMarkableReference.html#attemptMark(V,%20boolean))(V expectedReference, boolean newMark) Atomically sets the value of the mark 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/AtomicMarkableReference.html#compareAndSet(V,%20V,%20boolean,%20boolean))(V expectedReference, V newReference, boolean expectedMark, boolean newMark) Atomically sets the value of both the reference and mark to the given update values if the current reference is `==` to the expected reference and the current mark is equal to the expected mark. |
| V | [get](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicMarkableReference.html#get(boolean[]))(boolean\[\] markHolder) Returns the current values of both the reference and the mark. |
| V | [getReference](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicMarkableReference.html#getReference())() Returns the current value of the reference. |
| boolean | [isMarked](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicMarkableReference.html#isMarked())() Returns the current value of the mark. |
| void | [set](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicMarkableReference.html#set(V,%20boolean))(V newReference, boolean newMark) Unconditionally sets the value of both the reference and mark. |
| boolean | [weakCompareAndSet](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicMarkableReference.html#weakCompareAndSet(V,%20V,%20boolean,%20boolean))(V expectedReference, V newReference, boolean expectedMark, boolean newMark) Atomically sets the value of both the reference and mark to the given update values if the current reference is `==` to the expected reference and the current mark is equal to the expected mark. |

### 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
**AtomicMarkableReference**
(V initialRef, boolean initialMark)

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

##### Parameters

| initialRef | the initial reference |
| initialMark | the initial mark |
|---|---|

## Public Methods

#### public boolean
**attemptMark**
(V expectedReference, boolean newMark)

Atomically sets the value of the mark 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 |
| newMark | the new value for the mark |
|---|---|

##### Returns

- `true` if successful

#### public boolean
**compareAndSet**
(V expectedReference, V newReference, boolean expectedMark, boolean newMark)

Atomically sets the value of both the reference and mark
to the given update values if the
current reference is `==` to the expected reference
and the current mark is equal to the expected mark.

##### Parameters

| expectedReference | the expected value of the reference |
| newReference | the new value for the reference |
| expectedMark | the expected value of the mark |
| newMark | the new value for the mark |
|---|---|

##### Returns

- `true` if successful

#### public V
**get**
(boolean\[\] markHolder)

Returns the current values of both the reference and the mark.
Typical usage is `boolean[1] holder; ref = v.get(holder); `.

##### Parameters

| markHolder | an array of size of at least one. On return, `markHolder[0]` will hold the value of the mark. |
|---|---|

##### 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 boolean
**isMarked**
()

Returns the current value of the mark.

##### Returns

- the current value of the mark

#### public void
**set**
(V newReference, boolean newMark)

Unconditionally sets the value of both the reference and mark.

##### Parameters

| newReference | the new value for the reference |
| newMark | the new value for the mark |
|---|---|

#### public boolean
**weakCompareAndSet**
(V expectedReference, V newReference, boolean expectedMark, boolean newMark)

Atomically sets the value of both the reference and mark
to the given update values if the
current reference is `==` to the expected reference
and the current mark is equal to the expected mark.

[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 |
| expectedMark | the expected value of the mark |
| newMark | the new value for the mark |
|---|---|

##### Returns

- `true` if successful