AtomicReferenceFieldUpdater Class

Reference

Definition

Namespace:: Java.Util.Concurrent.Atomic

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A reflection-based utility that enables atomic updates to designated volatile reference fields of designated classes.

[Android.Runtime.Register("java/util/concurrent/atomic/AtomicReferenceFieldUpdater", DoNotGenerateAcw=true)]
[Java.Interop.JavaTypeParameters(new System.String[] { "T", "V" })]
public abstract class AtomicReferenceFieldUpdater : Java.Lang.Object

[<Android.Runtime.Register("java/util/concurrent/atomic/AtomicReferenceFieldUpdater", DoNotGenerateAcw=true)>]
[<Java.Interop.JavaTypeParameters(new System.String[] { "T", "V" })>]
type AtomicReferenceFieldUpdater = class
    inherit Object

Inheritance: Object

Object
AtomicReferenceFieldUpdater

Attributes: RegisterAttribute JavaTypeParametersAttribute

Remarks

A reflection-based utility that enables atomic updates to designated volatile reference fields of designated classes. This class is designed for use in atomic data structures in which several reference fields of the same node are independently subject to atomic updates. For example, a tree node might be declared as

{@code
            class Node {
              private volatile Node left, right;

              private static final AtomicReferenceFieldUpdater<Node, Node> leftUpdater =
                AtomicReferenceFieldUpdater.newUpdater(Node.class, Node.class, "left");
              private static final AtomicReferenceFieldUpdater<Node, Node> rightUpdater =
                AtomicReferenceFieldUpdater.newUpdater(Node.class, Node.class, "right");

              Node getLeft() { return left; }
              boolean compareAndSetLeft(Node expect, Node update) {
                return leftUpdater.compareAndSet(this, expect, update);
              }
              // ... and so on
            }}

Note that the guarantees of the compareAndSet method in this class are weaker than in other atomic classes. Because this class cannot ensure that all uses of the field are appropriate for purposes of atomic access, it can guarantee atomicity only with respect to other invocations of compareAndSet and set on the same updater.

Object arguments for parameters of type T that are not instances of the class passed to #newUpdater will result in a ClassCastException being thrown.

Added in 1.5.

Java documentation for java.util.concurrent.atomic.AtomicReferenceFieldUpdater.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

AtomicReferenceFieldUpdater()	Protected do-nothing constructor for use by subclasses.
AtomicReferenceFieldUpdater(IntPtr, JniHandleOwnership)	A constructor used when creating managed representations of JNI objects; called by the runtime.

Properties

Class	Returns the runtime class of this `Object`. (Inherited from Object)
Handle	The handle to the underlying Android instance. (Inherited from Object)
JniIdentityHashCode	(Inherited from Object)
JniPeerMembers
PeerReference	(Inherited from Object)
ThresholdClass	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.
ThresholdType	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

Methods

AccumulateAndGet(Object, Object, IBinaryOperator)	Atomically updates (with memory effects as specified by `VarHandle#compareAndSet`) the field of the given object managed by this updater with the results of applying the given function to the current and given values, returning the updated value.
Clone()	Creates and returns a copy of this object. (Inherited from Object)
CompareAndSet(Object, Object, Object)	Atomically sets the field of the given object managed by this updater to the given updated value if the current value `==` the expected value.
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
Get(Object)	Returns the current value held in the field of the given object managed by this updater.
GetAndAccumulate(Object, Object, IBinaryOperator)	Atomically updates (with memory effects as specified by `VarHandle#compareAndSet`) the field of the given object managed by this updater with the results of applying the given function to the current and given values, returning the previous value.
GetAndSet(Object, Object)	Atomically sets the field of the given object managed by this updater to the given value and returns the old value.
GetAndUpdate(Object, IUnaryOperator)	Atomically updates (with memory effects as specified by `VarHandle#compareAndSet`) the field of the given object managed by this updater with the results of applying the given function, returning the previous value.
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
JavaFinalize()	Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object)
LazySet(Object, Object)	Eventually sets the field of the given object managed by this updater to the given updated value.
NewUpdater(Class, Class, String)	Creates and returns an updater for objects with the given field.
Notify()	Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object)
NotifyAll()	Wakes up all threads that are waiting on this object's monitor. (Inherited from Object)
Set(Object, Object)	Sets the field of the given object managed by this updater to the given updated value.
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
ToArray<T>()	(Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	(Inherited from Object)
UpdateAndGet(Object, IUnaryOperator)	Atomically updates (with memory effects as specified by `VarHandle#compareAndSet`) the field of the given object managed by this updater with the results of applying the given function, returning the updated value.
Wait()	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object)
Wait(Int64)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
Wait(Int64, Int32)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
WeakCompareAndSet(Object, Object, Object)	Atomically sets the field of the given object managed by this updater to the given updated value if the current value `==` the expected value.

Explicit Interface Implementations

IJavaPeerable.Disposed()	(Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced()	(Inherited from Object)
IJavaPeerable.Finalized()	(Inherited from Object)
IJavaPeerable.JniManagedPeerState	(Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to