Added in API level 1

Summary: Ctors | Methods | Inherited Methods

AtomicIntegerArray

public class AtomicIntegerArray
extends Object implements Serializable

java.lang.Object
↳	java.util.concurrent.atomic.AtomicIntegerArray

---

An int array in which elements may be updated atomically. See the VarHandle specification for descriptions of the properties of atomic accesses.

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	accumulateAndGet(int i, int x, IntBinaryOperator accumulatorFunction) Atomically updates (with memory effects as specified by VarHandle.compareAndSet(Object)) the element at index i with the results of applying the given function to the current and given values, returning the updated value.
final int	addAndGet(int i, int delta) Atomically adds the given value to the element at index i, with memory effects as specified by VarHandle.getAndAdd.
final int	compareAndExchange(int i, int expectedValue, int newValue) Atomically sets the element at index i to newValue if the element's current value, referred to as the witness value, == expectedValue, with memory effects as specified by VarHandle.compareAndExchange.
final int	compareAndExchangeAcquire(int i, int expectedValue, int newValue) Atomically sets the element at index i to newValue if the element's current value, referred to as the witness value, == expectedValue, with memory effects as specified by VarHandle.compareAndExchangeAcquire.
final int	compareAndExchangeRelease(int i, int expectedValue, int newValue) Atomically sets the element at index i to newValue if the element's current value, referred to as the witness value, == expectedValue, with memory effects as specified by VarHandle.compareAndExchangeRelease.
final boolean	compareAndSet(int i, int expectedValue, int newValue) Atomically sets the element at index i to newValue if the element's current value == expectedValue, with memory effects as specified by VarHandle.compareAndSet.
final int	decrementAndGet(int i) Atomically decrements the value of the element at index i, with memory effects as specified by VarHandle.getAndAdd.
final int	get(int i) Returns the current value of the element at index i, with memory effects as specified by VarHandle.getVolatile.
final int	getAcquire(int i) Returns the current value of the element at index i, with memory effects as specified by VarHandle.getAcquire.
final int	getAndAccumulate(int i, int x, IntBinaryOperator accumulatorFunction) Atomically updates (with memory effects as specified by VarHandle.compareAndSet(Object)) the element at index i with the results of applying the given function to the current and given values, returning the previous value.
final int	getAndAdd(int i, int delta) Atomically adds the given value to the element at index i, with memory effects as specified by VarHandle.getAndAdd.
final int	getAndDecrement(int i) Atomically decrements the value of the element at index i, with memory effects as specified by VarHandle.getAndAdd.
final int	getAndIncrement(int i) Atomically increments the value of the element at index i, with memory effects as specified by VarHandle.getAndAdd.
final int	getAndSet(int i, int newValue) Atomically sets the element at index i to newValue and returns the old value, with memory effects as specified by VarHandle.getAndSet.
final int	getAndUpdate(int i, IntUnaryOperator updateFunction) Atomically updates (with memory effects as specified by VarHandle.compareAndSet(Object)) the element at index i with the results of applying the given function, returning the previous value.
final int	getOpaque(int i) Returns the current value of the element at index i, with memory effects as specified by VarHandle.getOpaque.
final int	getPlain(int i) Returns the current value of the element at index i, with memory semantics of reading as if the variable was declared non-volatile.
final int	incrementAndGet(int i) Atomically increments the value of the element at index i, with memory effects as specified by VarHandle.getAndAdd.
final void	lazySet(int i, int newValue) Sets the element at index i to newValue, with memory effects as specified by VarHandle.setRelease.
final int	length() Returns the length of the array.
final void	set(int i, int newValue) Sets the element at index i to newValue, with memory effects as specified by VarHandle.setVolatile.
final void	setOpaque(int i, int newValue) Sets the element at index i to newValue, with memory effects as specified by VarHandle.setOpaque.
final void	setPlain(int i, int newValue) Sets the element at index i to newValue, with memory semantics of setting as if the variable was declared non-volatile and non-final.
final void	setRelease(int i, int newValue) Sets the element at index i to newValue, with memory effects as specified by VarHandle.setRelease.
String	toString() Returns the String representation of the current values of array.
final int	updateAndGet(int i, IntUnaryOperator updateFunction) Atomically updates (with memory effects as specified by VarHandle.compareAndSet(Object)) the element at index i with the results of applying the given function, returning the updated value.
final boolean	weakCompareAndSet(int i, int expectedValue, int newValue) This method was deprecated in API level 33. This method has plain memory effects but the method name implies volatile memory effects (see methods such as compareAndExchange(int, int, int) and compareAndSet(int, int, int)). To avoid confusion over plain or volatile memory effects it is recommended that the method weakCompareAndSetPlain(int, int, int) be used instead.
final boolean	weakCompareAndSetAcquire(int i, int expectedValue, int newValue) Possibly atomically sets the element at index i to newValue if the element's current value == expectedValue, with memory effects as specified by VarHandle.weakCompareAndSetAcquire.
final boolean	weakCompareAndSetPlain(int i, int expectedValue, int newValue) Possibly atomically sets the element at index i to newValue if the element's current value == expectedValue, with memory effects as specified by VarHandle.weakCompareAndSetPlain.
final boolean	weakCompareAndSetRelease(int i, int expectedValue, int newValue) Possibly atomically sets the element at index i to newValue if the element's current value == expectedValue, with memory effects as specified by VarHandle.weakCompareAndSetRelease.
final boolean	weakCompareAndSetVolatile(int i, int expectedValue, int newValue) Possibly atomically sets the element at index i to newValue if the element's current value == expectedValue, with memory effects as specified by VarHandle.weakCompareAndSet.

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 timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

