Most visited

Recently visited

Results for

Added in API level 1

Summary: Ctors | Methods | Inherited Methods | [Expand All]

AtomicReference

public class AtomicReference
extends Object implements Serializable

java.lang.Object
↳	java.util.concurrent.atomic.AtomicReference<V>

An object reference that may be updated atomically. See the java.util.concurrent.atomic package specification for description of the properties of atomic variables.

Summary

Public constructors
`AtomicReference(V initialValue)` Creates a new AtomicReference with the given initial value.
`AtomicReference()` Creates a new AtomicReference with null initial value.

Public methods
`final V`	`accumulateAndGet(V x, BinaryOperator<V> accumulatorFunction)` Atomically updates the current value with the results of applying the given function to the current and given values, returning the updated value.
`final boolean`	`compareAndSet(V expect, V update)` Atomically sets the value to the given updated value if the current value `==` the expected value.
`final V`	`get()` Gets the current value.
`final V`	`getAndAccumulate(V x, BinaryOperator<V> accumulatorFunction)` Atomically updates the current value with the results of applying the given function to the current and given values, returning the previous value.
`final V`	`getAndSet(V newValue)` Atomically sets to the given value and returns the old value.
`final V`	`getAndUpdate(UnaryOperator<V> updateFunction)` Atomically updates the current value with the results of applying the given function, returning the previous value.
`final void`	`lazySet(V newValue)` Eventually sets to the given value.
`final void`	`set(V newValue)` Sets to the given value.
`String`	`toString()` Returns the String representation of the current value.
`final V`	`updateAndGet(UnaryOperator<V> updateFunction)` Atomically updates the current value with the results of applying the given function, returning the updated value.
`final boolean`	`weakCompareAndSet(V expect, V update)` Atomically sets the value to the given updated value if the current value `==` the expected value.

Inherited methods

From class


  
    java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public constructors

AtomicReference

Added in API level 1

AtomicReference (V initialValue)

Creates a new AtomicReference with the given initial value.

Parameters
`initialValue`	`V`: the initial value

AtomicReference

Added in API level 1

AtomicReference ()

Creates a new AtomicReference with null initial value.

Public methods

accumulateAndGet

Added in API level 24

V accumulateAndGet (V x, 
                BinaryOperator<V> accumulatorFunction)

Atomically updates the current value with the results of applying the given function to the current and given values, returning the updated value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value as its first argument, and the given update as the second argument.

Parameters
`x`	`V`: the update value
`accumulatorFunction`	`BinaryOperator`: a side-effect-free function of two arguments

Returns
`V`	the updated value

compareAndSet

Added in API level 1

boolean compareAndSet (V expect, 
                V update)

Atomically sets the value to the given updated value if the current value == the expected value.

Parameters
`expect`	`V`: the expected value
`update`	`V`: the new value

Returns
`boolean`	`true` if successful. False return indicates that the actual value was not equal to the expected value.

get

Added in API level 1

V get ()

Gets the current value.

Returns
`V`	the current value

getAndAccumulate

Added in API level 24

V getAndAccumulate (V x, 
                BinaryOperator<V> accumulatorFunction)

Atomically updates the current value with the results of applying the given function to the current and given values, returning the previous value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value as its first argument, and the given update as the second argument.

Parameters
`x`	`V`: the update value
`accumulatorFunction`	`BinaryOperator`: a side-effect-free function of two arguments

Returns
`V`	the previous value

getAndSet

Added in API level 1

V getAndSet (V newValue)

Atomically sets to the given value and returns the old value.

Parameters
`newValue`	`V`: the new value

Returns
`V`	the previous value

getAndUpdate

Added in API level 24

V getAndUpdate (UnaryOperator<V> updateFunction)

Atomically updates the current value with the results of applying the given function, returning the previous value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.

Parameters
`updateFunction`	`UnaryOperator`: a side-effect-free function

Returns
`V`	the previous value

lazySet

Added in API level 9

void lazySet (V newValue)

Eventually sets to the given value.

Parameters
`newValue`	`V`: the new value

set

Added in API level 1

void set (V newValue)

Sets to the given value.

Parameters
`newValue`	`V`: the new value

toString

Added in API level 1

String toString ()

Returns the String representation of the current value.

Returns
`String`	the String representation of the current value

updateAndGet

Added in API level 24

V updateAndGet (UnaryOperator<V> updateFunction)

Atomically updates the current value with the results of applying the given function, returning the updated value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.

Parameters
`updateFunction`	`UnaryOperator`: a side-effect-free function

Returns
`V`	the updated value

weakCompareAndSet

Added in API level 1

boolean weakCompareAndSet (V expect, 
                V update)

Atomically sets the value to the given updated value if the current value == the expected value.

May fail spuriously and does not provide ordering guarantees, so is only rarely an appropriate alternative to compareAndSet.

Parameters
`expect`	`V`: the expected value
`update`	`V`: the new value

Returns
`boolean`	`true` if successful