public class

AtomicReferenceArray

extends Object
implements Serializable
java.lang.Object
   ↳ java.util.concurrent.atomic.AtomicReferenceArray<E>

Class Overview

An array of object references in which elements may be updated atomically. See the java.util.concurrent.atomic package specification for description of the properties of atomic variables.

Summary

Public Constructors
AtomicReferenceArray(int length)
Creates a new AtomicReferenceArray of the given length, with all elements initially zero.
AtomicReferenceArray(E[] array)
Creates a new AtomicReferenceArray with the same length as, and all elements copied from, the given array.
Public Methods
final boolean compareAndSet(int i, E expect, E update)
Atomically sets the element at position i to the given updated value if the current value == the expected value.
final E get(int i)
Gets the current value at position i.
final E getAndSet(int i, E newValue)
Atomically sets the element at position i to the given value and returns the old value.
final void lazySet(int i, E newValue)
Eventually sets the element at position i to the given value.
final int length()
Returns the length of the array.
final void set(int i, E newValue)
Sets the element at position i to the given value.
String toString()
Returns the String representation of the current values of array.
final boolean weakCompareAndSet(int i, E expect, E update)
Atomically sets the element at position i to the given updated value if the current value == the expected value.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public AtomicReferenceArray (int length)

Since: API Level 1

Creates a new AtomicReferenceArray of the given length, with all elements initially zero.

Parameters
length the length of the array

public AtomicReferenceArray (E[] array)

Since: API Level 1

Creates a new AtomicReferenceArray with the same length as, and all elements copied from, the given array.

Parameters
array the array to copy elements from
Throws
NullPointerException if array is null

Public Methods

public final boolean compareAndSet (int i, E expect, E update)

Since: API Level 1

Atomically sets the element at position i to the given updated value if the current value == the expected value.

Parameters
i the index
expect the expected value
update the new value
Returns
  • true if successful. False return indicates that the actual value was not equal to the expected value.

public final E get (int i)

Since: API Level 1

Gets the current value at position i.

Parameters
i the index
Returns
  • the current value

public final E getAndSet (int i, E newValue)

Since: API Level 1

Atomically sets the element at position i to the given value and returns the old value.

Parameters
i the index
newValue the new value
Returns
  • the previous value

public final void lazySet (int i, E newValue)

Since: API Level 9

Eventually sets the element at position i to the given value.

Parameters
i the index
newValue the new value

public final int length ()

Since: API Level 1

Returns the length of the array.

Returns
  • the length of the array

public final void set (int i, E newValue)

Since: API Level 1

Sets the element at position i to the given value.

Parameters
i the index
newValue the new value

public String toString ()

Since: API Level 1

Returns the String representation of the current values of array.

Returns
  • the String representation of the current values of array

public final boolean weakCompareAndSet (int i, E expect, E update)

Since: API Level 1

Atomically sets the element at position i 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
i the index
expect the expected value
update the new value
Returns
  • true if successful.