Package org.apache.commons.lang3.util
Class FluentBitSet
java.lang.Object
org.apache.commons.lang3.util.FluentBitSet
- All Implemented Interfaces:
- Serializable,- Cloneable
A fluent 
BitSet with additional operations.
 
 Originally from Apache Commons VFS with more added to act as a fluent replacement for BitSet.
 
- Since:
- 3.13.0
- See Also:
- 
Constructor SummaryConstructorsConstructorDescriptionCreates a new bit set.FluentBitSet(int nbits) Creates a bit set whose initial size is large enough to explicitly represent bits with indices in the range0throughnbits-1.FluentBitSet(BitSet set) Creates a new instance for the given bit set.
- 
Method SummaryModifier and TypeMethodDescriptionPerforms a logical AND of this target bit set with the argument bit set.and(FluentBitSet set) Performs a logical AND of this target bit set with the argument bit set.andNot(FluentBitSet set) bitSet()Gets the wrapped bit set.intReturns the number of bits set totruein thisBitSet.clear()Sets all of the bits in this BitSet tofalse.clear(int bitIndex) Sets the bit specified by the index tofalse.clear(int... bitIndexArray) Sets the bits specified by the indexes tofalse.clear(int fromIndex, int toIndex) Sets the bits from the specifiedfromIndex(inclusive) to the specifiedtoIndex(exclusive) tofalse.clone()booleanflip(int bitIndex) Sets the bit at the specified index to the complement of its current value.flip(int fromIndex, int toIndex) Sets each bit from the specifiedfromIndex(inclusive) to the specifiedtoIndex(exclusive) to the complement of its current value.booleanget(int bitIndex) Returns the value of the bit with the specified index.get(int fromIndex, int toIndex) inthashCode()booleanintersects(BitSet set) booleanintersects(FluentBitSet set) booleanisEmpty()Returns true if thisBitSetcontains no bits that are set totrue.intlength()intnextClearBit(int fromIndex) Returns the index of the first bit that is set tofalsethat occurs on or after the specified starting index.intnextSetBit(int fromIndex) Returns the index of the first bit that is set totruethat occurs on or after the specified starting index.Performs a logical OR of this bit set with the bit set argument.or(FluentBitSet set) Performs a logical OR of this bit set with the bit set argument.or(FluentBitSet... set) Performs a logical OR of this bit set with the bit set arguments.intpreviousClearBit(int fromIndex) Returns the index of the nearest bit that is set tofalsethat occurs on or before the specified starting index.intpreviousSetBit(int fromIndex) Returns the index of the nearest bit that is set totruethat occurs on or before the specified starting index.set(int bitIndex) Sets the bit at the specified index totrue.set(int... bitIndexArray) Sets the bit at the specified indexes totrue.set(int bitIndex, boolean value) Sets the bit at the specified index to the specified value.set(int fromIndex, int toIndex) Sets the bits from the specifiedfromIndex(inclusive) to the specifiedtoIndex(exclusive) totrue.set(int fromIndex, int toIndex, boolean value) Sets the bits from the specifiedfromIndex(inclusive) to the specifiedtoIndex(exclusive) to the specified value.setInclusive(int fromIndex, int toIndex) Sets the bits from the specifiedfromIndex(inclusive) to the specifiedtoIndex(inclusive) totrue.intsize()Returns the number of bits of space actually in use by thisBitSetto represent bit values.stream()Returns a stream of indices for which thisBitSetcontains a bit in the set state.byte[]Returns a new byte array containing all the bits in this bit set.long[]Returns a new byte array containing all the bits in this bit set.toString()Performs a logical XOR of this bit set with the bit set argument.xor(FluentBitSet set) Performs a logical XOR of this bit set with the bit set argument.
- 
Constructor Details- 
FluentBitSetpublic FluentBitSet()Creates a new bit set. All bits are initiallyfalse.
- 
FluentBitSetCreates a new instance for the given bit set.- Parameters:
- set- The bit set to wrap.
 
- 
FluentBitSetCreates a bit set whose initial size is large enough to explicitly represent bits with indices in the range0throughnbits-1. All bits are initiallyfalse.- Parameters:
- nbits- the initial size of the bit set.
- Throws:
- NegativeArraySizeException- if the specified initial size is negative.
 
 
- 
- 
Method Details- 
andPerforms a logical AND of this target bit set with the argument bit set. This bit set is modified so that each bit in it has the valuetrueif and only if it both initially had the valuetrueand the corresponding bit in the bit set argument also had the valuetrue.- Parameters:
- set- a bit set.
- Returns:
- thisinstance.
 
- 
andPerforms a logical AND of this target bit set with the argument bit set. This bit set is modified so that each bit in it has the valuetrueif and only if it both initially had the valuetrueand the corresponding bit in the bit set argument also had the valuetrue.- Parameters:
- set- a bit set.
- Returns:
- thisinstance.
 
- 
andNot
- 
andNot
- 
bitSetGets the wrapped bit set.- Returns:
- the wrapped bit set.
 
