Java BitSet flip() method

The flip() method of Java BitSet class sets the bit set to its complement. For example, if a bit value contains a true value then if you apply flip() operation on it, it will return false.

There are two overloaded flip() method available in BitSet class. These methods are differentiated on the basis of its parameter.

1. Java BitSet flip(int bitIndex) method

The flip(int bitIndex) method sets the bit to its complement at the specified index.

2. Java BitSet flip(int fromIndex, int toIndex) method

The flip(int fromIndex, int toIndex) method set each bit value to its complement from specified inclusive fromIndex to exclusive toIndex.

Syntax:

public void flip(int bitIndex)
public void flip(int fromIndex, int toIndex)

Parameter:

DataType	Parameter	Description
int	bitIndex	It is an index of BitSet which is to be flip.
int	fromIndex	It is an index of BitSet from which the flips of bits start.
int	toIndex	It is an exclusive index of BitSet at which the flips of bits end.

Returns:

Exception:

Method	Exception
flip(int bitIndex)	IndexOutOfBoundsException - if the specified index of bit set is negative.
flip(int fromIndex, int toIndex)	IndexOutOfBoundsException = if any of the fromIndex or toIndex are negative, or fromIndex is larger than toIndex.

Compatibility Version:

Java 1.4 and above

Example of Java BitSet flip(int bitIndex) method

Example 1

import java.util.BitSet;

public class BitSetFlipExample1 {
	public static void main(String[] args) {
		BitSet bitset = new BitSet();
		bitset.set(0);
		bitset.set(1);
		bitset.set(2);
		bitset.set(3);
		System.out.println("bitset: "+bitset);
		System.out.println("bitset value: "+bitset.get(0)+" "+bitset.get(1)+" "+bitset.get(2)+" "+bitset.get(3));
		bitset.flip(1);
		//printing bitset after flip index 1
		System.out.println("bitset after flip index 1: "+bitset);
		System.out.println("bitset value after flip index 1: "+bitset.get(0)+" "+bitset.get(1)+" "+bitset.get(2)+"
 "+bitset.get(3));
	}
}

Output:

bitset: {0, 1, 2, 3}
bitset value: true true true true
bitset after flip index 1: {0, 2, 3}
bitset value after flip index 1: true false true true

Example 2

The flip(int bitIndex) method throw IndexOutOfBoundsException if we provide negative index value.

import java.util.BitSet;

public class BitSetFlipExample2 {
	public static void main(String[] args) {
		BitSet bitset = new BitSet();
		bitset.set(0);
		bitset.set(1);
		bitset.set(2);
		bitset.set(3);
		System.out.println("bitset: "+bitset);
		System.out.println("bitset value: "+bitset.get(0)+" "+bitset.get(1)+" "+bitset.get(2)+" "+bitset.get(3));
		bitset.flip(-1);
		//printing bitset after flip index 1
		System.out.println("bitset after flip index 1: "+bitset);
		System.out.println("bitset value after flip index 1: "+bitset.get(0)+" "+bitset.get(1)+" "+bitset.get(2)+"
 "+bitset.get(3));
	}
}

Output:

Exception in thread "main" java.lang.IndexOutOfBoundsException: bitIndex < 0: -1
	at java.util.BitSet.flip(Unknown Source)
	at BitSetFlipExample2.main(BitSetFlipExample2.java:12)
bitset: {0, 1, 2, 3}
bitset value: true true true true

Example of Java BitSet flip(int fromIndex, int toIndex) method

Example 3

import java.util.BitSet;

public class BitSetFlipExample3 {
	public static void main(String[] args) {
		BitSet bitset = new BitSet();
		bitset.set(0);
		bitset.set(1);
		bitset.set(2);
		bitset.set(3);
		bitset.set(5);
		System.out.println("bitset: "+bitset);
		System.out.println("bitset value: "+bitset.get(0)+" "+bitset.get(1)+" "+bitset.get(2)+" "+bitset.get(3)+"
 "+bitset.get(5));
		bitset.flip(1,3);
		//printing bitset after flip index 1 to 3
		System.out.println("bitset after flip index 1,3: "+bitset);
		System.out.println("bitset value after flip index 1,3: "+bitset.get(0)+" "+bitset.get(1)+" "+bitset.get(2)+" 
"+bitset.get(3)+" "+bitset.get(5));
	}
}

Output:

bitset: {0, 1, 2, 3, 5}
bitset value: true true true true true
bitset after flip index 1,3: {0, 3, 5}
bitset value after flip index 1,3: true false false true true

Example 4

The flip(int fromIndex, int toIndex) method throw IndexOutOfBoundsException if toIndex is greater than fromIndex.

import java.util.BitSet;

public class BitSetFlipExample4 {
	public static void main(String[] args) {
		BitSet bitset = new BitSet();
		bitset.set(0);
		bitset.set(1);
		bitset.set(2);
		bitset.set(3);
		bitset.set(5);
		System.out.println("bitset: "+bitset);
		System.out.println("bitset value: "+bitset.get(0)+" "+bitset.get(1)+" "+bitset.get(2)+" "+bitset.get(3)+" 
"+bitset.get(5));
		bitset.flip(3,1);
		//try to print bitset after flip index 3 to 1 
		System.out.println("bitset after flip index 3,1: "+bitset);
		System.out.println("bitset value after flip index 3,1: "+bitset.get(0)+" "+bitset.get(1)+" "+bitset.get(2)+" 
"+bitset.get(3)+" "+bitset.get(5));
	}
}

Output:

Exception in thread "main" java.lang.IndexOutOfBoundsException: fromIndex: 3 > toIndex: 1
	at java.util.BitSet.checkRange(Unknown Source)
	at java.util.BitSet.flip(Unknown Source)
	at BitSetFlipExample4.main(BitSetFlipExample4.java:13)
bitset: {0, 1, 2, 3, 5}
bitset value: true true true true true

Next TopicJava-bitset-xor-method

← prev next →