## Uses of Interface
org.apache.lucene.util.Bits

- Packages that use Bits
  Package | Description
  --- | ---
  org.apache.lucene.codecs | Codecs API: API for customization of the encoding and structure of the index.
  org.apache.lucene.codecs.lucene50 | Components from the Lucene 5.0 index format See `org.apache.lucene.codecs.lucene53` for an overview of the index format.
  org.apache.lucene.index | Code to maintain and access indices.
  org.apache.lucene.search | Code to search indices.
  org.apache.lucene.util | Some utility classes.

- - ### Uses of Bits in org.apache.lucene.codecs

    Methods in org.apache.lucene.codecs that return Bits
    Modifier and Type | Method and Description
    --- | ---
    `abstract Bits` | DocValuesProducer.`getDocsWithField(FieldInfo field)` Returns a `Bits` at the size of `reader.maxDoc()`, with turned on bits for each docid that does have a value for this field.
    `abstract Bits` | LiveDocsFormat.`readLiveDocs(Directory dir, SegmentCommitInfo info, IOContext context)` Read live docs bits.

    Methods in org.apache.lucene.codecs with parameters of type Bits
    Modifier and Type | Method and Description
    --- | ---
    `abstract MutableBits` | LiveDocsFormat.`newLiveDocs(Bits existing)` Creates a new mutablebits of the same bits set and size of existing.

    Method parameters in org.apache.lucene.codecs with type arguments of type Bits
    Modifier and Type | Method and Description
    --- | ---
    `void` | DocValuesConsumer.`mergeBinaryField(FieldInfo fieldInfo, MergeState mergeState, List<BinaryDocValues> toMerge, List<Bits> docsWithField)` Merges the binary docvalues from `toMerge`.
    `void` | DocValuesConsumer.`mergeNumericField(FieldInfo fieldInfo, MergeState mergeState, List<NumericDocValues> toMerge, List<Bits> docsWithField)` Merges the numeric docvalues from `toMerge`.

  - ### Uses of Bits in org.apache.lucene.codecs.lucene50

    Methods in org.apache.lucene.codecs.lucene50 that return Bits
    Modifier and Type | Method and Description
    --- | ---
    `Bits` | Lucene50LiveDocsFormat.`readLiveDocs(Directory dir, SegmentCommitInfo info, IOContext context)`

    Methods in org.apache.lucene.codecs.lucene50 with parameters of type Bits
    Modifier and Type | Method and Description
    --- | ---
    `MutableBits` | Lucene50LiveDocsFormat.`newLiveDocs(Bits existing)`

  - ### Uses of Bits in org.apache.lucene.index

    Fields in org.apache.lucene.index declared as Bits
    Modifier and Type | Field and Description
    --- | ---
    `Bits[]` | MergeState.`liveDocs` Live docs for each reader

    Methods in org.apache.lucene.index that return Bits
    Modifier and Type | Method and Description
    --- | ---
    `static Bits` | DocValues.`docsWithValue(SortedDocValues dv, int maxDoc)` Returns a Bits representing all documents from `dv` that have a value.
    `static Bits` | DocValues.`docsWithValue(SortedNumericDocValues dv, int maxDoc)` Returns a Bits representing all documents from `dv` that have a value.
    `static Bits` | DocValues.`docsWithValue(SortedSetDocValues dv, int maxDoc)` Returns a Bits representing all documents from `dv` that have a value.
    `static Bits` | MultiDocValues.`getDocsWithField(IndexReader r, String field)` Returns a Bits for a reader's docsWithField (potentially merging on-the-fly)
    `static Bits` | DocValues.`getDocsWithField(LeafReader reader, String field)` Returns Bits for the field, or `Bits` matching nothing if it has none.
    `Bits` | ParallelLeafReader.`getDocsWithField(String field)`
    `abstract Bits` | LeafReader.`getDocsWithField(String field)` Returns a `Bits` at the size of `reader.maxDoc()`, with turned on bits for each docid that does have a value for this field, or null if no DocValues were indexed for this field.
    `Bits` | CodecReader.`getDocsWithField(String field)`
    `Bits` | FilterLeafReader.`getDocsWithField(String field)`
    `Bits` | ParallelLeafReader.`getLiveDocs()`
    `abstract Bits` | LeafReader.`getLiveDocs()` Returns the `Bits` representing live (not deleted) docs.
    `Bits` | SegmentReader.`getLiveDocs()`
    `Bits` | FilterLeafReader.`getLiveDocs()`
    `Bits` | FilterCodecReader.`getLiveDocs()`
    `static Bits` | MultiFields.`getLiveDocs(IndexReader reader)` Returns a single `Bits` instance for this reader, merging live Documents on the fly.
    `static Bits` | DocValues.`unwrapSingletonBits(SortedNumericDocValues dv)` Returns the documents with a value for the SortedNumericDocValues, if it was previously wrapped with `DocValues.singleton(NumericDocValues, Bits)`, or null.

    Methods in org.apache.lucene.index with parameters of type Bits
    Modifier and Type | Method and Description
    --- | ---
    `static SortedNumericDocValues` | DocValues.`singleton(NumericDocValues dv, Bits docsWithField)` Returns a multi-valued view over the provided NumericDocValues

  - ### Uses of Bits in org.apache.lucene.search

    Fields in org.apache.lucene.search declared as Bits
    Modifier and Type | Field and Description
    --- | ---
    `protected Bits` | DocValuesDocIdSet.`acceptDocs`
    `protected Bits` | FieldComparator.NumericComparator.`docsWithField`

    Methods in org.apache.lucene.search that return Bits
    Modifier and Type | Method and Description
    --- | ---
    `Bits` | DocIdSet.`bits()` Optionally provides a `Bits` interface for random access to matching documents.
    `Bits` | DocValuesDocIdSet.`bits()`
    `protected Bits` | FieldComparator.TermValComparator.`getDocsWithField(LeafReaderContext context, String field)` Retrieves the set of documents that have a value in this segment
    `protected Bits` | FieldComparator.NumericComparator.`getDocsWithValue(LeafReaderContext context, String field)` Retrieves a `Bits` instance representing documents that have a value in this segment.
    `protected abstract Bits` | RandomAccessWeight.`getMatchingDocs(LeafReaderContext context)` Return a `Bits` instance representing documents that match this weight on the given context.

    Methods in org.apache.lucene.search with parameters of type Bits
    Modifier and Type | Method and Description
    --- | ---
    `void` | BulkScorer.`score(LeafCollector collector, Bits acceptDocs)` Scores and collects all matching documents.
    `abstract int` | BulkScorer.`score(LeafCollector collector, Bits acceptDocs, int min, int max)` Collects matching documents in a range and return an estimation of the next matching document which is on or after `max`.
    `int` | Weight.DefaultBulkScorer.`score(LeafCollector collector, Bits acceptDocs, int min, int max)`
    `int` | ConstantScoreQuery.ConstantBulkScorer.`score(LeafCollector collector, Bits acceptDocs, int min, int max)`

    Constructors in org.apache.lucene.search with parameters of type Bits
    Constructor and Description
    `DocValuesDocIdSet(int maxDoc, Bits acceptDocs)`

  - ### Uses of Bits in org.apache.lucene.util

    Subinterfaces of Bits in org.apache.lucene.util
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `MutableBits` Extension of Bits for live documents.

    Classes in org.apache.lucene.util that implement Bits
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `Bits.MatchAllBits` Bits impl of the specified length with all bits set.
    `static class` | `Bits.MatchNoBits` Bits impl of the specified length with no bits set.
    `class` | `BitSet` Base implementation for a bit set.
    `class` | `FixedBitSet` BitSet of fixed length (numBits), backed by accessible (`FixedBitSet.getBits()`) long[], accessed with an int index, implementing `Bits` and `DocIdSet`.
    `class` | `SparseFixedBitSet` A bit set that only stores longs that have at least one bit which is set.

    Fields in org.apache.lucene.util declared as Bits
    Modifier and Type | Field and Description
    --- | ---
    `static Bits[]` | Bits.`EMPTY_ARRAY`

    Methods in org.apache.lucene.util that return Bits
    Modifier and Type | Method and Description
    --- | ---
    `Bits` | NotDocIdSet.`bits()`

Copyright © 2000-2018 Apache Software Foundation. All Rights Reserved.