- 
cardinalityReturns the number of bits set totruein thisBitSet.- Returns:
- the number of bits set to truein thisBitSet.
 
- 
clearSets all of the bits in this BitSet tofalse.- Returns:
- thisinstance.
 
- 
clearSets the bits specified by the indexes tofalse.- Parameters:
- bitIndexArray- the index of the bit to be cleared.
- Returns:
- thisinstance.
- Throws:
- IndexOutOfBoundsException- if the specified index is negative.
 
- 
clearSets the bit specified by the index tofalse.- Parameters:
- bitIndex- the index of the bit to be cleared.
- Returns:
- thisinstance.
- Throws:
- IndexOutOfBoundsException- if the specified index is negative.
 
- 
clearSets the bits from the specifiedfromIndex(inclusive) to the specifiedtoIndex(exclusive) tofalse.- Parameters:
- fromIndex- index of the first bit to be cleared.
- toIndex- index after the last bit to be cleared.
- Returns:
- thisinstance.
- Throws:
- IndexOutOfBoundsException- if- fromIndexis negative, or- toIndexis negative, or- fromIndexis larger than- toIndex.
 
- 
clone
- 
equals
- 
flipSets the bit at the specified index to the complement of its current value.- Parameters:
- bitIndex- the index of the bit to flip.
- Returns:
- thisinstance.
- Throws:
- IndexOutOfBoundsException- if the specified index is negative.
 
- 
flipSets each bit from the specifiedfromIndex(inclusive) to the specifiedtoIndex(exclusive) to the complement of its current value.- Parameters:
- fromIndex- index of the first bit to flip.
- toIndex- index after the last bit to flip.
- Returns:
- thisinstance.
- Throws:
- IndexOutOfBoundsException- if- fromIndexis negative, or- toIndexis negative, or- fromIndexis larger than- toIndex.
 
- 
getReturns the value of the bit with the specified index. The value istrueif the bit with the indexbitIndexis currently set in thisBitSet; otherwise, the result isfalse.- Parameters:
- bitIndex- the bit index.
- Returns:
- the value of the bit with the specified index.
- Throws:
- IndexOutOfBoundsException- if the specified index is negative.
 
- 
getReturns a newBitSetcomposed of bits from thisBitSetfromfromIndex(inclusive) totoIndex(exclusive).- Parameters:
- fromIndex- index of the first bit to include.
- toIndex- index after the last bit to include.
- Returns:
- a new BitSetfrom a range of thisBitSet.
- Throws:
- IndexOutOfBoundsException- if- fromIndexis negative, or- toIndexis negative, or- fromIndexis larger than- toIndex.
 
- 
hashCode
- 
intersects
- 
intersects
- 
isEmptyReturns true if thisBitSetcontains no bits that are set totrue.- Returns:
- boolean indicating whether this BitSetis empty.
 
- 
lengthReturns the "logical size" of thisBitSet: the index of the highest set bit in theBitSetplus one. Returns zero if theBitSetcontains no set bits.- Returns:
- the logical size of this BitSet.
 
- 
nextClearBitReturns the index of the first bit that is set tofalsethat occurs on or after the specified starting index.- Parameters:
- fromIndex- the index to start checking from (inclusive).
- Returns:
- the index of the next clear bit.
- Throws:
- IndexOutOfBoundsException- if the specified index is negative.
 
