Modifier and Type	Class and Description
private static class	AtomicMarkableReference.Pair<T>

Modifier and Type	Field and Description
private volatile AtomicMarkableReference.Pair<V>	pair
private static final VarHandle	PAIR

Access	Constructor and Description
public	AtomicMarkableReference(V the initial reference initialRef, boolean the initial mark initialMark) Creates a new `AtomicMarkableReference` with the given initial values.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if successful attemptMark(V the expected value of the reference expectedReference, boolean the new value for the mark newMark) Atomically sets the value of the mark to the given update value if the current reference is `==` to the expected reference.
private boolean	casPair(AtomicMarkableReference.Pair<V> cmp, AtomicMarkableReference.Pair<V> val)
public boolean	Returns: `true` if successful compareAndSet(V the expected value of the reference expectedReference, V the new value for the reference newReference, boolean the expected value of the mark expectedMark, boolean the new value for the mark 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.
public V	Returns: the current value of the reference get(boolean[] an array of size of at least one. On return, `markHolder[0]` will hold the value of the mark. markHolder) Returns the current values of both the reference and the mark.
public V	Returns: the current value of the reference getReference() Returns the current value of the reference.
public boolean	Returns: the current value of the mark isMarked() Returns the current value of the mark.
public void	set(V the new value for the reference newReference, boolean the new value for the mark newMark) Unconditionally sets the value of both the reference and mark.
public boolean	Returns: `true` if successful weakCompareAndSet(V the expected value of the reference expectedReference, V the new value for the reference newReference, boolean the expected value of the mark expectedMark, boolean the new value for the mark 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 from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

pair	back to summary
private volatile AtomicMarkableReference.Pair<V> pair

PAIR	back to summary
private static final VarHandle PAIR

Constructor Detail

AtomicMarkableReference back to summary

AtomicMarkableReference	back to summary
public AtomicMarkableReference(V initialRef, boolean initialMark) Creates a new `AtomicMarkableReference` with the given initial values. Parameters initialRef:V the initial reference initialMark:boolean the initial mark

public AtomicMarkableReference(V initialRef, boolean initialMark)

Creates a new AtomicMarkableReference with the given initial values.

Parameters

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

Method Detail

attemptMark back to summary

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

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

Returns:boolean

true if successful

casPair	back to summary
private boolean casPair(AtomicMarkableReference.Pair<V> cmp, AtomicMarkableReference.Pair<V> val)

compareAndSet back to summary

compareAndSet	back to summary
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: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 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: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

get back to summary

get	back to summary
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: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 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: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

getReference	back to summary
public V getReference() Returns the current value of the reference. Returns:V the current value of the reference

getReference

back to summary

public V getReference()

Returns the current value of the reference.

Returns:V: the current value of the reference

isMarked	back to summary
public boolean isMarked() Returns the current value of the mark. Returns:boolean the current value of the mark

isMarked

back to summary

public boolean isMarked()

Returns the current value of the mark.

Returns:boolean: the current value of the mark

set	back to summary
public void set(V newReference, boolean newMark) 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

set

back to summary

public void set(V newReference, boolean newMark)

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

weakCompareAndSet back to summary

weakCompareAndSet	back to summary
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. This operation 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

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. This operation 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

java.util.concurrent.atomic back to summary

private Class AtomicMarkableReference.Pair<T>

Class Inheritance

extends Object

java.lang.Object
java.util.concurrent.atomic.AtomicMarkableReference.Pair

Field Summary

Modifier and Type	Field and Description
pack-priv final boolean	mark
pack-priv final T	reference

Constructor Summary

Access	Constructor and Description
private	Pair(T reference, boolean mark)

Method Summary

Modifier and Type	Method and Description
pack-priv static <T> AtomicMarkableReference.Pair<T>	of(T reference, boolean mark)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

mark	back to summary
pack-priv final boolean mark

reference	back to summary
pack-priv final T reference

Constructor Detail

Pair	back to summary
private Pair(T reference, boolean mark)

Method Detail

of	back to summary
pack-priv static <T> AtomicMarkableReference.Pair<T> of(T reference, boolean mark)

public Class AtomicMarkableReference<V>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class AtomicMarkableReference.Pair<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail