Added in API level 1

Summary: Ctors | Methods | Inherited Methods

AtomicInteger

public class AtomicInteger
extends Number implements Serializable

java.lang.Object
↳	java.lang.Number
	↳	java.util.concurrent.atomic.AtomicInteger

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`	`accumulateAndGet(int x, IntBinaryOperator accumulatorFunction)` Atomically updates the current value with the results of applying the given function to the current and given values, returning the updated value.
`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`	`getAndAccumulate(int x, IntBinaryOperator accumulatorFunction)` Atomically updates the current value with the results of applying the given function to the current and given values, returning the previous 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`	`getAndUpdate(IntUnaryOperator updateFunction)` Atomically updates the current value with the results of applying the given function, returning the previous 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 int`	`updateAndGet(IntUnaryOperator updateFunction)` Atomically updates the current value with the results of applying the given function, returning the updated value.
`final boolean`	`weakCompareAndSet(int expect, int update)` Atomically sets the value to the given updated value if the current value `==` the expected value.

Inherited methods

From class


        
          java.lang.Number

`byte`	`byteValue()` Returns the value of the specified number as a `byte`, which may involve rounding or truncation.
`abstract double`	`doubleValue()` Returns the value of the specified number as a `double`, which may involve rounding.
`abstract float`	`floatValue()` Returns the value of the specified number as a `float`, which may involve rounding.
`abstract int`	`intValue()` Returns the value of the specified number as an `int`, which may involve rounding or truncation.
`abstract long`	`longValue()` Returns the value of the specified number as a `long`, which may involve rounding or truncation.
`short`	`shortValue()` Returns the value of the specified number as a `short`, which may involve rounding or truncation.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public constructors

AtomicInteger

Added in API level 1

public AtomicInteger (int initialValue)

Creates a new AtomicInteger with the given initial value.

Parameters
`initialValue`	`int`: the initial value

AtomicInteger

Added in API level 1

public AtomicInteger ()

Creates a new AtomicInteger with initial value 0.

Public methods

accumulateAndGet

Added in API level 24

public final int accumulateAndGet (int x, 
                IntBinaryOperator accumulatorFunction)

Atomically updates the current value with the results of applying the given function to the current and given values, returning the updated value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value as its first argument, and the given update as the second argument.

Parameters
`x`	`int`: the update value
`accumulatorFunction`	`IntBinaryOperator`: a side-effect-free function of two arguments

Returns
`int`	the updated value

addAndGet

Added in API level 1

public final int addAndGet (int delta)

Atomically adds the given value to the current value.

Parameters
`delta`	`int`: the value to add

Returns
`int`	the updated value

compareAndSet

Added in API level 1

public final boolean compareAndSet (int expect, 
                int update)

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.

decrementAndGet

Added in API level 1

public final int decrementAndGet ()

Atomically decrements by one the current value.

Returns
`int`	the updated value

doubleValue

Added in API level 1

public double doubleValue ()

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

Returns
`double`	the numeric value represented by this object after conversion to type `double`.

floatValue

Added in API level 1

public float floatValue ()

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

Returns
`float`	the numeric value represented by this object after conversion to type `float`.

get

Added in API level 1

public final int get ()

Gets the current value.

Returns
`int`	the current value

getAndAccumulate

Added in API level 24

public final int getAndAccumulate (int x, 
                IntBinaryOperator accumulatorFunction)

Atomically updates the current value with the results of applying the given function to the current and given values, returning the previous value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value as its first argument, and the given update as the second argument.

Parameters
`x`	`int`: the update value
`accumulatorFunction`	`IntBinaryOperator`: a side-effect-free function of two arguments

Returns
`int`	the previous value

getAndAdd

Added in API level 1

public final int getAndAdd (int delta)

Atomically adds the given value to the current value.

Parameters
`delta`	`int`: the value to add

Returns
`int`	the previous value

getAndDecrement

Added in API level 1

public final int getAndDecrement ()

Atomically decrements by one the current value.

Returns
`int`	the previous value

getAndIncrement

Added in API level 1

public final int getAndIncrement ()

Atomically increments by one the current value.

Returns
`int`	the previous value

getAndSet

Added in API level 1

public final int getAndSet (int newValue)

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

Parameters
`newValue`	`int`: the new value

Returns
`int`	the previous value

getAndUpdate

Added in API level 24

public final int getAndUpdate (IntUnaryOperator updateFunction)

Atomically updates the current value with the results of applying the given function, returning the previous value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.

Parameters
`updateFunction`	`IntUnaryOperator`: a side-effect-free function

Returns
`int`	the previous value

incrementAndGet

Added in API level 1

public final int incrementAndGet ()

Atomically increments by one the current value.

Returns
`int`	the updated value

intValue

Added in API level 1

public int intValue ()

Returns the value of this AtomicInteger as an int. Equivalent to get().

Returns
`int`	the numeric value represented by this object after conversion to type `int`.

lazySet

Added in API level 9

public final void lazySet (int newValue)

Eventually sets to the given value.

Parameters
`newValue`	`int`: the new value

longValue

Added in API level 1

public long longValue ()

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

Returns
`long`	the numeric value represented by this object after conversion to type `long`.

set

Added in API level 1

public final void set (int newValue)

Sets to the given value.

Parameters
`newValue`	`int`: the new value

toString

Added in API level 1

public String toString ()

Returns the String representation of the current value.

Returns
`String`	the String representation of the current value

updateAndGet

Added in API level 24

public final int updateAndGet (IntUnaryOperator updateFunction)

Atomically updates the current value with the results of applying the given function, returning the updated value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.

Parameters
`updateFunction`	`IntUnaryOperator`: a side-effect-free function

Returns
`int`	the updated value

weakCompareAndSet

Added in API level 1

public final boolean weakCompareAndSet (int expect, 
                int update)

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