AtomicIntegerArray (Java 2 Platform SE 5.0) (original) (raw)

java.util.concurrent.atomic

Class AtomicIntegerArray

java.lang.Object extended by java.util.concurrent.atomic.AtomicIntegerArray

All Implemented Interfaces:

public class 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.

Since:

1.5

See Also:

Serialized Form

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

Method Summary
int	[addAndGet](../../../../java/util/concurrent/atomic/AtomicIntegerArray.html#addAndGet%28int, int%29)(int i, int delta) Atomically add the given value to element at index i.
boolean	[compareAndSet](../../../../java/util/concurrent/atomic/AtomicIntegerArray.html#compareAndSet%28int, int, int%29)(int i, int expect, int update) Atomically set the value to the given updated value if the current value == the expected value.
int	decrementAndGet(int i) Atomically decrement by one the element at index i.
int	get(int i) Get the current value at position i.
int	[getAndAdd](../../../../java/util/concurrent/atomic/AtomicIntegerArray.html#getAndAdd%28int, int%29)(int i, int delta) Atomically add the given value to element at index i.
int	getAndDecrement(int i) Atomically decrement by one the element at index i.
int	getAndIncrement(int i) Atomically increment by one the element at index i.
int	[getAndSet](../../../../java/util/concurrent/atomic/AtomicIntegerArray.html#getAndSet%28int, int%29)(int i, int newValue) Set the element at position i to the given value and return the old value.
int	incrementAndGet(int i) Atomically increment by one the element at index i.
int	length() Returns the length of the array.
void	[set](../../../../java/util/concurrent/atomic/AtomicIntegerArray.html#set%28int, int%29)(int i, int newValue) Set the element at position i to the given value.
String	toString() Returns the String representation of the current values of array.
boolean	[weakCompareAndSet](../../../../java/util/concurrent/atomic/AtomicIntegerArray.html#weakCompareAndSet%28int, int, int%29)(int i, int expect, int update) Atomically set the value to the given updated value if the current value == the expected value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, [wait](../../../../java/lang/Object.html#wait%28long, int%29)

Constructor Detail

AtomicIntegerArray

public AtomicIntegerArray(int length)

Create a new AtomicIntegerArray of given length.

Parameters:

length - the length of the array

AtomicIntegerArray

public AtomicIntegerArray(int[] array)

Create 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](../../../../java/lang/NullPointerException.html "class in java.lang") - if array is null

Method Detail

length

public final int length()

Returns the length of the array.

Returns:

the length of the array

get

public final int get(int i)

Get the current value at position i.

Parameters:

i - the index

Returns:

the current value

set

public final void set(int i, int newValue)

Set the element at position i to the given value.

Parameters:

i - the index

newValue - the new value

getAndSet

public final int getAndSet(int i, int newValue)

Set the element at position i to the given value and return the old value.

Parameters:

i - the index

newValue - the new value

Returns:

the previous value

compareAndSet

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

Atomically set the value 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.

weakCompareAndSet

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

Atomically set the value to the given updated value if the current value == the expected value. May fail spuriously.

Parameters:

i - the index

expect - the expected value

update - the new value

Returns:

true if successful.

getAndIncrement

public final int getAndIncrement(int i)

Atomically increment by one the element at index i.

Parameters:

i - the index

Returns:

the previous value;

getAndDecrement

public final int getAndDecrement(int i)

Atomically decrement by one the element at index i.

Parameters:

i - the index

Returns:

the previous value;

getAndAdd

public final int getAndAdd(int i, int delta)

Atomically add the given value to element at index i.

Parameters:

i - the index

delta - the value to add

Returns:

the previous value;

incrementAndGet

public final int incrementAndGet(int i)

Atomically increment by one the element at index i.

Parameters:

i - the index

Returns:

the updated value;

decrementAndGet

public final int decrementAndGet(int i)

Atomically decrement by one the element at index i.

Parameters:

i - the index

Returns:

the updated value;

addAndGet

public final int addAndGet(int i, int delta)

Atomically add the given value to element at index i.

Parameters:

i - the index

delta - the value to add

Returns:

the updated value;

toString

public String toString()

Returns the String representation of the current values of array.

Overrides:

[toString](../../../../java/lang/Object.html#toString%28%29) in class [Object](../../../../java/lang/Object.html "class in java.lang")

Returns:

the String representation of the current values of array.

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.