- java.lang.Object
-
- java.util.concurrent.atomic.AtomicBoolean
-
- All Implemented Interfaces:
- Serializable
public class AtomicBoolean extends Object implements Serializable
Aboolean
value that may be updated atomically. See thejava.util.concurrent.atomic
package specification for description of the properties of atomic variables. AnAtomicBoolean
is used in applications such as atomically updated flags, and cannot be used as a replacement for aBoolean
.- Since:
- 1.5
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description AtomicBoolean()
Creates a newAtomicBoolean
with initial valuefalse
.AtomicBoolean(boolean initialValue)
Creates a newAtomicBoolean
with the given initial value.
-
Method Summary
Methods Modifier and Type Method and Description 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.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.
-
-
-
Constructor Detail
-
AtomicBoolean
public AtomicBoolean(boolean initialValue)
Creates a newAtomicBoolean
with the given initial value.- Parameters:
initialValue
- the initial value
-
AtomicBoolean
public AtomicBoolean()
Creates a newAtomicBoolean
with initial valuefalse
.
-
-
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 valueupdate
- 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 and does not provide ordering guarantees, so is only rarely an appropriate alternative to
compareAndSet
.- Parameters:
expect
- the expected valueupdate
- 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
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/util/concurrent/atomic/AtomicBoolean.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.