AtomicReference (Java Platform SE 7 ) (original) (raw)

• java.lang.Object

• • java.util.concurrent.atomic.AtomicReference

• Type Parameters:
  V - The type of object referred to by this reference
  All Implemented Interfaces:
  Serializable

public class AtomicReference
extends Object
implements Serializable
An object reference that may be updated atomically. See the java.util.concurrent.atomic package specification for description of the properties of atomic variables.
Since:
1.5
See Also:
Serialized Form

• • Constructor Summary

  Constructors

  Constructor and Description
  AtomicReference() Creates a new AtomicReference with null initial value.
  AtomicReference(V initialValue) Creates a new AtomicReference with the given initial value.

  • Method Summary

  Methods

  Modifier and Type	Method and Description
  boolean	compareAndSet(V expect,V update) Atomically sets the value to the given updated value if the current value == the expected value.
  V	get() Gets the current value.
  V	getAndSet(V newValue) Atomically sets to the given value and returns the old value.
  void	lazySet(V newValue) Eventually sets to the given value.
  void	set(V newValue) Sets to the given value.
  String	toString() Returns the String representation of the current value.
  boolean	weakCompareAndSet(V expect,V update) Atomically sets the value to the given updated value if the current value == the expected value.

     * ### Methods inherited from class java.lang.[Object](../../../../java/lang/Object.html "class in java.lang")  
     `[clone](../../../../java/lang/Object.html#clone%28%29), [equals](../../../../java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../../java/lang/Object.html#finalize%28%29), [getClass](../../../../java/lang/Object.html#getClass%28%29), [hashCode](../../../../java/lang/Object.html#hashCode%28%29), [notify](../../../../java/lang/Object.html#notify%28%29), [notifyAll](../../../../java/lang/Object.html#notifyAll%28%29), [wait](../../../../java/lang/Object.html#wait%28%29), [wait](../../../../java/lang/Object.html#wait%28long%29), [wait](../../../../java/lang/Object.html#wait%28long,%20int%29)`

• • Constructor Detail

     * #### AtomicReference  
     public AtomicReference([V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") initialValue)  
     Creates a new AtomicReference with the given initial value.  
     Parameters:  
     `initialValue` \- the initial value  
     * #### AtomicReference  
     public AtomicReference()  
     Creates a new AtomicReference with null initial value.  

  • Method Detail

    * #### get  
    public final [V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") get()  
    Gets the current value.  
    Returns:  
    the current value  
    * #### set  
    public final void set([V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") newValue)  
    Sets to the given value.  
    Parameters:  
    `newValue` \- the new value  
    * #### lazySet  
    public final void lazySet([V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") newValue)  
    Eventually sets to the given value.  
    Parameters:  
    `newValue` \- the new value  
    Since:  
    1.6  
    * #### compareAndSet  
    public final boolean compareAndSet([V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") expect,  
                        [V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") 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([V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") expect,  
                            [V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") update)  
    Atomically sets the value to the given updated value if the current value `==` the expected value.  
    May [fail spuriously](package-summary.html#Spurious) and does not provide ordering guarantees, so is only rarely an appropriate alternative to `compareAndSet`.  
    Parameters:  
    `expect` \- the expected value  
    `update` \- the new value  
    Returns:  
    true if successful.  
    * #### getAndSet  
    public final [V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") getAndSet([V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") newValue)  
    Atomically sets to the given value and returns the old value.  
    Parameters:  
    `newValue` \- the new value  
    Returns:  
    the previous value  
    * #### toString  
    public [String](../../../../java/lang/String.html "class in java.lang") 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.

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.