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 AtomicInteger

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

Most common way to construct:

AtomicInteger ai = new AtomicInteger(1);

Based on 337 examples


public class AtomicInteger
extends Number
implements Serializable

An {@code int} value that may be updated atomically. See the {@link java.util.concurrent.atomic} package specification for description of the properties of atomic variables. An {@code AtomicInteger} is used in applications such as atomically incremented counters, and cannot be used as a replacement for an {@link java.lang.Integer}. However, this class does extend {@code Number} to allow uniform access by tools and utilities that deal with numerically-based classes.


Constructor Summary

          Creates a new AtomicInteger with initial value .
AtomicInteger(int initialValue)

          Creates a new AtomicInteger with the given initial value.
 
Method Summary
 int
addAndGet(int delta)

          Atomically adds the given value to the current value.
 boolean
compareAndSet(int expect, int update)

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

          Atomically decrements by one the current value.
 double

          Returns the value of the specified number as a double.
 float

          Returns the value of the specified number as a float.
 int
get()

          Gets the current value.
 int
getAndAdd(int delta)

          Atomically adds the given value to the current value.
 int

          Atomically decrements by one the current value.
 int

          Atomically increments by one the current value.
 int
getAndSet(int newValue)

          Atomically sets to the given value and returns the old value.
 int

          Atomically increments by one the current value.
 int

          Returns the value of the specified number as an int.
 void
lazySet(int newValue)

          Eventually sets to the given value.
 long

          Returns the value of the specified number as a long.
 void
set(int newValue)

          Sets to the given value.
 String

          Returns the String representation of the current value.
 boolean
weakCompareAndSet(int expect, int update)

          Atomically sets the value to the given updated value if the current value the expected value.
 
Methods inherited from class java.lang.Number
byteValue, doubleValue, floatValue, intValue, longValue, shortValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AtomicInteger

public AtomicInteger()
Creates a new AtomicInteger with initial value {@code 0}.


AtomicInteger

public AtomicInteger(int initialValue)
Creates a new AtomicInteger with the given initial value.

Parameters:
initialValue - the initial value
Method Detail

addAndGet

public final int addAndGet(int delta)
Atomically adds the given value to the current value.

Parameters:
delta - the value to add
Returns:
the updated value

compareAndSet

public final boolean compareAndSet(int expect,
                                   int update)
Atomically sets the value to the given updated value if the current value {@code ==} the expected value.

Parameters:
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()
Atomically decrements by one the current value.

Returns:
the updated value

doubleValue

public double doubleValue()
Overrides:
doubleValue in class Number

floatValue

public float floatValue()
Overrides:
floatValue in class Number

get

public final int get()
Gets the current value.

Returns:
the current value

getAndAdd

public final int getAndAdd(int delta)
Atomically adds the given value to the current value.

Parameters:
delta - the value to add
Returns:
the previous value

getAndDecrement

public final int getAndDecrement()
Atomically decrements by one the current value.

Returns:
the previous value

getAndIncrement

public final int getAndIncrement()
Atomically increments by one the current value.

Returns:
the previous value

getAndSet

public final int getAndSet(int newValue)
Atomically sets to the given value and returns the old value.

Parameters:
newValue - the new value
Returns:
the previous value

incrementAndGet

public final int incrementAndGet()
Atomically increments by one the current value.

Returns:
the updated value

intValue

public int intValue()
Overrides:
intValue in class Number

lazySet

public final void lazySet(int newValue)
Eventually sets to the given value.

Parameters:
newValue - the new value

longValue

public long longValue()
Overrides:
longValue in class Number

set

public final void set(int newValue)
Sets to the given value.

Parameters:
newValue - the new value

toString

public String toString()
Returns the String representation of the current value.

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

weakCompareAndSet

public final boolean weakCompareAndSet(int expect,
                                       int 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:
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/.