OpenJDK 1.23 · java.util.concurrent.atomic.AtomicBoolean

Modifier and Type	Field and Description
private static final long	serialVersionUID
private static final VarHandle	VALUE
private volatile int	value

Access	Constructor and Description
public	AtomicBoolean(boolean the initial value initialValue) Creates a new `AtomicBoolean` with the given initial value.
public	AtomicBoolean() Creates a new `AtomicBoolean` with initial value `false`.

Method Summary

Modifier and Type	Method and Description
public final boolean	Returns: the witness value, which will be the same as the expected value if successful compareAndExchange(boolean the expected value expectedValue, boolean the new value newValue) Atomically sets the value to `newValue` if the current value, referred to as the witness value, `== expectedValue`, with memory effects as specified by `VarHandle#compareAndExchange`.
public final boolean	Returns: the witness value, which will be the same as the expected value if successful compareAndExchangeAcquire(boolean the expected value expectedValue, boolean the new value newValue) Atomically sets the value to `newValue` if the current value, referred to as the witness value, `== expectedValue`, with memory effects as specified by `VarHandle#compareAndExchangeAcquire`.
public final boolean	Returns: the witness value, which will be the same as the expected value if successful compareAndExchangeRelease(boolean the expected value expectedValue, boolean the new value newValue) Atomically sets the value to `newValue` if the current value, referred to as the witness value, `== expectedValue`, with memory effects as specified by `VarHandle#compareAndExchangeRelease`.
public final boolean	Returns: `true` if successful. False return indicates that the actual value was not equal to the expected value. compareAndSet(boolean the expected value expectedValue, boolean the new value newValue) Atomically sets the value to `newValue` if the current value `== expectedValue`, with memory effects as specified by `VarHandle#compareAndSet`.
public final boolean	Returns: the current value get() Returns the current value, with memory effects as specified by `VarHandle#getVolatile`.
public final boolean	Returns: the value getAcquire() Returns the current value, with memory effects as specified by `VarHandle#getAcquire`.
public final boolean	Returns: the previous value getAndSet(boolean the new value newValue) Atomically sets the value to `newValue` and returns the old value, with memory effects as specified by `VarHandle#getAndSet`.
public final boolean	Returns: the value getOpaque() Returns the current value, with memory effects as specified by `VarHandle#getOpaque`.
public final boolean	Returns: the value getPlain() Returns the current value, with memory semantics of reading as if the variable was declared non-`volatile`.
public final void	lazySet(boolean the new value newValue) Sets the value to `newValue`, with memory effects as specified by `VarHandle#setRelease`.
public final void	set(boolean the new value newValue) Sets the value to `newValue`, with memory effects as specified by `VarHandle#setVolatile`.
public final void	setOpaque(boolean the new value newValue) Sets the value to `newValue`, with memory effects as specified by `VarHandle#setOpaque`.
public final void	setPlain(boolean the new value newValue) Sets the value to `newValue`, with memory semantics of setting as if the variable was declared non-`volatile` and non-`final`.
public final void	setRelease(boolean the new value newValue) Sets the value to `newValue`, with memory effects as specified by `VarHandle#setRelease`.
public String	Returns: the String representation of the current value toString() Overrides java.lang.Object.toString. Returns the String representation of the current value.
public boolean	Returns: `true` if successful weakCompareAndSet(boolean the expected value expectedValue, boolean the new value newValue) Deprecated since 9. This method has plain memory effects but the method name implies volatile memory effects (see methods such as `compareAndExchange` and `compareAndSet`). Possibly atomically sets the value to `newValue` if the current value `== expectedValue`, with memory effects as specified by `VarHandle#weakCompareAndSetPlain`.
public final boolean	Returns: `true` if successful weakCompareAndSetAcquire(boolean the expected value expectedValue, boolean the new value newValue) Possibly atomically sets the value to `newValue` if the current value `== expectedValue`, with memory effects as specified by `VarHandle#weakCompareAndSetAcquire`.
public boolean	Returns: `true` if successful weakCompareAndSetPlain(boolean the expected value expectedValue, boolean the new value newValue) Possibly atomically sets the value to `newValue` if the current value `== expectedValue`, with memory effects as specified by `VarHandle#weakCompareAndSetPlain`.
public final boolean	Returns: `true` if successful weakCompareAndSetRelease(boolean the expected value expectedValue, boolean the new value newValue) Possibly atomically sets the value to `newValue` if the current value `== expectedValue`, with memory effects as specified by `VarHandle#weakCompareAndSetRelease`.
public final boolean	Returns: `true` if successful weakCompareAndSetVolatile(boolean the expected value expectedValue, boolean the new value newValue) Possibly atomically sets the value to `newValue` if the current value `== expectedValue`, with memory effects as specified by `VarHandle#weakCompareAndSet`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

