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)
Create a new AtomicInteger with the given initial value.
|
|
|
AtomicInteger()
Create a new AtomicInteger with initial value 0.
|
| Public Methods |
|---|
|
final
int
|
addAndGet(int delta)
Atomically add the given value to current value.
|
|
final
boolean
|
compareAndSet(int expect, int update)
Atomically set the value to the given updated value
if the current value == the expected value.
|
|
final
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
|
|
final
int
|
get()
Get the current value.
|
|
final
int
|
getAndAdd(int delta)
Atomically add the given value to current value.
|
|
final
int
|
getAndDecrement()
Atomically decrement by one the current value.
|
|
final
int
|
getAndIncrement()
Atomically increment by one the current value.
|
|
final
int
|
getAndSet(int newValue)
Set to the give value and return the old value.
|
|
final
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
|
|
final
void
|
set(int newValue)
Set to the given value.
|
|
String
|
toString()
Returns the String representation of the current value.
|
|
final
boolean
|
weakCompareAndSet(int expect, int update)
Atomically set 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 the byte value which the receiver represents
|
|
abstract
double
|
doubleValue()
Returns the double value which the receiver represents
|
|
abstract
float
|
floatValue()
Returns the float value which the receiver represents
|
|
abstract
int
|
intValue()
Returns the int value which the receiver represents
|
|
abstract
long
|
longValue()
Returns the long value which the receiver represents
|
|
short
|
shortValue()
Returns the short value which the receiver represents
|
|
From class java.lang.Object
|
Object
|
clone()
Returns a new instance of the same class as the receiver, whose slots
have been filled in with the values in the slots of the receiver.
|
|
boolean
|
equals(Object o)
Compares the argument to the receiver, and returns true if they represent
the same object using a class specific comparison.
|
|
void
|
finalize()
Called by the virtual machine when there are no longer any (non-weak)
references to the receiver.
|
|
final
Class<? extends Object>
|
getClass()
Returns the unique instance of java.lang.Class which represents the class
of the receiver.
|
|
int
|
hashCode()
Returns an integer hash code for the receiver.
|
|
final
void
|
notify()
Causes one thread which is wait ing on the receiver to be
made ready to run.
|
|
final
void
|
notifyAll()
Causes all threads which are wait ing on the receiver to
be made ready to run.
|
|
String
|
toString()
Returns a string containing a concise, human-readable description of the
receiver.
|
|
final
void
|
wait(long time, int frac)
Causes the thread which sent this message to be made not ready to run
either pending some change in the receiver (as indicated by
notify or notifyAll) or the expiration of
the timeout.
|
|
final
void
|
wait(long time)
Causes the thread which sent this message to be made not ready to run
either pending some change in the receiver (as indicated by
notify or notifyAll) or the expiration of
the timeout.
|
|
final
void
|
wait()
Causes the thread which sent this message to be made not ready to run
pending some change in the receiver (as indicated by notify
or notifyAll).
|
|
Public Constructors
public
AtomicInteger
(int initialValue)
Create a new AtomicInteger with the given initial value.
Parameters
| initialValue
| the initial value
|
public
AtomicInteger
()
Create a new AtomicInteger with initial value 0.
Public Methods
public
final
int
addAndGet
(int delta)
Atomically add the given value to current value.
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.
public
final
int
decrementAndGet
()
Atomically decrement by one the current value.
public
double
doubleValue
()
Returns the double value which the receiver represents
Returns
- double the value of the receiver.
public
float
floatValue
()
Returns the float value which the receiver represents
Returns
- float the value of the receiver.
public
final
int
getAndAdd
(int delta)
Atomically add the given value to current value.
public
final
int
getAndDecrement
()
Atomically decrement by one the current value.
public
final
int
getAndIncrement
()
Atomically increment by one the current value.
public
final
int
getAndSet
(int newValue)
Set to the give value and return the old value.
public
final
int
incrementAndGet
()
Atomically increment by one the current value.
public
int
intValue
()
Returns the int value which the receiver represents
Returns
- int the value of the receiver.
public
long
longValue
()
Returns the long value which the receiver represents
Returns
- long the value of the receiver.
public
final
void
set
(int newValue)
public
String
toString
()
Returns the String representation of the current value.
Returns
- the String representation of the current value.
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 |
