AtomicInteger (Java 2 Platform SE 5.0) (original) (raw)

java.util.concurrent.atomic

Class AtomicInteger

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

All Implemented Interfaces:

public class AtomicInteger

An int value that may be updated atomically. See thejava.util.concurrent.atomic package specification for description of the properties of atomic variables. AnAtomicInteger is used in applications such as atomically incremented counters, and cannot be used as a replacement for anInteger. However, this class does extendNumber 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](../../../../java/util/concurrent/atomic/AtomicInteger.html#compareAndSet%28int, int%29)(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 value of the specified number as a double.
float	floatValue() Returns the value of the specified number as a float.
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 value of the specified number as an int.
long	longValue() Returns the value of the specified number as a long.
void	set(int newValue) Set to the given value.
String	toString() Returns the String representation of the current value.
boolean	[weakCompareAndSet](../../../../java/util/concurrent/atomic/AtomicInteger.html#weakCompareAndSet%28int, int%29)(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](../../../../java/lang/Object.html#wait%28long, int%29)

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](../../../../java/lang/Object.html#toString%28%29) in class [Object](../../../../java/lang/Object.html "class in java.lang")

Returns:

the String representation of the current value.

intValue

public int intValue()

Description copied from class: [Number](../../../../java/lang/Number.html#intValue%28%29)

Returns the value of the specified number as an int. This may involve rounding or truncation.

Specified by:

[intValue](../../../../java/lang/Number.html#intValue%28%29) in class [Number](../../../../java/lang/Number.html "class in java.lang")

Returns:

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

longValue

public long longValue()

Description copied from class: [Number](../../../../java/lang/Number.html#longValue%28%29)

Returns the value of the specified number as a long. This may involve rounding or truncation.

Specified by:

[longValue](../../../../java/lang/Number.html#longValue%28%29) in class [Number](../../../../java/lang/Number.html "class in java.lang")

Returns:

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

floatValue

public float floatValue()

Description copied from class: [Number](../../../../java/lang/Number.html#floatValue%28%29)

Returns the value of the specified number as a float. This may involve rounding.

Specified by:

[floatValue](../../../../java/lang/Number.html#floatValue%28%29) in class [Number](../../../../java/lang/Number.html "class in java.lang")

Returns:

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

doubleValue

public double doubleValue()

Description copied from class: [Number](../../../../java/lang/Number.html#doubleValue%28%29)

Returns the value of the specified number as a double. This may involve rounding.

Specified by:

[doubleValue](../../../../java/lang/Number.html#doubleValue%28%29) in class [Number](../../../../java/lang/Number.html "class in java.lang")

Returns:

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

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.