serialVersionUID	back to summary
private static final long serialVersionUID

VALUE	back to summary
private static final VarHandle VALUE

value	back to summary
private volatile int value

AtomicBoolean	back to summary
public AtomicBoolean(boolean initialValue) Creates a new `AtomicBoolean` with the given initial value. Parameters initialValue:boolean the initial value

AtomicBoolean	back to summary
public AtomicBoolean() Creates a new `AtomicBoolean` with initial value `false`.

Method Detail

compareAndExchange back to summary

compareAndExchange	back to summary
public final boolean compareAndExchange(boolean expectedValue, boolean newValue) Atomically sets the value to `newValue` if the current value, referred to as the witness value, `== expectedValue`, with memory effects as specified by `VarHandle#compareAndExchange`. Parameters expectedValue:boolean the expected value newValue:boolean the new value Returns:boolean the witness value, which will be the same as the expected value if successful Since 9

public final boolean compareAndExchange(boolean expectedValue, boolean newValue)

Atomically sets the value to newValue if the current value, referred to as the witness value, == expectedValue, with memory effects as specified by VarHandle#compareAndExchange.

Parameters

expectedValue:boolean: the expected value
newValue:boolean: the new value

Returns:boolean

the witness value, which will be the same as the expected value if successful

Since

compareAndExchangeAcquire back to summary

compareAndExchangeAcquire	back to summary
public final boolean compareAndExchangeAcquire(boolean expectedValue, boolean newValue) Atomically sets the value to `newValue` if the current value, referred to as the witness value, `== expectedValue`, with memory effects as specified by `VarHandle#compareAndExchangeAcquire`. Parameters expectedValue:boolean the expected value newValue:boolean the new value Returns:boolean the witness value, which will be the same as the expected value if successful Since 9

public final boolean compareAndExchangeAcquire(boolean expectedValue, boolean newValue)

Atomically sets the value to newValue if the current value, referred to as the witness value, == expectedValue, with memory effects as specified by VarHandle#compareAndExchangeAcquire.

Parameters

expectedValue:boolean: the expected value
newValue:boolean: the new value

Returns:boolean

the witness value, which will be the same as the expected value if successful

Since

compareAndExchangeRelease back to summary

compareAndExchangeRelease	back to summary
public final boolean compareAndExchangeRelease(boolean expectedValue, boolean newValue) Atomically sets the value to `newValue` if the current value, referred to as the witness value, `== expectedValue`, with memory effects as specified by `VarHandle#compareAndExchangeRelease`. Parameters expectedValue:boolean the expected value newValue:boolean the new value Returns:boolean the witness value, which will be the same as the expected value if successful Since 9

public final boolean compareAndExchangeRelease(boolean expectedValue, boolean newValue)

Atomically sets the value to newValue if the current value, referred to as the witness value, == expectedValue, with memory effects as specified by VarHandle#compareAndExchangeRelease.

Parameters

expectedValue:boolean: the expected value
newValue:boolean: the new value

Returns:boolean

the witness value, which will be the same as the expected value if successful

Since

compareAndSet back to summary

compareAndSet	back to summary
public final boolean compareAndSet(boolean expectedValue, boolean newValue) Atomically sets the value to `newValue` if the current value `== expectedValue`, with memory effects as specified by `VarHandle#compareAndSet`. Parameters expectedValue:boolean the expected value newValue:boolean the new value Returns:boolean `true` if successful. False return indicates that the actual value was not equal to the expected value.

public final boolean compareAndSet(boolean expectedValue, boolean newValue)

Atomically sets the value to newValue if the current value == expectedValue, with memory effects as specified by VarHandle#compareAndSet.

Parameters

expectedValue:boolean: the expected value
newValue:boolean: the new value

