edu.emory.mathcs.backport.java.util.concurrent.atomic

Class AtomicLongArray

public class AtomicLongArray extends Object implements Serializable

A {@code long} array in which elements may be updated atomically. See the edu.emory.mathcs.backport.java.util.concurrent.atomic package specification for description of the properties of atomic variables.

Since: 1.5

Author: Doug Lea

Constructor Summary
	AtomicLongArray(int length) Creates a new AtomicLongArray of given length.
	AtomicLongArray(long[] array) Creates a new AtomicLongArray with the same length as, and all elements copied from, the given array.

Method Summary
long	addAndGet(int i, long delta) Atomically adds the given value to the element at index {@code i}.
boolean	compareAndSet(int i, long expect, long update) Atomically sets the value to the given updated value if the current value {@code ==} the expected value.
long	decrementAndGet(int i) Atomically decrements by one the element at index {@code i}.
long	get(int i) Gets the current value at position {@code i}.
long	getAndAdd(int i, long delta) Atomically adds the given value to the element at index {@code i}.
long	getAndDecrement(int i) Atomically decrements by one the element at index {@code i}.
long	getAndIncrement(int i) Atomically increments by one the element at index {@code i}.
long	getAndSet(int i, long newValue) Atomically sets the element at position {@code i} to the given value and returns the old value.
long	incrementAndGet(int i) Atomically increments by one the element at index {@code i}.
void	lazySet(int i, long newValue) Eventually sets the element at position {@code i} to the given value.
int	length() Returns the length of the array.
void	set(int i, long newValue) Sets the element at position {@code i} to the given value.
String	toString() Returns the String representation of the current values of array.
boolean	weakCompareAndSet(int i, long expect, long update) if the current value {@code ==} the expected value.

Constructor Detail

AtomicLongArray

public AtomicLongArray(int length)

Creates a new AtomicLongArray of given length.

Parameters: length 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 the array to copy elements from

Throws: NullPointerException if array is null

Method Detail

addAndGet

public long addAndGet(int i, long delta)

Atomically adds the given value to the element at index {@code i}.

Parameters: i the index delta the value to add

Returns: the updated value

compareAndSet

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

Atomically sets the value to the given updated value if the current value {@code ==} 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.

decrementAndGet

public final long decrementAndGet(int i)

Atomically decrements by one the element at index {@code i}.

Parameters: i the index

Returns: the updated value

get

public final long get(int i)

Gets the current value at position {@code i}.

Parameters: i the index

Returns: the current value

getAndAdd

public final long getAndAdd(int i, long delta)

Atomically adds the given value to the element at index {@code i}.

Parameters: i the index delta the value to add

Returns: the previous value

getAndDecrement

public final long getAndDecrement(int i)

Atomically decrements by one the element at index {@code i}.

Parameters: i the index

Returns: the previous value

getAndIncrement

public final long getAndIncrement(int i)

Atomically increments by one the element at index {@code i}.

Parameters: i the index

Returns: the previous value

getAndSet

public final long getAndSet(int i, long newValue)

Atomically sets the element at position {@code i} to the given value and returns the old value.

Parameters: i the index newValue the new value

Returns: the previous value

incrementAndGet

public final long incrementAndGet(int i)

Atomically increments by one the element at index {@code i}.

Parameters: i the index

Returns: the updated value

lazySet

public final void lazySet(int i, long newValue)

Eventually sets the element at position {@code i} to the given value.

Parameters: i the index newValue the new value

Since: 1.6

length

public final int length()

Returns the length of the array.

Returns: the length of the array

set

public final void set(int i, long newValue)

Sets the element at position {@code i} to the given value.

Parameters: i the index newValue the new value

toString

public String toString()

Returns the String representation of the current values of array.

Returns: the String representation of the current values of array.

weakCompareAndSet

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

if the current value {@code ==} the expected value.

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

Parameters: i the index expect the expected value update the new value

Returns: true if successful.