Android APIs
public class

AtomicMarkableReference

extends Object
java.lang.Object
   ↳ java.util.concurrent.atomic.AtomicMarkableReference<V>

Class Overview

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.

Summary

Public Constructors
AtomicMarkableReference(V initialRef, boolean initialMark)
Creates a new AtomicMarkableReference with the given initial values.
Public Methods
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.
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.
V get(boolean[] markHolder)
Returns the current values of both the reference and the mark.
V getReference()
Returns the current value of the reference.
boolean isMarked()
Returns the current value of the mark.
void set(V newReference, boolean newMark)
Unconditionally sets the value of both the reference and mark.
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.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public AtomicMarkableReference (V initialRef, boolean initialMark)

Added in API level 1

Creates a new AtomicMarkableReference with the given initial values.

Parameters
initialRef V: the initial reference
initialMark boolean: the initial mark

Public Methods

public boolean attemptMark (V expectedReference, boolean newMark)

Added in API level 1

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 V: the expected value of the reference
newMark boolean: the new value for the mark
Returns
boolean true if successful

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

Added in API level 1

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 V: the expected value of the reference
newReference V: the new value for the reference
expectedMark boolean: the expected value of the mark
newMark boolean: the new value for the mark
Returns
boolean true if successful

public V get (boolean[] markHolder)

Added in API level 1

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

Parameters
markHolder boolean: an array of size of at least one. On return, markHolder[0] will hold the value of the mark.
Returns
V the current value of the reference

public V getReference ()

Added in API level 1

Returns the current value of the reference.

Returns
V the current value of the reference

public boolean isMarked ()

Added in API level 1

Returns the current value of the mark.

Returns
boolean the current value of the mark

public void set (V newReference, boolean newMark)

Added in API level 1

Unconditionally sets the value of both the reference and mark.

Parameters
newReference V: the new value for the reference
newMark boolean: the new value for the mark

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

Added in API level 1

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, so is only rarely an appropriate alternative to compareAndSet.

Parameters
expectedReference V: the expected value of the reference
newReference V: the new value for the reference
expectedMark boolean: the expected value of the mark
newMark boolean: the new value for the mark
Returns
boolean true if successful