Returns:boolean

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

get back to summary

get	back to summary
public final boolean get() Returns the current value, with memory effects as specified by `VarHandle#getVolatile`. Returns:boolean the current value

public final boolean get()

Returns the current value, with memory effects as specified by VarHandle#getVolatile.

Returns:boolean: the current value

getAcquire back to summary

getAcquire	back to summary
public final boolean getAcquire() Returns the current value, with memory effects as specified by `VarHandle#getAcquire`. Returns:boolean the value Since 9

public final boolean getAcquire()

Returns the current value, with memory effects as specified by VarHandle#getAcquire.

Returns:boolean: the value
Since: 9

getAndSet back to summary

getAndSet	back to summary
public final boolean getAndSet(boolean newValue) Atomically sets the value to `newValue` and returns the old value, with memory effects as specified by `VarHandle#getAndSet`. Parameters newValue:boolean the new value Returns:boolean the previous value

public final boolean getAndSet(boolean newValue)

Atomically sets the value to newValue and returns the old value, with memory effects as specified by VarHandle#getAndSet.

Parameters

newValue:boolean: the new value

Returns:boolean

the previous value

getOpaque back to summary

getOpaque	back to summary
public final boolean getOpaque() Returns the current value, with memory effects as specified by `VarHandle#getOpaque`. Returns:boolean the value Since 9

public final boolean getOpaque()

Returns the current value, with memory effects as specified by VarHandle#getOpaque.

Returns:boolean: the value
Since: 9

getPlain back to summary

getPlain	back to summary
public final boolean getPlain() Returns the current value, with memory semantics of reading as if the variable was declared non-`volatile`. Returns:boolean the value Since 9

public final boolean getPlain()

Returns the current value, with memory semantics of reading as if the variable was declared non-volatile.

Returns:boolean: the value
Since: 9

lazySet back to summary

lazySet	back to summary
public final void lazySet(boolean newValue) Sets the value to `newValue`, with memory effects as specified by `VarHandle#setRelease`. Parameters newValue:boolean the new value Since 1.6

public final void lazySet(boolean newValue)

Sets the value to newValue, with memory effects as specified by VarHandle#setRelease.

Parameters

newValue:boolean: the new value

Since

1.6

set back to summary

set	back to summary
public final void set(boolean newValue) Sets the value to `newValue`, with memory effects as specified by `VarHandle#setVolatile`. Parameters newValue:boolean the new value

public final void set(boolean newValue)

Sets the value to newValue, with memory effects as specified by VarHandle#setVolatile.

Parameters

newValue:boolean: the new value

setOpaque back to summary

setOpaque	back to summary
public final void setOpaque(boolean newValue) Sets the value to `newValue`, with memory effects as specified by `VarHandle#setOpaque`. Parameters newValue:boolean the new value Since 9

public final void setOpaque(boolean newValue)

Sets the value to newValue, with memory effects as specified by VarHandle#setOpaque.

Parameters

newValue:boolean: the new value

Since

setPlain back to summary

setPlain	back to summary
public final void setPlain(boolean newValue) Sets the value to `newValue`, with memory semantics of setting as if the variable was declared non-`volatile` and non-`final`. Parameters newValue:boolean the new value Since 9

public final void setPlain(boolean newValue)

Sets the value to newValue, with memory semantics of setting as if the variable was declared non-volatile and non-final.

Parameters

newValue:boolean: the new value

Since

setRelease back to summary

setRelease	back to summary
public final void setRelease(boolean newValue) Sets the value to `newValue`, with memory effects as specified by `VarHandle#setRelease`. Parameters newValue:boolean the new value Since 9

public final void setRelease(boolean newValue)

Sets the value to newValue, with memory effects as specified by VarHandle#setRelease.

Parameters

newValue:boolean: the new value

Since

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns the String representation of the current value. Returns:String the String representation of the current value

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns the String representation of the current value.

Returns:String: the String representation of the current value

weakCompareAndSet back to summary

