edu.emory.mathcs.backport.java.util.concurrent.atomic
Class AtomicLong

java.lang.Object
  extended byjava.lang.Number
      extended byedu.emory.mathcs.backport.java.util.concurrent.atomic.AtomicLong
All Implemented Interfaces:
java.io.Serializable

public class AtomicLong
extends java.lang.Number
implements java.io.Serializable

A value that may be updated atomically. See the edu.emory.mathcs.backport.java.util.concurrent.atomic package specification for description of the properties of atomic variables. An is used in applications such as atomically incremented sequence numbers, and cannot be used as a replacement for a Long. However, this class does extend to allow uniform access by tools and utilities that deal with numerically-based classes.

Since:
1.5
Author:
Doug Lea
See Also:
Serialized Form

Constructor Summary
AtomicLong()
          Creates a new AtomicLong with initial value .
AtomicLong(long initialValue)
          Creates a new AtomicLong with the given initial value.
 
Method Summary
 long addAndGet(long delta)
          Atomically adds the given value to the current value.
 boolean compareAndSet(long expect, long update)
          Atomically sets the value to the given updated value if the current value the expected value.
 long decrementAndGet()
          Atomically decrements by one the current value.
 double doubleValue()
           
 float floatValue()
           
 long get()
          Gets the current value.
 long getAndAdd(long delta)
          Atomically adds the given value to the current value.
 long getAndDecrement()
          Atomically decrements by one the current value.
 long getAndIncrement()
          Atomically increments by one the current value.
 long getAndSet(long newValue)
          Atomically sets to the given value and returns the old value.
 long incrementAndGet()
          Atomically increments by one the current value.
 int intValue()
           
 void lazySet(long newValue)
          Eventually sets to the given value.
 long longValue()
           
 void set(long newValue)
          Sets to the given value.
 java.lang.String toString()
          Returns the String representation of the current value.
 boolean weakCompareAndSet(long expect, long update)
          Atomically sets 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

AtomicLong

public AtomicLong(long initialValue)
Creates a new AtomicLong with the given initial value.

Parameters:
initialValue - the initial value

AtomicLong

public AtomicLong()
Creates a new AtomicLong with initial value .

Method Detail

get

public final long get()
Gets the current value.

Returns:
the current value

set

public final void set(long newValue)
Sets to the given value.

Parameters:
newValue - the new value

lazySet

public final void lazySet(long newValue)
Eventually sets to the given value.

Parameters:
newValue - the new value
Since:
1.6

getAndSet

public final long getAndSet(long newValue)
Atomically sets to the given value and returns the old value.

Parameters:
newValue - the new value
Returns:
the previous value

compareAndSet

public final boolean compareAndSet(long expect,
                                   long update)
Atomically sets 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(long expect,
                                       long 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 .

Parameters:
expect - the expected value
update - the new value
Returns:
true if successful.

getAndIncrement

public final long getAndIncrement()
Atomically increments by one the current value.

Returns:
the previous value

getAndDecrement

public final long getAndDecrement()
Atomically decrements by one the current value.

Returns:
the previous value

getAndAdd

public final long getAndAdd(long delta)
Atomically adds the given value to the current value.

Parameters:
delta - the value to add
Returns:
the previous value

incrementAndGet

public final long incrementAndGet()
Atomically increments by one the current value.

Returns:
the updated value

decrementAndGet

public final long decrementAndGet()
Atomically decrements by one the current value.

Returns:
the updated value

addAndGet

public final long addAndGet(long delta)
Atomically adds the given value to the current value.

Parameters:
delta - the value to add
Returns:
the updated value

toString

public java.lang.String toString()
Returns the String representation of the current value.

Returns:
the String representation of the current value.

intValue

public int intValue()

longValue

public long longValue()

floatValue

public float floatValue()

doubleValue

public double doubleValue()