Android APIs
public class

AtomicInteger

extends Number
implements Serializable
java.lang.Object
   ↳ java.lang.Number
     ↳ java.util.concurrent.atomic.AtomicInteger

Class Overview

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

Summary

Public Constructors
AtomicInteger(int initialValue)
Creates a new AtomicInteger with the given initial value.
AtomicInteger()
Creates a new AtomicInteger with initial value 0.
Public Methods
final int addAndGet(int delta)
Atomically adds the given value to the current value.
final boolean compareAndSet(int expect, int update)
Atomically sets the value to the given updated value if the current value == the expected value.
final int decrementAndGet()
Atomically decrements by one the current value.
double doubleValue()
Returns the value of this AtomicInteger as a double after a widening primitive conversion.
float floatValue()
Returns the value of this AtomicInteger as a float after a widening primitive conversion.
final int get()
Gets the current value.
final int getAndAdd(int delta)
Atomically adds the given value to the current value.
final int getAndDecrement()
Atomically decrements by one the current value.
final int getAndIncrement()
Atomically increments by one the current value.
final int getAndSet(int newValue)
Atomically sets to the given value and returns the old value.
final int incrementAndGet()
Atomically increments by one the current value.
int intValue()
Returns the value of this AtomicInteger as an int.
final void lazySet(int newValue)
Eventually sets to the given value.
long longValue()
Returns the value of this AtomicInteger as a long after a widening primitive conversion.
final void set(int newValue)
Sets to the given value.
String toString()
Returns the String representation of the current value.
final boolean weakCompareAndSet(int expect, int update)
Atomically sets the value to the given updated value if the current value == the expected value.
[Expand]
Inherited Methods
From class java.lang.Number
From class java.lang.Object

Public Constructors

public AtomicInteger (int initialValue)

Added in API level 1

Creates a new AtomicInteger with the given initial value.

Parameters
initialValue int: the initial value

public AtomicInteger ()

Added in API level 1

Creates a new AtomicInteger with initial value 0.

Public Methods

public final int addAndGet (int delta)

Added in API level 1

Atomically adds the given value to the current value.

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

public final boolean compareAndSet (int expect, int update)

Added in API level 1

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

Parameters
expect int: the expected value
update int: the new value
Returns
boolean true if successful. False return indicates that the actual value was not equal to the expected value.

public final int decrementAndGet ()

Added in API level 1

Atomically decrements by one the current value.

Returns
int the updated value

public double doubleValue ()

Added in API level 1

Returns the value of this AtomicInteger as a double after a widening primitive conversion.

Returns
double the primitive double value of this object.

public float floatValue ()

Added in API level 1

Returns the value of this AtomicInteger as a float after a widening primitive conversion.

Returns
float the primitive float value of this object.

public final int get ()

Added in API level 1

Gets the current value.

Returns
int the current value

public final int getAndAdd (int delta)

Added in API level 1

Atomically adds the given value to the current value.

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

public final int getAndDecrement ()

Added in API level 1

Atomically decrements by one the current value.

Returns
int the previous value

public final int getAndIncrement ()

Added in API level 1

Atomically increments by one the current value.

Returns
int the previous value

public final int getAndSet (int newValue)

Added in API level 1

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

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

public final int incrementAndGet ()

Added in API level 1

Atomically increments by one the current value.

Returns
int the updated value

public int intValue ()

Added in API level 1

Returns the value of this AtomicInteger as an int.

Returns
int the primitive int value of this object.

public final void lazySet (int newValue)

Added in API level 9

Eventually sets to the given value.

Parameters
newValue int: the new value

public long longValue ()

Added in API level 1

Returns the value of this AtomicInteger as a long after a widening primitive conversion.

Returns
long the primitive long value of this object.

public final void set (int newValue)

Added in API level 1

Sets to the given value.

Parameters
newValue int: the new value

public String toString ()

Added in API level 1

Returns the String representation of the current value.

Returns
String the String representation of the current value

public final boolean weakCompareAndSet (int expect, int update)

Added in API level 1

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

May fail spuriously and does not provide ordering guarantees, so is only rarely an appropriate alternative to compareAndSet.

Parameters
expect int: the expected value
update int: the new value
Returns
boolean true if successful