- 
nextSetBitReturns the index of the first bit that is set totruethat occurs on or after the specified starting index. If no such bit exists then-1is returned.To iterate over the truebits in aBitSet, use the following loop:for (int i = bs.nextSetBit(0); i >= 0; i = bs.nextSetBit(i+1)) { // operate on index i here if (i == Integer.MAX_VALUE) { break; // or (i+1) would overflow } }- Parameters:
- fromIndex- the index to start checking from (inclusive).
- Returns:
- the index of the next set bit, or -1if there is no such bit.
- Throws:
- IndexOutOfBoundsException- if the specified index is negative.
 
- 
orPerforms a logical OR of this bit set with the bit set argument. This bit set is modified so that a bit in it has the valuetrueif and only if it either already had the valuetrueor the corresponding bit in the bit set argument has the valuetrue.- Parameters:
- set- a bit set.
- Returns:
- thisinstance.
 
- 
orPerforms a logical OR of this bit set with the bit set arguments. This bit set is modified so that a bit in it has the valuetrueif and only if it either already had the valuetrueor the corresponding bit in the bit set argument has the valuetrue.- Parameters:
- set- a bit set.
- Returns:
- thisinstance.
 
- 
orPerforms a logical OR of this bit set with the bit set argument. This bit set is modified so that a bit in it has the valuetrueif and only if it either already had the valuetrueor the corresponding bit in the bit set argument has the valuetrue.- Parameters:
- set- a bit set.
- Returns:
- thisinstance.
 
- 
previousClearBitReturns the index of the nearest bit that is set tofalsethat occurs on or before the specified starting index. If no such bit exists, or if-1is given as the starting index, then-1is returned.- Parameters:
- fromIndex- the index to start checking from (inclusive).
- Returns:
- the index of the previous clear bit, or -1if there is no such bit.
- Throws:
- IndexOutOfBoundsException- if the specified index is less than- -1.
 
- 
previousSetBitReturns the index of the nearest bit that is set totruethat occurs on or before the specified starting index. If no such bit exists, or if-1is given as the starting index, then-1is returned.To iterate over the truebits in aBitSet, use the following loop:for (int i = bs.length(); (i = bs.previousSetBit(i-1)) >= 0; ) { // operate on index i here }- Parameters:
- fromIndex- the index to start checking from (inclusive)
- Returns:
- the index of the previous set bit, or -1if there is no such bit
- Throws:
- IndexOutOfBoundsException- if the specified index is less than- -1
 
- 
setSets the bit at the specified indexes totrue.- Parameters:
- bitIndexArray- a bit index array.
- Returns:
- thisinstance.
- Throws:
- IndexOutOfBoundsException- if the specified index is negative.
 
- 
setSets the bit at the specified index totrue.- Parameters:
- bitIndex- a bit index
- Returns:
- thisinstance.
- Throws:
- IndexOutOfBoundsException- if the specified index is negative
 
- 
setSets the bit at the specified index to the specified value.- Parameters:
- bitIndex- a bit index.
- value- a boolean value to set.
- Returns:
- thisinstance.
- Throws:
- IndexOutOfBoundsException- if the specified index is negative.
 
- 
setSets the bits from the specifiedfromIndex(inclusive) to the specifiedtoIndex(exclusive) totrue.- Parameters:
- fromIndex- index of the first bit to be set.
- toIndex- index after the last bit to be set.
- Returns:
- thisinstance.
- Throws:
- IndexOutOfBoundsException- if- fromIndexis negative, or- toIndexis negative, or- fromIndexis larger than- toIndex.
 
- 
setSets the bits from the specifiedfromIndex(inclusive) to the specifiedtoIndex(exclusive) to the specified value.- Parameters:
- fromIndex- index of the first bit to be set.
- toIndex- index after the last bit to be set.
- value- value to set the selected bits to.
- Returns:
- thisinstance.
- Throws:
- IndexOutOfBoundsException- if- fromIndexis negative, or- toIndexis negative, or- fromIndexis larger than- toIndex.
 
- 
setInclusiveSets the bits from the specifiedfromIndex(inclusive) to the specifiedtoIndex(inclusive) totrue.- Parameters:
- fromIndex- index of the first bit to be set
- toIndex- index of the last bit to be set
- Returns:
- thisinstance.
- Throws:
- IndexOutOfBoundsException- if- fromIndexis negative, or- toIndexis negative, or- fromIndexis larger than- toIndex
 
- 
sizeReturns the number of bits of space actually in use by thisBitSetto represent bit values. The maximum element in the set is the size - 1st element.- Returns:
- the number of bits currently in this bit set.
 
- 
streamReturns a stream of indices for which thisBitSetcontains a bit in the set state. The indices are returned in order, from lowest to highest. The size of the stream is the number of bits in the set state, equal to the value returned by thecardinality()method.The bit set must remain constant during the execution of the terminal stream operation. Otherwise, the result of the terminal stream operation is undefined. - Returns:
- a stream of integers representing set indices.
- Since:
- 1.8
 
- 
toByteArrayReturns a new byte array containing all the bits in this bit set.More precisely, if: - byte[] bytes = s.toByteArray();
- then bytes.length == (s.length()+7)/8and
- s.get(n) == ((bytes[n/8] & (1<<(n%8))) != 0)
- for all n < 8 * bytes.length.
 - Returns:
- a byte array containing a little-endian representation of all the bits in this bit set
 
- 
toLongArrayReturns a new byte array containing all the bits in this bit set.More precisely, if: - long[] longs = s.toLongArray();
- then longs.length == (s.length()+63)/64and
- s.get(n) == ((longs[n/64] & (1L<<(n%64))) != 0)
- for all n < 64 * longs.length.
 - Returns:
- a byte array containing a little-endian representation of all the bits in this bit set
 
- 
toString
- 
xorPerforms a logical XOR of this bit set with the bit set argument. This bit set is modified so that a bit in it has the valuetrueif and only if one of the following statements holds:- The bit initially has the value true, and the corresponding bit in the argument has the valuefalse.
- The bit initially has the value false, and the corresponding bit in the argument has the valuetrue.
 - Parameters:
- set- a bit set
- Returns:
- thisinstance.
 
- The bit initially has the value 
- 
xorPerforms a logical XOR of this bit set with the bit set argument. This bit set is modified so that a bit in it has the valuetrueif and only if one of the following statements holds:- The bit initially has the value true, and the corresponding bit in the argument has the valuefalse.
- The bit initially has the value false, and the corresponding bit in the argument has the valuetrue.
 - Parameters:
- set- a bit set
- Returns:
- thisinstance.
 
- The bit initially has the value 
 
-