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 AtomicLongArray

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

Most common way to construct:

int N = …;

AtomicLongArray ai = new AtomicLongArray(N);

Based on 164 examples


public class AtomicLongArray
extends Object
implements Serializable

A {@code long} 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
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 .
 boolean
compareAndSet(int i, long expect, long update)

          Atomically sets the value to the given updated value if the current value the expected value.
 long

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

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

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

          Atomically decrements by one the element at index .
 long

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

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

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

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

          Returns the length of the array.
 void
set(int i, long 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, long expect, long update)

          Atomically sets 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, toString, wait, wait, wait
 

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

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.

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

weakCompareAndSet

public final boolean weakCompareAndSet(int i,
                                       long expect,
                                       long update)
Atomically sets the value 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/.