to top
Android APIs
public class

AtomicIntegerArray

extends Object
implements Serializable
java.lang.Object
   ↳ java.util.concurrent.atomic.AtomicIntegerArray

Class Overview

An int array 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
AtomicIntegerArray(int length)
Creates a new AtomicIntegerArray of the given length, with all elements initially zero.
AtomicIntegerArray(int[] array)
Creates a new AtomicIntegerArray with the same length as, and all elements copied from, the given array.
Public Methods
final int addAndGet(int i, int delta)
Atomically adds the given value to the element at index i.
final boolean compareAndSet(int i, int expect, int update)
Atomically sets the element at position i to the given updated value if the current value == the expected value.
final int decrementAndGet(int i)
Atomically decrements by one the element at index i.
final int get(int i)
Gets the current value at position i.
final int getAndAdd(int i, int delta)
Atomically adds the given value to the element at index i.
final int getAndDecrement(int i)
Atomically decrements by one the element at index i.
final int getAndIncrement(int i)
Atomically increments by one the element at index i.
final int getAndSet(int i, int newValue)
Atomically sets the element at position i to the given value and returns the old value.
final int incrementAndGet(int i)
Atomically increments by one the element at index i.
final void lazySet(int i, int 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, int 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, int expect, int 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 AtomicIntegerArray (int length)

Added in API level 1

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

Parameters
length the length of the array

public AtomicIntegerArray (int[] array)

Added in API level 1

Creates a new AtomicIntegerArray 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 int addAndGet (int i, int delta)

Added in API level 1

Atomically adds the given value to the element at index i.

Parameters
i the index
delta the value to add
Returns
  • the updated value

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

Added in 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 int decrementAndGet (int i)

Added in API level 1

Atomically decrements by one the element at index i.

Parameters
i the index
Returns
  • the updated value

public final int get (int i)

Added in API level 1

Gets the current value at position i.

Parameters
i the index
Returns
  • the current value

public final int getAndAdd (int i, int delta)

Added in API level 1

Atomically adds the given value to the element at index i.

Parameters
i the index
delta the value to add
Returns
  • the previous value

public final int getAndDecrement (int i)

Added in API level 1

Atomically decrements by one the element at index i.

Parameters
i the index
Returns
  • the previous value

public final int getAndIncrement (int i)

Added in API level 1

Atomically increments by one the element at index i.

Parameters
i the index
Returns
  • the previous value

public final int getAndSet (int i, int newValue)

Added in 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 int incrementAndGet (int i)

Added in API level 1

Atomically increments by one the element at index i.

Parameters
i the index
Returns
  • the updated value

public final void lazySet (int i, int newValue)

Added in 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 ()

Added in API level 1

Returns the length of the array.

Returns
  • the length of the array

public final void set (int i, int newValue)

Added in API level 1

Sets the element at position i to the given value.

Parameters
i the index
newValue the new value

public String toString ()

Added in 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, int expect, int update)

Added in 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.
No examples for this method.
Frequently called with: [Clear]
Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.