## 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.lucene80` 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` | 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 void` | LiveDocsFormat.`writeLiveDocs(Bits bits, Directory dir, SegmentCommitInfo info, int newDelCount, IOContext context)` Persist live docs bits.

  - ### 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
    --- | ---
    `void` | Lucene50LiveDocsFormat.`writeLiveDocs(Bits bits, Directory dir, SegmentCommitInfo info, int newDelCount, IOContext context)`

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

    Classes in org.apache.lucene.index that implement Bits
    Modifier and Type | Class and Description
    --- | ---
    `class` | `MultiBits` Concatenates multiple Bits together, on every lookup.

    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
    --- | ---
    `Bits` | SegmentReader.`getHardLiveDocs()` Returns the live docs that are not hard-deleted.
    `Bits` | SegmentReader.`getLiveDocs()`
    `Bits` | ParallelLeafReader.`getLiveDocs()`
    `Bits` | FilterCodecReader.`getLiveDocs()`
    `Bits` | SortingCodecReader.`getLiveDocs()`
    `abstract Bits` | LeafReader.`getLiveDocs()` Returns the `Bits` representing live (not deleted) docs.
    `Bits` | FilterLeafReader.`getLiveDocs()`
    `static Bits` | MultiBits.`getLiveDocs(IndexReader reader)` Returns a single `Bits` instance for this reader, merging live Documents on the fly.

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

    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.

    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.
    `int` | Weight.DefaultBulkScorer.`score(LeafCollector collector, Bits acceptDocs, int min, int max)`
    `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` | ConstantScoreQuery.ConstantBulkScorer.`score(LeafCollector collector, Bits acceptDocs, int min, int max)`

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

    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` | FixedBitSet.`asReadOnlyBits()` Convert this instance to read-only `Bits`.
    `Bits` | NotDocIdSet.`bits()`

    Methods in org.apache.lucene.util with parameters of type Bits
    Modifier and Type | Method and Description
    --- | ---
    `static FixedBitSet` | FixedBitSet.`copyOf(Bits bits)` Make a copy of the given bits.

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