weakCompareAndSet	back to summary
public boolean weakCompareAndSet(boolean expectedValue, boolean newValue) Deprecated since 9. This method has plain memory effects but the method name implies volatile memory effects (see methods such as `compareAndExchange` and `compareAndSet`). To avoid confusion over plain or volatile memory effects it is recommended that the method `weakCompareAndSetPlain` be used instead. Possibly atomically sets the value to `newValue` if the current value `== expectedValue`, with memory effects as specified by `VarHandle#weakCompareAndSetPlain`. Parameters expectedValue:boolean the expected value newValue:boolean the new value Returns:boolean `true` if successful Annotations @Deprecated since:9 See Also `weakCompareAndSetPlain`

public boolean weakCompareAndSet(boolean expectedValue, boolean newValue)

Deprecated

since 9.

This method has plain memory effects but the method name implies volatile memory effects (see methods such as compareAndExchange and compareAndSet). To avoid confusion over plain or volatile memory effects it is recommended that the method weakCompareAndSetPlain be used instead.

Possibly atomically sets the value to newValue if the current value == expectedValue, with memory effects as specified by VarHandle#weakCompareAndSetPlain.

Parameters

expectedValue:boolean: the expected value
newValue:boolean: the new value

Returns:boolean

true if successful

Annotations

@Deprecated
since:9

See Also

weakCompareAndSetPlain

weakCompareAndSetAcquire back to summary

weakCompareAndSetAcquire	back to summary
public final boolean weakCompareAndSetAcquire(boolean expectedValue, boolean newValue) Possibly atomically sets the value to `newValue` if the current value `== expectedValue`, with memory effects as specified by `VarHandle#weakCompareAndSetAcquire`. Parameters expectedValue:boolean the expected value newValue:boolean the new value Returns:boolean `true` if successful Since 9

public final boolean weakCompareAndSetAcquire(boolean expectedValue, boolean newValue)

Possibly atomically sets the value to newValue if the current value == expectedValue, with memory effects as specified by VarHandle#weakCompareAndSetAcquire.

Parameters

expectedValue:boolean: the expected value
newValue:boolean: the new value

Returns:boolean

true if successful

Since

weakCompareAndSetPlain back to summary

weakCompareAndSetPlain	back to summary
public boolean weakCompareAndSetPlain(boolean expectedValue, boolean newValue) Possibly atomically sets the value to `newValue` if the current value `== expectedValue`, with memory effects as specified by `VarHandle#weakCompareAndSetPlain`. Parameters expectedValue:boolean the expected value newValue:boolean the new value Returns:boolean `true` if successful Since 9

public boolean weakCompareAndSetPlain(boolean expectedValue, boolean newValue)

Possibly atomically sets the value to newValue if the current value == expectedValue, with memory effects as specified by VarHandle#weakCompareAndSetPlain.

Parameters

expectedValue:boolean: the expected value
newValue:boolean: the new value

Returns:boolean

true if successful

Since

weakCompareAndSetRelease back to summary

weakCompareAndSetRelease	back to summary
public final boolean weakCompareAndSetRelease(boolean expectedValue, boolean newValue) Possibly atomically sets the value to `newValue` if the current value `== expectedValue`, with memory effects as specified by `VarHandle#weakCompareAndSetRelease`. Parameters expectedValue:boolean the expected value newValue:boolean the new value Returns:boolean `true` if successful Since 9

public final boolean weakCompareAndSetRelease(boolean expectedValue, boolean newValue)

Possibly atomically sets the value to newValue if the current value == expectedValue, with memory effects as specified by VarHandle#weakCompareAndSetRelease.

Parameters

expectedValue:boolean: the expected value
newValue:boolean: the new value

Returns:boolean

true if successful

Since

weakCompareAndSetVolatile back to summary

weakCompareAndSetVolatile	back to summary
public final boolean weakCompareAndSetVolatile(boolean expectedValue, boolean newValue) Possibly atomically sets the value to `newValue` if the current value `== expectedValue`, with memory effects as specified by `VarHandle#weakCompareAndSet`. Parameters expectedValue:boolean the expected value newValue:boolean the new value Returns:boolean `true` if successful Since 9

public final boolean weakCompareAndSetVolatile(boolean expectedValue, boolean newValue)

Possibly atomically sets the value to newValue if the current value == expectedValue, with memory effects as specified by VarHandle#weakCompareAndSet.

Parameters

expectedValue:boolean: the expected value
newValue:boolean: the new value

Returns:boolean

true if successful

Since

public Class AtomicBoolean

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail