Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## edu.emory.mathcs.backport.java.util.concurrent.atomic
Class AtomicBoolean

    java.lang.Object
      edu.emory.mathcs.backport.java.util.concurrent.atomic.AtomicBoolean

All Implemented Interfaces:
  java.io.Serializable

public class AtomicBoolean
extends java.lang.Object
implements java.io.Serializable

A `boolean` 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 `AtomicBoolean` is used in applications such as atomically updated flags, and cannot be used as a replacement for a `Boolean`.

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

Constructor Summary
`AtomicBoolean()` Creates a new `AtomicBoolean` with initial value `false`.
`AtomicBoolean(boolean initialValue)` Creates a new `AtomicBoolean` with the given initial value.

Method Summary
`boolean` | `compareAndSet(boolean expect, boolean update)` Atomically sets the value to the given updated value if the current value `==` the expected value.
`boolean` | `get()` Returns the current value.
`boolean` | `getAndSet(boolean newValue)` Atomically sets to the given value and returns the previous value.
`void` | `lazySet(boolean newValue)` Eventually sets to the given value.
`void` | `set(boolean newValue)` Unconditionally sets to the given value.
`java.lang.String` | `toString()` Returns the String representation of the current value.
`boolean` | `weakCompareAndSet(boolean expect, boolean update)` Atomically sets the value to the given updated value if the current value `==` the expected value.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### AtomicBoolean

    public AtomicBoolean(boolean initialValue)

  Creates a new `AtomicBoolean` with the given initial value.

Parameters:
  `initialValue` - the initial value

### AtomicBoolean

    public AtomicBoolean()

  Creates a new `AtomicBoolean` with initial value `false`.

Method Detail

### get

    public final boolean get()

  Returns the current value.

  Returns:
    the current value

### compareAndSet

    public final boolean compareAndSet(boolean expect,
                                       boolean 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 boolean weakCompareAndSet(boolean expect,
                                     boolean update)

  Atomically sets 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.

### set

    public final void set(boolean newValue)

  Unconditionally sets to the given value.

  Parameters:
    `newValue` - the new value

### lazySet

    public final void lazySet(boolean newValue)

  Eventually sets to the given value.

  Parameters:
    `newValue` - the new value
  Since:
    1.6

### getAndSet

    public final boolean getAndSet(boolean newValue)

  Atomically sets to the given value and returns the previous value.

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

### toString

    public java.lang.String toString()

  Returns the String representation of the current value.

  Returns:
    the String representation of the current value.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD