The java.util.concurrent.atomic.AtomicBoolean.compareAndSet() is an inbuilt method in java that sets the value to the passed value in the parameter if the current value is equal to the expected value which is also passed in the parameter. The function returns a boolean value which gives us an idea if the update was done or not.
Syntax:
public final boolean compareAndSet(boolean expect, boolean val)
Parameters: The function accepts two mandatory parameters which are described below:
- expect: which specifies the value that the atomic object should be.
- val: which specifies the value to be updated if the atomic Boolean is equal to expect.
Return Value: The function returns a boolean value, it returns true on success else false.
Below programs illustrate the above function:
Program 1:
// Java Program to demonstrates// the compareAndSet() function import java.util.concurrent.atomic.AtomicBoolean; public class GFG { public static void main(String args[]) { // Initially value as false AtomicBoolean val = new AtomicBoolean(false); // Prints the updated value System.out.println("Previous value: " + val); // Checks if previous value was false // and then updates it boolean res = val.compareAndSet(false, true); // Checks if the value was updated. if (res) System.out.println("The value was" + " updated and it is " + val); else System.out.println("The value was " + "not updated"); }} |
Output:
Previous value: false The value was updated and it is true
Program 2:
// Java Program to demonstrates// the compareAndSet() function import java.util.concurrent.atomic.AtomicBoolean; public class GFG { public static void main(String args[]) { // Initially value as true AtomicBoolean val = new AtomicBoolean(true); // Prints the updated value System.out.println("Previous value: " + val); // Checks if previous value was true // and then updates it boolean res = val.compareAndSet(true, false); // Checks if the value was updated. if (res) System.out.println("The value was" + " updated and it is " + val); else System.out.println("The value was " + "not updated"); }} |
Output:
Previous value: true The value was updated and it is false