AtomicIntegerArray

Added in API level 1

public AtomicIntegerArray (int length)

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

Parameters
length	int: the length of the array

AtomicIntegerArray

Added in API level 1

public AtomicIntegerArray (int[] array)

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

Parameters
array	int: the array to copy elements from

Throws
NullPointerException	if array is null

Public methods

accumulateAndGet

Added in API level 24

public final int accumulateAndGet (int i, 
                int x, 
                IntBinaryOperator accumulatorFunction)

Atomically updates (with memory effects as specified by VarHandle.compareAndSet(Object)) the element at index i 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 of the element at index i as its first argument, and the given update as the second argument.

Parameters
i	int: the index
x	int: the update value
accumulatorFunction	IntBinaryOperator: a side-effect-free function of two arguments

Returns
int	the updated value

addAndGet

Added in API level 1

public final int addAndGet (int i, 
                int delta)

Atomically adds the given value to the element at index i, with memory effects as specified by VarHandle.getAndAdd.

Parameters
i	int: the index
delta	int: the value to add

Returns
int	the updated value

compareAndExchange

Added in API level 33

public final int compareAndExchange (int i, 
                int expectedValue, 
                int newValue)

Atomically sets the element at index i to newValue if the element's current value, referred to as the witness value, == expectedValue, with memory effects as specified by VarHandle.compareAndExchange.

Parameters
i	int: the index
expectedValue	int: the expected value
newValue	int: the new value

Returns
int	the witness value, which will be the same as the expected value if successful

compareAndExchangeAcquire

Added in API level 33

public final int compareAndExchangeAcquire (int i, 
                int expectedValue, 
                int newValue)

Atomically sets the element at index i to newValue if the element's current value, referred to as the witness value, == expectedValue, with memory effects as specified by VarHandle.compareAndExchangeAcquire.

Parameters
i	int: the index
expectedValue	int: the expected value
newValue	int: the new value

Returns
int	the witness value, which will be the same as the expected value if successful

compareAndExchangeRelease

Added in API level 33

public final int compareAndExchangeRelease (int i, 
                int expectedValue, 
                int newValue)

Atomically sets the element at index i to newValue if the element's current value, referred to as the witness value, == expectedValue, with memory effects as specified by VarHandle.compareAndExchangeRelease.

Parameters
i	int: the index
expectedValue	int: the expected value
newValue	int: the new value

Returns
int	the witness value, which will be the same as the expected value if successful

compareAndSet

Added in API level 1

public final boolean compareAndSet (int i, 
                int expectedValue, 
                int newValue)

Atomically sets the element at index i to newValue if the element's current value == expectedValue, with memory effects as specified by VarHandle.compareAndSet.

Parameters
i	int: the index
expectedValue	int: the expected value
newValue	int: the new value

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

decrementAndGet

Added in API level 1

public final int decrementAndGet (int i)

Atomically decrements the value of the element at index i, with memory effects as specified by VarHandle.getAndAdd.

Equivalent to addAndGet(i, -1).

Parameters
i	int: the index

Returns
int	the updated value

get

Added in API level 1

public final int get (int i)

Returns the current value of the element at index i, with memory effects as specified by VarHandle.getVolatile.

Parameters
i	int: the index

Returns
int	the current value

getAcquire

Added in API level 33

public final int getAcquire (int i)

Returns the current value of the element at index i, with memory effects as specified by VarHandle.getAcquire.

Parameters
i	int: the index

Returns
int	the value

getAndAccumulate

Added in API level 24

public final int getAndAccumulate (int i, 
                int x, 
                IntBinaryOperator accumulatorFunction)

Atomically updates (with memory effects as specified by VarHandle.compareAndSet(Object)) the element at index i 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 of the element at index i as its first argument, and the given update as the second argument.

Parameters
i	int: the index
x	int: the update value
accumulatorFunction	IntBinaryOperator: a side-effect-free function of two arguments

Returns
int	the previous value

getAndAdd

Added in API level 1

public final int getAndAdd (int i, 
                int delta)

Atomically adds the given value to the element at index i, with memory effects as specified by VarHandle.getAndAdd.

Parameters
i	int: the index
delta	int: the value to add

Returns
int	the previous value

getAndDecrement

Added in API level 1

public final int getAndDecrement (int i)

Atomically decrements the value of the element at index i, with memory effects as specified by VarHandle.getAndAdd.

Equivalent to getAndAdd(i, -1).

Parameters
i	int: the index

Returns
int	the previous value

getAndIncrement

Added in API level 1

public final int getAndIncrement (int i)

Atomically increments the value of the element at index i, with memory effects as specified by VarHandle.getAndAdd.

Equivalent to getAndAdd(i, 1).

Parameters
i	int: the index

Returns
int	the previous value

getAndSet

Added in API level 1

public final int getAndSet (int i, 
                int newValue)

Atomically sets the element at index i to newValue and returns the old value, with memory effects as specified by VarHandle.getAndSet.

Parameters
i	int: the index
newValue	int: the new value

Returns
int	the previous value

getAndUpdate

Added in API level 24

public final int getAndUpdate (int i, 
                IntUnaryOperator updateFunction)

Atomically updates (with memory effects as specified by VarHandle.compareAndSet(Object)) the element at index i 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
i	int: the index
updateFunction	IntUnaryOperator: a side-effect-free function

Returns
int	the previous value

getOpaque

Added in API level 33

public final int getOpaque (int i)

Returns the current value of the element at index i, with memory effects as specified by VarHandle.getOpaque.

Parameters
i	int: the index

Returns
int	the value

getPlain

Added in API level 33

public final int getPlain (int i)

Returns the current value of the element at index i, with memory semantics of reading as if the variable was declared non-volatile.

Parameters
i	int: the index

Returns
int	the value

incrementAndGet

Added in API level 1

public final int incrementAndGet (int i)

Atomically increments the value of the element at index i, with memory effects as specified by VarHandle.getAndAdd.

Equivalent to addAndGet(i, 1).

Parameters
i	int: the index

Returns
int	the updated value

lazySet

Added in API level 9

public final void lazySet (int i, 
                int newValue)

Sets the element at index i to newValue, with memory effects as specified by VarHandle.setRelease.

Parameters
i	int: the index
newValue	int: the new value

