Package org.apache.lucene.util
Interface Bits
- All Known Implementing Classes:
Bits.MatchAllBits,Bits.MatchNoBits,BitSet,FixedBitSet,MultiBits,SparseFixedBitSet
public interface Bits
Interface for Bitset-like structures.
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic classBits impl of the specified length with all bits set.static classBits impl of the specified length with no bits set. -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptiondefault voidapplyMask(FixedBitSet bitSet, int offset) booleanget(int index) Returns the value of the bit with the specifiedindex.intlength()Returns the number of bits in this set
-
Field Details
-
EMPTY_ARRAY
-
-
Method Details
-
get
boolean get(int index) Returns the value of the bit with the specifiedindex.- Parameters:
index- index, should be non-negative and <length(). The result of passing negative or out of bounds values is undefined by this interface, just don't do it!- Returns:
trueif the bit is set,falseotherwise.
-
length
int length()Returns the number of bits in this set -
applyMask
Apply thisBitsinstance to the givenFixedBitSet, which starts at the givenoffset.This should behave the same way as the default implementation, which does the following:
for (int i = bitSet.nextSetBit(0); i != DocIdSetIterator.NO_MORE_DOCS; i = i + 1 >= bitSet.length() ? DocIdSetIterator.NO_MORE_DOCS : bitSet.nextSetBit(i + 1)) { if (get(offset + i) == false) { bitSet.clear(i); } }
-