added in API level 1

AtomicBoolean

public class AtomicBoolean
extends Object implements Serializable

java.lang.Object
   ↳ java.util.concurrent.atomic.AtomicBoolean


A boolean value that may be updated atomically. See the 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.

Summary

Public constructors

AtomicBoolean(boolean initialValue)

Creates a new AtomicBoolean with the given initial value.

AtomicBoolean()

Creates a new AtomicBoolean with initial value false.

Public methods

final boolean compareAndSet(boolean expect, boolean update)

Atomically sets the value to the given updated value if the current value == the expected value.

final boolean get()

Returns the current value.

final boolean getAndSet(boolean newValue)

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

final void lazySet(boolean newValue)

Eventually sets to the given value.

final void set(boolean newValue)

Unconditionally sets to the given value.

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.

Inherited methods

Public constructors

AtomicBoolean

added in API level 1
AtomicBoolean (boolean initialValue)

Creates a new AtomicBoolean with the given initial value.

Parameters
initialValue boolean: the initial value

AtomicBoolean

added in API level 1
AtomicBoolean ()

Creates a new AtomicBoolean with initial value false.

Public methods

compareAndSet

added in API level 1
boolean compareAndSet (boolean expect, 
                boolean update)

Atomically sets the value to the given updated value if the current value == the expected value.

Parameters
expect boolean: the expected value

update boolean: the new value

Returns
boolean true if successful. False return indicates that the actual value was not equal to the expected value.

get

added in API level 1
boolean get ()

Returns the current value.

Returns
boolean the current value

getAndSet

added in API level 1
boolean getAndSet (boolean newValue)

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

Parameters
newValue boolean: the new value

Returns
boolean the previous value

lazySet

added in API level 9
void lazySet (boolean newValue)

Eventually sets to the given value.

Parameters
newValue boolean: the new value

set

added in API level 1
void set (boolean newValue)

Unconditionally sets to the given value.

Parameters
newValue boolean: the new value

toString

added in API level 1
String toString ()

Returns the String representation of the current value.

Returns
String the String representation of the current value

weakCompareAndSet

added in API level 1
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 and does not provide ordering guarantees, so is only rarely an appropriate alternative to compareAndSet.

Parameters
expect boolean: the expected value

update boolean: the new value

Returns
boolean true if successful