length

Added in API level 1

public final int length ()

Returns the length of the array.

Returns
int	the length of the array

set

Added in API level 1

public final void set (int i, 
                int newValue)

Sets the element at index i to newValue, with memory effects as specified by VarHandle.setVolatile.

Parameters
i	int: the index
newValue	int: the new value

setOpaque

Added in API level 33

public final void setOpaque (int i, 
                int newValue)

Sets the element at index i to newValue, with memory effects as specified by VarHandle.setOpaque.

Parameters
i	int: the index
newValue	int: the new value

setPlain

Added in API level 33

public final void setPlain (int i, 
                int newValue)

Sets the element at index i to newValue, with memory semantics of setting as if the variable was declared non-volatile and non-final.

Parameters
i	int: the index
newValue	int: the new value

setRelease

Added in API level 33

public final void setRelease (int i, 
                int newValue)

Sets the element at index i to newValue, with memory effects as specified by VarHandle.setRelease.

Parameters
i	int: the index
newValue	int: the new value

toString

Added in API level 1

public String toString ()

Returns the String representation of the current values of array.

Returns
String	the String representation of the current values of array

updateAndGet

Added in API level 24

public final int updateAndGet (int i, 
                IntUnaryOperator updateFunction)

Atomically updates (with memory effects as specified by VarHandle.compareAndSet(Object)) the element at index i 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
i	int: the index
updateFunction	IntUnaryOperator: a side-effect-free function

Returns
int	the updated value

weakCompareAndSet

Added in API level 1
Deprecated in API level 33

public final boolean weakCompareAndSet (int i, 
                int expectedValue, 
                int newValue)

This method was deprecated in API level 33.
This method has plain memory effects but the method name implies volatile memory effects (see methods such as compareAndExchange(int, int, int) and compareAndSet(int, int, int)). To avoid confusion over plain or volatile memory effects it is recommended that the method weakCompareAndSetPlain(int, int, int) be used instead.

Possibly atomically sets the element at index i to newValue if the element's current value == expectedValue, with memory effects as specified by VarHandle.weakCompareAndSetPlain.

Parameters
i	int: the index
expectedValue	int: the expected value
newValue	int: the new value

Returns
boolean	true if successful

See also:

• weakCompareAndSetPlain(int, int, int)

weakCompareAndSetAcquire

Added in API level 33

public final boolean weakCompareAndSetAcquire (int i, 
                int expectedValue, 
                int newValue)

Possibly atomically sets the element at index i to newValue if the element's current value == expectedValue, with memory effects as specified by VarHandle.weakCompareAndSetAcquire.

Parameters
i	int: the index
expectedValue	int: the expected value
newValue	int: the new value

Returns
boolean	true if successful

weakCompareAndSetPlain

Added in API level 33

public final boolean weakCompareAndSetPlain (int i, 
                int expectedValue, 
                int newValue)

Possibly atomically sets the element at index i to newValue if the element's current value == expectedValue, with memory effects as specified by VarHandle.weakCompareAndSetPlain.

Parameters
i	int: the index
expectedValue	int: the expected value
newValue	int: the new value

Returns
boolean	true if successful

weakCompareAndSetRelease

Added in API level 33

public final boolean weakCompareAndSetRelease (int i, 
                int expectedValue, 
                int newValue)

Possibly atomically sets the element at index i to newValue if the element's current value == expectedValue, with memory effects as specified by VarHandle.weakCompareAndSetRelease.

Parameters
i	int: the index
expectedValue	int: the expected value
newValue	int: the new value

Returns
boolean	true if successful

weakCompareAndSetVolatile

Added in API level 33

public final boolean weakCompareAndSetVolatile (int i, 
                int expectedValue, 
                int newValue)

Possibly atomically sets the element at index i to newValue if the element's current value == expectedValue, with memory effects as specified by VarHandle.weakCompareAndSet.

Parameters
i	int: the index
expectedValue	int: the expected value
newValue	int: the new value

Returns
boolean	true if successful