Java BitSet - previousClearBit() Method

The java.util.BitSet.previousClearBit() method returns the index of the nearest bit that is set to false that occurs on or before the specified starting index. If no such bit exists, or if -1 is given as the starting index, then -1 is returned.

Syntax

public int previousClearBit(int fromIndex)

Parameters

Return Value

Returns the index of the previous clear bit, or -1 if there is no such bit.

Exception

Throws IndexOutOfBoundsException, if the specified index is less than -1.

Example:

In the example below, the java.util.BitSet.previousClearBit() method returns the index of the nearest bit that is set to false and occurs on or before the specified starting index in the given BitSet.

import java.util.*;

public class MyClass {
  public static void main(String[] args) {
    //creating a BitSet
    BitSet BSet = new BitSet();

    //populating BitSet
    BSet.set(1);
    BSet.set(2);
    BSet.set(8);
    BSet.set(9);
    BSet.set(10); 

    //printing BitSet
    System.out.println("BSet contains: " + BSet);

    //finding index of the bit which is set to false
    //which occurs on or before index = 10
    System.out.print("bit which is set to false on or before index 10 is: ");
    System.out.print(BSet.previousClearBit(10));
  }
}

The output of the above code will be:

BSet contains: {1, 2, 8, 9, 10}
bit which is set to false on or before index 10 is: 7