java.util.concurrent.atomic
class AtomicBoolean

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

All Implemented Interfaces:

Serializable

Most common way to construct:

AtomicBoolean ai = new AtomicBoolean(false);

Based on 280 examples

public class AtomicBoolean
extends Object
implements Serializable

A {@code boolean} value that may be updated atomically. See the {@link java.util.concurrent.atomic} package specification for description of the properties of atomic variables. An {@code AtomicBoolean} is used in applications such as atomically updated flags, and cannot be used as a replacement for a {@link java.lang.Boolean}.

AtomicBoolean

public AtomicBoolean()

Creates a new {@code AtomicBoolean} with initial value {@code false}.

AtomicBoolean

public AtomicBoolean(boolean initialValue)

Creates a new {@code AtomicBoolean} with the given initial value.

Parameters:

initialValue - the initial value

compareAndSet

public final boolean compareAndSet(boolean expect,
                                   boolean update)

Atomically sets the value to the given updated value if the current value {@code ==} 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.

get

public final boolean get()

Returns the current value.

Returns:

the current value

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

lazySet

public final void lazySet(boolean newValue)

Eventually sets to the given value.

Parameters:

newValue - the new value

set

public final void set(boolean newValue)

Unconditionally sets to the given value.

Parameters:

newValue - the new value

toString

public String toString()

Returns the String representation of the current value.

Overrides:

toString in class Object

Returns:

the String representation of the current value.

weakCompareAndSet

public boolean weakCompareAndSet(boolean expect,
                                 boolean update)

Atomically sets the value to the given updated value if the current value {@code ==} the expected value.

May fail spuriously and does not provide ordering guarantees, so is only rarely an appropriate alternative to {@code compareAndSet}.

Parameters:

expect - the expected value

update - the new value

Returns:

true if successful.