Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)

Classes

Summary: Ctors | Methods | Inherited Methods | [Expand All]

Added in API level 1

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

byte	byteValue () Returns this object's value as a byte.
abstract double	doubleValue () Returns this object's value as a double.
abstract float	floatValue () Returns this object's value as a float.
abstract int	intValue () Returns this object's value as an int.
abstract long	longValue () Returns this object's value as a long.
short	shortValue () Returns this object's value as a short.

From class java.lang.Object

Object	clone () Creates and returns a copy of this `Object` .
boolean	equals ( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize () Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class <?>	getClass () Returns the unique instance of `Class` that represents this object's class.
int	hashCode () Returns an integer hash code for this object.
final void	notify () Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll () Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString () Returns a string containing a concise, human-readable description of this object.
final void	wait () Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait (long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait (long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Constructors

public AtomicInteger (int initialValue)

Added in API level 1

Creates a new AtomicInteger with the given initial value.

Parameters

initialValue	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	the value to add

Returns

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

public final int decrementAndGet ()

Added in API level 1

Atomically decrements by one the current value.

Returns

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

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

the primitive float value of this object.

public final int get ()

Added in API level 1

Gets the current value.

Returns

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	the value to add

Returns

the previous value

public final int getAndDecrement ()

Added in API level 1

Atomically decrements by one the current value.

Returns

the previous value

public final int getAndIncrement ()

Added in API level 1

Atomically increments by one the current value.

Returns

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	the new value

Returns

the previous value

public final int incrementAndGet ()

Added in API level 1

Atomically increments by one the current value.

Returns

the updated value

public int intValue ()

Added in API level 1

Returns the value of this AtomicInteger as an int .

Returns

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

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	the new value

public String toString ()

Added in API level 1

Returns the String representation of the current value.

Returns

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	the expected value
update	the new value

Returns

true if successful

Results

Classes

AtomicInteger

Class Overview

Summary

Public Constructors

public AtomicInteger (int initialValue)

Parameters

public AtomicInteger ()

Public Methods

public final int addAndGet (int delta)

Parameters

Returns

public final boolean compareAndSet (int expect, int update)

Parameters

Returns

public final int decrementAndGet ()

Returns

public double doubleValue ()

Returns

public float floatValue ()

Returns

public final int get ()

Returns

public final int getAndAdd (int delta)

Parameters

Returns

public final int getAndDecrement ()

Returns

public final int getAndIncrement ()

Returns

public final int getAndSet (int newValue)

Parameters

Returns

public final int incrementAndGet ()

Returns

public int intValue ()

Returns

public final void lazySet (int newValue)

Parameters

public long longValue ()

Returns

public final void set (int newValue)

Parameters

public String toString ()

Returns

public final boolean weakCompareAndSet (int expect, int update)

Parameters

Returns