This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


java.util.concurrent.atomic
class AtomicIntegerArray

java.lang.Object extended by java.util.concurrent.atomic.AtomicIntegerArray
All Implemented Interfaces:
Serializable

Most common way to construct:

int N = …;

AtomicIntegerArray ai = new AtomicIntegerArray(N);

Based on 126 examples


public class AtomicIntegerArray
extends Object
implements Serializable

An {@code int} array in which elements may be updated atomically. See the {@link java.util.concurrent.atomic} package specification for description of the properties of atomic variables.


Constructor Summary
AtomicIntegerArray(int length)

          Creates a new AtomicIntegerArray of given length.
AtomicIntegerArray(int[] array)

          Creates a new AtomicIntegerArray with the same length as, and all elements copied from, the given array.
 
Method Summary
 int
addAndGet(int i, int delta)

          Atomically adds the given value to the element at index .
 boolean
compareAndSet(int i, int expect, int update)

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

          Atomically decrements by one the element at index .
 int
get(int i)

          Gets the current value at position .
 int
getAndAdd(int i, int delta)

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

          Atomically decrements by one the element at index .
 int

          Atomically increments by one the element at index .
 int
getAndSet(int i, int newValue)

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

          Atomically increments by one the element at index .
 void
lazySet(int i, int newValue)

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

          Returns the length of the array.
 void
set(int i, int newValue)

          Sets the element at position to the given value.
 String

          Returns the String representation of the current values of array.
 boolean
weakCompareAndSet(int i, int expect, int update)

          Atomically sets the element at position 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, toString, wait, wait, wait
 

Constructor Detail

AtomicIntegerArray

public AtomicIntegerArray(int length)
Creates a new AtomicIntegerArray of given length.

Parameters:
length - the length of the array

AtomicIntegerArray

public AtomicIntegerArray(int[] array)
Creates a new AtomicIntegerArray with the same length as, and all elements copied from, the given array.

Parameters:
array - the array to copy elements from
Method Detail

addAndGet

public final int addAndGet(int i,
                           int 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,
                                   int expect,
                                   int update)
Atomically sets the element at position {@code i} 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 int decrementAndGet(int i)
Atomically decrements by one the element at index {@code i}.

Parameters:
i - the index
Returns:
the updated value

get

public final int get(int i)
Gets the current value at position {@code i}.

Parameters:
i - the index
Returns:
the current value

getAndAdd

public final int getAndAdd(int i,
                           int 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 int getAndDecrement(int i)
Atomically decrements by one the element at index {@code i}.

Parameters:
i - the index
Returns:
the previous value

getAndIncrement

public final int getAndIncrement(int i)
Atomically increments by one the element at index {@code i}.

Parameters:
i - the index
Returns:
the previous value

getAndSet

public final int getAndSet(int i,
                           int 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 int 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,
                          int newValue)
Eventually sets the element at position {@code i} to the given value.

Parameters:
i - the index
newValue - the new value

length

public final int length()
Returns the length of the array.

Returns:
the length of the array

set

public final void set(int i,
                      int 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.

Overrides:
toString in class Object
Returns:
the String representation of the current values of array.

weakCompareAndSet

public final boolean weakCompareAndSet(int i,
                                       int expect,
                                       int update)
Atomically sets the element at position {@code i} to the given updated value 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.


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.