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

- Packages that use CodecReader
  Package | Description
  --- | ---
  org.apache.lucene.index | Code to maintain and access indices.

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

    Subclasses of CodecReader in org.apache.lucene.index
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `FilterCodecReader` | A `FilterCodecReader` contains another CodecReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.
    `class` | `SegmentReader` | IndexReader implementation over a single segment.
    `class` | `SortingCodecReader` | An `CodecReader` which supports sorting documents by a given `Sort`.

    Fields in org.apache.lucene.index declared as CodecReader
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected CodecReader` | FilterCodecReader.`in` | The underlying CodecReader instance.

    Methods in org.apache.lucene.index that return CodecReader
    Modifier and Type | Method | Description
    --- | --- | ---
    `CodecReader` | FilterCodecReader.`getDelegate()` | Returns the wrapped `CodecReader`.
    `static CodecReader` | FilterCodecReader.`unwrap​(CodecReader reader)` | Get the wrapped instance by `reader` as long as this reader is an instance of `FilterCodecReader`.
    `static CodecReader` | SlowCodecReaderWrapper.`wrap​(LeafReader reader)` | Returns a `CodecReader` view of reader.
    `static CodecReader` | SortingCodecReader.`wrap​(CodecReader reader, Sorter.DocMap docMap, Sort sort)` | Expert: same as `SortingCodecReader.wrap(org.apache.lucene.index.CodecReader, Sort)` but operates directly on a `Sorter.DocMap`.
    `static CodecReader` | SortingCodecReader.`wrap​(CodecReader reader, Sort sort)` | Return a sorted view of `reader` according to the order defined by `sort` .
    `CodecReader` | MergePolicy.OneMerge.`wrapForMerge​(CodecReader reader)` | Wrap a reader prior to merging in order to add/remove fields or documents.

    Methods in org.apache.lucene.index with parameters of type CodecReader
    Modifier and Type | Method | Description
    --- | --- | ---
    `long` | IndexWriter.`addIndexes​(CodecReader... readers)` | Merges the provided indexes into this index.
    `MergePolicy.MergeSpecification` | FilterMergePolicy.`findMerges​(CodecReader... readers)` |
    `MergePolicy.MergeSpecification` | MergePolicy.`findMerges​(CodecReader... readers)` | Define the set of merge operations to perform on provided codec readers in `IndexWriter.addIndexes(CodecReader...)`.
    `MergePolicy.MergeSpecification` | NoMergePolicy.`findMerges​(CodecReader... readers)` |
    `Sorter.DocMap` | MergePolicy.OneMerge.`reorder​(CodecReader reader, Directory dir)` | Extend this method if you wish to renumber doc IDs.
    `static CheckIndex.Status.DocValuesStatus` | CheckIndex.`testDocValues​(CodecReader reader, PrintStream infoStream, boolean failFast)` | Test docvalues.
    `static CheckIndex.Status.FieldInfoStatus` | CheckIndex.`testFieldInfos​(CodecReader reader, PrintStream infoStream, boolean failFast)` | Test field infos.
    `static CheckIndex.Status.FieldNormStatus` | CheckIndex.`testFieldNorms​(CodecReader reader, PrintStream infoStream, boolean failFast)` | Test field norms.
    `static CheckIndex.Status.LiveDocStatus` | CheckIndex.`testLiveDocs​(CodecReader reader, PrintStream infoStream, boolean failFast)` | Test live docs.
    `static CheckIndex.Status.PointsStatus` | CheckIndex.`testPoints​(CodecReader reader, PrintStream infoStream, boolean failFast)` | Test the points index.
    `static CheckIndex.Status.TermIndexStatus` | CheckIndex.`testPostings​(CodecReader reader, PrintStream infoStream)` | Test the term index.
    `static CheckIndex.Status.TermIndexStatus` | CheckIndex.`testPostings​(CodecReader reader, PrintStream infoStream, boolean verbose, boolean doSlowChecks, boolean failFast)` | Test the term index.
    `static CheckIndex.Status.IndexSortStatus` | CheckIndex.`testSort​(CodecReader reader, Sort sort, PrintStream infoStream, boolean failFast)` | Tests index sort order.
    `static CheckIndex.Status.StoredFieldStatus` | CheckIndex.`testStoredFields​(CodecReader reader, PrintStream infoStream, boolean failFast)` | Test stored fields.
    `static CheckIndex.Status.TermVectorStatus` | CheckIndex.`testTermVectors​(CodecReader reader, PrintStream infoStream)` | Test term vectors.
    `static CheckIndex.Status.TermVectorStatus` | CheckIndex.`testTermVectors​(CodecReader reader, PrintStream infoStream, boolean verbose, boolean doSlowChecks, boolean failFast)` | Test term vectors.
    `static CheckIndex.Status.VectorValuesStatus` | CheckIndex.`testVectors​(CodecReader reader, PrintStream infoStream, boolean failFast)` | Test the vectors index.
    `static CodecReader` | FilterCodecReader.`unwrap​(CodecReader reader)` | Get the wrapped instance by `reader` as long as this reader is an instance of `FilterCodecReader`.
    `static CodecReader` | SortingCodecReader.`wrap​(CodecReader reader, Sorter.DocMap docMap, Sort sort)` | Expert: same as `SortingCodecReader.wrap(org.apache.lucene.index.CodecReader, Sort)` but operates directly on a `Sorter.DocMap`.
    `static CodecReader` | SortingCodecReader.`wrap​(CodecReader reader, Sort sort)` | Return a sorted view of `reader` according to the order defined by `sort` .
    `CodecReader` | MergePolicy.OneMerge.`wrapForMerge​(CodecReader reader)` | Wrap a reader prior to merging in order to add/remove fields or documents.

    Method parameters in org.apache.lucene.index with type arguments of type CodecReader
    Modifier and Type | Method | Description
    --- | --- | ---
    `boolean` | FilterMergePolicy.`keepFullyDeletedSegment​(IOSupplier<CodecReader> readerIOSupplier)` |
    `boolean` | MergePolicy.`keepFullyDeletedSegment​(IOSupplier<CodecReader> readerIOSupplier)` | Returns true if the segment represented by the given CodecReader should be keep even if it's fully deleted.
    `boolean` | NoMergePolicy.`keepFullyDeletedSegment​(IOSupplier<CodecReader> readerIOSupplier)` |
    `boolean` | SoftDeletesRetentionMergePolicy.`keepFullyDeletedSegment​(IOSupplier<CodecReader> readerIOSupplier)` |
    `int` | FilterMergePolicy.`numDeletesToMerge​(SegmentCommitInfo info, int delCount, IOSupplier<CodecReader> readerSupplier)` |
    `int` | MergePolicy.`numDeletesToMerge​(SegmentCommitInfo info, int delCount, IOSupplier<CodecReader> readerSupplier)` | Returns the number of deletes that a merge would claim on the given segment.
    `int` | NoMergePolicy.`numDeletesToMerge​(SegmentCommitInfo info, int delCount, IOSupplier<CodecReader> readerSupplier)` |
    `int` | SoftDeletesRetentionMergePolicy.`numDeletesToMerge​(SegmentCommitInfo info, int delCount, IOSupplier<CodecReader> readerSupplier)` |

    Constructors in org.apache.lucene.index with parameters of type CodecReader
    Constructor | Description
    --- | ---
    `FilterCodecReader​(CodecReader in)` | Creates a new FilterCodecReader.
    `OneMerge​(CodecReader... codecReaders)` | Create a OneMerge directly from CodecReaders.