## Uses of Class
org.apache.lucene.index.BinaryDocValues

- Packages that use BinaryDocValues
  Package | Description
  --- | ---
  org.apache.lucene.codecs | Codecs API: API for customization of the encoding and structure of the index.
  org.apache.lucene.index | Code to maintain and access indices.
  org.apache.lucene.search | Code to search indices.

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

    Methods in org.apache.lucene.codecs that return BinaryDocValues
    Modifier and Type | Method and Description
    --- | ---
    `abstract BinaryDocValues` | DocValuesProducer.`getBinary(FieldInfo field)` Returns `BinaryDocValues` for this field.

    Method parameters in org.apache.lucene.codecs with type arguments of type BinaryDocValues
    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`.

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

    Subclasses of BinaryDocValues in org.apache.lucene.index
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `MultiDocValues.MultiSortedDocValues` Implements SortedDocValues over n subs, using an OrdinalMap
    `class` | `SortedDocValues` A per-document byte[] with presorted values.

    Methods in org.apache.lucene.index that return BinaryDocValues
    Modifier and Type | Method and Description
    --- | ---
    `static BinaryDocValues` | DocValues.`emptyBinary()` An empty BinaryDocValues which returns `BytesRef.EMPTY_BYTES` for every document
    `static BinaryDocValues` | DocValues.`getBinary(LeafReader reader, String field)` Returns BinaryDocValues for the field, or `DocValues.emptyBinary()` if it has none.
    `abstract BinaryDocValues` | LeafReader.`getBinaryDocValues(String field)` Returns `BinaryDocValues` for this field, or null if no `BinaryDocValues` were indexed for this field.
    `BinaryDocValues` | FilterLeafReader.`getBinaryDocValues(String field)`
    `BinaryDocValues` | CodecReader.`getBinaryDocValues(String field)`
    `BinaryDocValues` | ParallelLeafReader.`getBinaryDocValues(String field)`
    `static BinaryDocValues` | MultiDocValues.`getBinaryValues(IndexReader r, String field)` Returns a BinaryDocValues for a reader's docvalues (potentially merging on-the-fly)

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

    Methods in org.apache.lucene.search that return BinaryDocValues
    Modifier and Type | Method and Description
    --- | ---
    `protected BinaryDocValues` | FieldComparator.TermValComparator.`getBinaryDocValues(LeafReaderContext context, String field)` Retrieves the BinaryDocValues for the field in this segment

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