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.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

java.util.concurrent.atomic
class AtomicReferenceArray

java.lang.Object extended by java.util.concurrent.atomic.AtomicReferenceArray
All Implemented Interfaces:
Serializable
Most common way to construct:

int N = …;

AtomicReferenceArray ai = new AtomicReferenceArray(N);

Based on 68 examples 

public class AtomicReferenceArray
extends Object
implements Serializable

An array of object references 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
AtomicReferenceArray(Object[] array)

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

          Creates a new AtomicReferenceArray of given length.
 
Method Summary
 boolean
compareAndSet(int i, Object expect, Object update)

          Atomically sets the element at position to the given updated value if the current value the expected value.
 Object
get(int i)

          Gets the current value at position .
 Object
getAndSet(int i, Object newValue)

          Atomically sets the element at position to the given value and returns the old value.
 void
lazySet(int i, Object newValue)

          Eventually sets the element at position to the given value.
 int
length()

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

          Sets the element at position to the given value.
 String
toString()

          Returns the String representation of the current values of array.
 boolean
weakCompareAndSet(int i, Object expect, Object 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

AtomicReferenceArray

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

Parameters:
array - the array to copy elements from

AtomicReferenceArray

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

Parameters:
length - the length of the array
Method Detail

compareAndSet

public final boolean compareAndSet(int i,
                                   Object expect,
                                   Object 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.

get

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

Parameters:
i - the index
Returns:
the current value

getAndSet

public final Object getAndSet(int i,
                              Object 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

lazySet

public final void lazySet(int i,
                          Object 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,
                      Object 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,
                                       Object expect,
                                       Object 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.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
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/.