Package com.oracle.coherence.concurrent.atomic

Class AsyncLocalAtomicMarkableReference<V>

java.lang.Object

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

Type Parameters:

V - the type of object referred to by this reference

All Implemented Interfaces:

AsyncAtomicMarkableReference<V>

public class AsyncLocalAtomicMarkableReference<V>
extends Object
implements AsyncAtomicMarkableReference<V>

Local implementation of AsyncAtomicMarkableReference interface, that simply wraps java.util.concurrent.atomic.AtomicMarkableReference instance and returns an already completed future from each method.

Since:

21.12

Author:

Aleks Seovic 2020.12.09

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AsyncLocalAtomicMarkableReference(AtomicMarkableReference<V> value)	Construct AsyncLocalAtomicMarkableReference instance.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<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.
CompletableFuture<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.
CompletableFuture<V>	get(boolean[] abMarkHolder)	Returns the current values of both the reference and the mark.
CompletableFuture<V>	getReference()	Returns the current value of the reference.
CompletableFuture<Boolean>	isMarked()	Returns the current value of the mark.
CompletableFuture<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

AsyncLocalAtomicMarkableReference

protected AsyncLocalAtomicMarkableReference(AtomicMarkableReference<V> value)

Construct AsyncLocalAtomicMarkableReference instance.

Parameters:

value - wrapped value

Method Detail

getReference

public CompletableFuture<V> getReference()

Description copied from interface: AsyncAtomicMarkableReference

Returns the current value of the reference.

Specified by:

getReference in interface AsyncAtomicMarkableReference<V>

Returns:

the current value of the reference

isMarked

public CompletableFuture<Boolean> isMarked()

Description copied from interface: AsyncAtomicMarkableReference

Returns the current value of the mark.

Specified by:

isMarked in interface AsyncAtomicMarkableReference<V>

Returns:

the current value of the mark

get

public CompletableFuture<V> get(boolean[] abMarkHolder)

Description copied from interface: AsyncAtomicMarkableReference

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 AsyncAtomicMarkableReference<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 CompletableFuture<Boolean> compareAndSet(V expectedReference,
                                                V newReference,
                                                boolean fExpectedMark,
                                                boolean fNewMark)

Description copied from interface: AsyncAtomicMarkableReference

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 AsyncAtomicMarkableReference<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 CompletableFuture<Void> set(V newReference,
                                   boolean fNewMark)

Description copied from interface: AsyncAtomicMarkableReference

Unconditionally sets the value of both the reference and mark.

Specified by:

set in interface AsyncAtomicMarkableReference<V>

Parameters:

newReference - the new value for the reference

fNewMark - the new value for the mark

Returns:

a CompletableFuture that can be used to determine whether the operation completed

attemptMark

public CompletableFuture<Boolean> attemptMark(V expectedReference,
                                              boolean fNewMark)

Description copied from interface: AsyncAtomicMarkableReference

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