English | Site Directory

Android - An Open Handset Alliance Project

java.util.concurrent.atomic.AtomicInteger

java.lang.Object
java.lang.Number Serializable
java.util.concurrent.atomic.AtomicInteger 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.

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()
Answers the double value which the receiver represents
        float  floatValue()
Answers 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()
Answers the int value which the receiver represents
        long  longValue()
Answers 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.
Methods inherited from class java.lang.Number
Methods inherited from class java.lang.Object

Details

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.

Parameters

delta the value to add

Returns

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

Returns

  • the updated value

public double doubleValue()

Answers the double value which the receiver represents

public float floatValue()

Answers the float value which the receiver represents

public final int get()

Get the current value.

Returns

  • the current value

public final int getAndAdd(int delta)

Atomically add the given value to current value.

Parameters

delta the value to add

Returns

  • the previous value

public final int getAndDecrement()

Atomically decrement by one the current value.

Returns

  • the previous value

public final int getAndIncrement()

Atomically increment by one the current value.

Returns

  • the previous value

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

public final int incrementAndGet()

Atomically increment by one the current value.

Returns

  • the updated value

public int intValue()

Answers the int value which the receiver represents

public long longValue()

Answers the long value which the receiver represents

public final void set(int newValue)

Set to the given value.

Parameters

newValue the new value

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

Returns

  • true if successful.
Build m5-rc15i - 10 Jun 2008 13:54