java.util.concurrent.atomic
Class AtomicInteger

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

All Implemented Interfaces:

Serializable

public class AtomicInteger
extends Number
implements Serializable

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.

Since:

1.5

See Also:

Serialized Form

Constructor Summary

AtomicInteger()
Create a new AtomicInteger with initial value 0.

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

Method Summary

int	addAndGet(int delta) Atomically add the given value to current value.
boolean	compareAndSet(int expect, int update) Atomically set the value to the given updated value if the current value == the expected value.
int	decrementAndGet() Atomically decrement by one the current value.
double	doubleValue() Returns the double value which the receiver represents
float	floatValue() Returns the float value which the receiver represents
int	get() Get the current value.
int	getAndAdd(int delta) Atomically add the given value to current value.
int	getAndDecrement() Atomically decrement by one the current value.
int	getAndIncrement() Atomically increment by one the current value.
int	getAndSet(int newValue) Set to the give value and return the old value.
int	incrementAndGet() Atomically increment by one the current value.
int	intValue() Returns the int value which the receiver represents
long	longValue() Returns the long value which the receiver represents
void	set(int newValue) Set to the given value.
String	toString() Returns the String representation of the current value.
boolean	weakCompareAndSet(int expect, int update) Atomically set the value to the given updated value if the current value == the expected value.

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AtomicInteger

public AtomicInteger(int initialValue)

Create a new AtomicInteger with the given initial value.

Parameters:

initialValue - the initial value

AtomicInteger

public AtomicInteger()

Create a new AtomicInteger with initial value 0.

Method Detail

get

public final int get()

Get the current value.

Returns:

the current value

set

public final void set(int newValue)

Set to the given value.

Parameters:

newValue - the new value

getAndSet

public final int getAndSet(int newValue)

Set to the give value and return the old value.

Parameters:

newValue - the new value

Returns:

the previous value

compareAndSet

public final boolean compareAndSet(int expect,
                                   int update)

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

weakCompareAndSet

public final boolean weakCompareAndSet(int expect,
                                       int update)

Atomically set the value to the given updated value if the current value == the expected value. May fail spuriously.

Parameters:

expect - the expected value

update - the new value

Returns:

true if successful.

getAndIncrement

public final int getAndIncrement()

Atomically increment by one the current value.

Returns:

the previous value

getAndDecrement

public final int getAndDecrement()

Atomically decrement by one the current value.

Returns:

the previous value

getAndAdd

public final int getAndAdd(int delta)

Atomically add the given value to current value.

Parameters:

delta - the value to add

Returns:

the previous value

incrementAndGet

public final int incrementAndGet()

Atomically increment by one the current value.

Returns:

the updated value

decrementAndGet

public final int decrementAndGet()

Atomically decrement by one the current value.

Returns:

the updated value

addAndGet

public final int addAndGet(int delta)

Atomically add the given value to current value.

Parameters:

delta - the value to add

Returns:

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

intValue

public int intValue()

Description copied from class: Number

Returns the int value which the receiver represents

Specified by:

intValue in class Number

Returns:

int the value of the receiver.

longValue

public long longValue()

Description copied from class: Number

Returns the long value which the receiver represents

Specified by:

longValue in class Number

Returns:

long the value of the receiver.

floatValue

public float floatValue()

Description copied from class: Number

Returns the float value which the receiver represents

Specified by:

floatValue in class Number

Returns:

float the value of the receiver.

doubleValue

public double doubleValue()

Description copied from class: Number

Returns the double value which the receiver represents

Specified by:

doubleValue in class Number

Returns:

double the value of the receiver.