Skip to content

Most visited

Recently visited

navigation

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 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 accumulateAndGet(int i, int x, IntBinaryOperator accumulatorFunction)

Atomically updates 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.

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 getAndAccumulate(int i, int x, IntBinaryOperator accumulatorFunction)

Atomically updates 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.

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 getAndUpdate(int i, IntUnaryOperator updateFunction)

Atomically updates the element at index i with the results of applying the given function, returning the previous 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 int updateAndGet(int i, IntUnaryOperator updateFunction)

Atomically updates the element at index i with the results of applying the given function, returning the updated value.

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.

Inherited methods

From class java.lang.Object

Public constructors

AtomicIntegerArray

Added in API level 1
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
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
int accumulateAndGet (int i, 
                int x, 
                IntBinaryOperator accumulatorFunction)

Atomically updates 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 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
int addAndGet (int i, 
                int delta)

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

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

compareAndSet

Added in API level 1
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.

Parameters
i int: the index
expect int: the expected value
update 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
int decrementAndGet (int i)

Atomically decrements by one the element at index i.

Parameters
i int: the index
Returns
int the updated value

get

Added in API level 1
int get (int i)

Gets the current value at position i.

Parameters
i int: the index
Returns
int the current value

getAndAccumulate

Added in API level 24
int getAndAccumulate (int i, 
                int x, 
                IntBinaryOperator accumulatorFunction)

Atomically updates 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 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
int getAndAdd (int i, 
                int delta)

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

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

getAndDecrement

Added in API level 1
int getAndDecrement (int i)

Atomically decrements by one the element at index i.

Parameters
i int: the index
Returns
int the previous value

getAndIncrement

Added in API level 1
int getAndIncrement (int i)

Atomically increments by one the element at index i.

Parameters
i int: the index
Returns
int the previous value

getAndSet

Added in API level 1
int getAndSet (int i, 
                int newValue)

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

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

getAndUpdate

Added in API level 24
int getAndUpdate (int i, 
                IntUnaryOperator updateFunction)

Atomically updates 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

incrementAndGet

Added in API level 1
int incrementAndGet (int i)

Atomically increments by one the element at index i.

Parameters
i int: the index
Returns
int the updated value

lazySet

Added in API level 9
void lazySet (int i, 
                int newValue)

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

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

length

Added in API level 1
int length ()

Returns the length of the array.

Returns
int the length of the array

set

Added in API level 1
void set (int i, 
                int newValue)

Sets the element at position i to the given value.

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

toString

Added in API level 1
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
int updateAndGet (int i, 
                IntUnaryOperator updateFunction)

Atomically updates 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
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.

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

Parameters
i int: the index
expect int: the expected value
update int: the new value
Returns
boolean true if successful
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.