Package com.oracle.coherence.concurrent.atomic

Class LocalAtomicMarkableReference<V>

java.lang.Object

com.oracle.coherence.concurrent.atomic.LocalAtomicMarkableReference<V>

Type Parameters:

V - the type of object referred to by this reference

All Implemented Interfaces:

AtomicMarkableReference<V>

public class LocalAtomicMarkableReference<V>
extends Object
implements AtomicMarkableReference<V>

Local implementation of AtomicMarkableReference interface, that simply wraps java.util.concurrent.atomic.AtomicMarkableReference instance.

Since:

21.12

Author:

Aleks Seovic 2020.12.09

Nested Class Summary

Nested classes/interfaces inherited from interface com.oracle.coherence.concurrent.atomic.AtomicMarkableReference

AtomicMarkableReference.Serializer<V>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LocalAtomicMarkableReference(AtomicMarkableReference<V> value)	Construct LocalAtomicMarkableReference<V> instance.
protected	LocalAtomicMarkableReference(V value, boolean initialMark)	Construct LocalAtomicMarkableReference<V> instance.

Method Summary

Modifier and Type	Method	Description
AsyncLocalAtomicMarkableReference<V>	async()	Return non-blocking API for this atomic reference.
boolean	attemptMark(V expectedReference, boolean fNewMark)	Atomically sets the value of the mark to the given update value if the current reference is equal to the expected reference.
boolean	compareAndSet(V expectedReference, V newReference, boolean fExpectedMark, boolean fNewMark)	Atomically sets the value of both the reference and mark to the given update values if the current reference is equal to the expected reference and the current mark is equal to the expected mark.
V	get(boolean[] abMarkHolder)	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 fNewMark)	Unconditionally sets the value of both the reference and mark.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LocalAtomicMarkableReference

protected LocalAtomicMarkableReference(V value,
                                       boolean initialMark)

Construct LocalAtomicMarkableReference<V> instance.

Parameters:

value - initial value

initialMark - initial mark

LocalAtomicMarkableReference

protected LocalAtomicMarkableReference(AtomicMarkableReference<V> value)

Construct LocalAtomicMarkableReference<V> instance.

Parameters:

value - wrapped value

Method Detail

async

public AsyncLocalAtomicMarkableReference<V> async()

Description copied from interface: AtomicMarkableReference

Return non-blocking API for this atomic reference.

Specified by:

async in interface AtomicMarkableReference<V>

Returns:

non-blocking API for this atomic reference

getReference

public V getReference()

Description copied from interface: AtomicMarkableReference

Returns the current value of the reference.

Specified by:

getReference in interface AtomicMarkableReference<V>

Returns:

the current value of the reference

isMarked

public boolean isMarked()

Description copied from interface: AtomicMarkableReference

Returns the current value of the mark.

Specified by:

isMarked in interface AtomicMarkableReference<V>

Returns:

the current value of the mark

get

public V get(boolean[] abMarkHolder)

Description copied from interface: AtomicMarkableReference

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

Specified by:

get in interface AtomicMarkableReference<V>

Parameters:

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

compareAndSet

public boolean compareAndSet(V expectedReference,
                             V newReference,
                             boolean fExpectedMark,
                             boolean fNewMark)

Description copied from interface: AtomicMarkableReference

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

Specified by:

compareAndSet in interface AtomicMarkableReference<V>

Parameters:

expectedReference - the expected value of the reference

newReference - the new value for the reference

fExpectedMark - the expected value of the mark

fNewMark - the new value for the mark

Returns:

true if successful

set

public void set(V newReference,
                boolean fNewMark)

Description copied from interface: AtomicMarkableReference

Unconditionally sets the value of both the reference and mark.

Specified by:

set in interface AtomicMarkableReference<V>

Parameters:

newReference - the new value for the reference

fNewMark - the new value for the mark

attemptMark

public boolean attemptMark(V expectedReference,
                           boolean fNewMark)

Description copied from interface: AtomicMarkableReference

Atomically sets the value of the mark to the given update value if the current reference is equal 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.

Specified by:

attemptMark in interface AtomicMarkableReference<V>

Parameters:

expectedReference - the expected value of the reference

fNewMark - the new value for the mark

Returns:

true if successful

toString

public String toString()

Overrides:

toString in class Object