# Print output for @column tags ?> AtomicLongArray - Android SDK | Android Developers

Most visited

Recently visited

AtomicLongArray

public class AtomicLongArray
extends Object implements Serializable

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


A long 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

AtomicLongArray(int length)

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

AtomicLongArray(long[] array)

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

Public methods

final long accumulateAndGet(int i, long x, LongBinaryOperator 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.

long addAndGet(int i, long delta)

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

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

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

final long decrementAndGet(int i)

Atomically decrements by one the element at index i.

final long get(int i)

Gets the current value at position i.

final long getAndAccumulate(int i, long x, LongBinaryOperator 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 long getAndAdd(int i, long delta)

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

final long getAndDecrement(int i)

Atomically decrements by one the element at index i.

final long getAndIncrement(int i)

Atomically increments by one the element at index i.

final long getAndSet(int i, long newValue)

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

final long getAndUpdate(int i, LongUnaryOperator updateFunction)

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

final long incrementAndGet(int i)

Atomically increments by one the element at index i.

final void lazySet(int i, long 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, long newValue)

Sets the element at position i to the given value.

String toString()

Returns the String representation of the current values of array.

final long updateAndGet(int i, LongUnaryOperator 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, long expect, long update)

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

Inherited methods

Public constructors

AtomicLongArray

public AtomicLongArray (int length)

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

Parameters
length int: the length of the array

AtomicLongArray

public AtomicLongArray (long[] array)

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

Parameters
array long: the array to copy elements from

Throws
NullPointerException if array is null

Public methods

accumulateAndGet

public final long accumulateAndGet (int i, 
                long x, 
                LongBinaryOperator 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 long: the update value

accumulatorFunction LongBinaryOperator: a side-effect-free function of two arguments

Returns
long the updated value

addAndGet

public long addAndGet (int i, 
                long delta)

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

Parameters
i int: the index

delta long: the value to add

Returns
long the updated value

compareAndSet

public final boolean compareAndSet (int i, 
                long expect, 
                long 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 long: the expected value

update long: the new value

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

decrementAndGet

public final long decrementAndGet (int i)

Atomically decrements by one the element at index i.

Parameters
i int: the index

Returns
long the updated value

get

public final long get (int i)

Gets the current value at position i.

Parameters
i int: the index

Returns
long the current value

getAndAccumulate

public final long getAndAccumulate (int i, 
                long x, 
                LongBinaryOperator 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 long: the update value

accumulatorFunction LongBinaryOperator: a side-effect-free function of two arguments

Returns
long the previous value

getAndAdd

public final long getAndAdd (int i, 
                long delta)

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

Parameters
i int: the index

delta long: the value to add

Returns
long the previous value

getAndDecrement

public final long getAndDecrement (int i)

Atomically decrements by one the element at index i.

Parameters
i int: the index

Returns
long the previous value

getAndIncrement

public final long getAndIncrement (int i)

Atomically increments by one the element at index i.

Parameters
i int: the index

Returns
long the previous value

getAndSet

public final long getAndSet (int i, 
                long newValue)

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

Parameters
i int: the index

newValue long: the new value

Returns
long the previous value

getAndUpdate

public final long getAndUpdate (int i, 
                LongUnaryOperator 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 LongUnaryOperator: a side-effect-free function

Returns
long the previous value

incrementAndGet

public final long incrementAndGet (int i)

Atomically increments by one the element at index i.

Parameters
i int: the index

Returns
long the updated value

lazySet

public final void lazySet (int i, 
                long newValue)

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

Parameters
i int: the index

newValue long: the new value

length

public final int length ()

Returns the length of the array.

Returns
int the length of the array

set

public final void set (int i, 
                long newValue)

Sets the element at position i to the given value.

Parameters
i int: the index

newValue long: the new value

toString

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

public final long updateAndGet (int i, 
                LongUnaryOperator 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 LongUnaryOperator: a side-effect-free function

Returns
long the updated value

weakCompareAndSet

public final boolean weakCompareAndSet (int i, 
                long expect, 
                long 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 long: the expected value

update long: the new value

Returns
boolean true if successful