## Uses of Class
org.apache.lucene.store.IndexInput

- Packages that use IndexInput
  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.store | Binary i/o API, used for all index data.
  org.apache.lucene.util | Some utility classes.
  org.apache.lucene.util.bkd | Block KD-tree, implementing the generic spatial data structure described in this paper.
  org.apache.lucene.util.packed | Packed integer arrays and streams.

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

    Methods in org.apache.lucene.codecs with parameters of type IndexInput
    Modifier and Type | Method and Description
    --- | ---
    `static long` | CodecUtil.`checksumEntireFile(IndexInput input)` Clones the provided input, reads all bytes from the file, and calls `CodecUtil.checkFooter(org.apache.lucene.store.ChecksumIndexInput)`
    `abstract void` | PostingsReaderBase.`init(IndexInput termsIn, SegmentReadState state)` Performs any initialization, such as reading and verifying the header from the provided terms dictionary `IndexInput`.
    `static byte[]` | CodecUtil.`readFooter(IndexInput in)` Retrieves the full footer from the provided `IndexInput`.
    `static byte[]` | CodecUtil.`readIndexHeader(IndexInput in)` Retrieves the full index header from the provided `IndexInput`.
    `protected abstract int` | MultiLevelSkipListReader.`readSkipData(int level, IndexInput skipStream)` Subclasses must implement the actual skip data encoding in this method.
    `static long` | CodecUtil.`retrieveChecksum(IndexInput in)` Returns (but does not validate) the checksum previously written by `CodecUtil.checkFooter(org.apache.lucene.store.ChecksumIndexInput)`.
    `static void` | CodecUtil.`verifyAndCopyIndexHeader(IndexInput in, DataOutput out, byte[] expectedID)` Expert: verifies the incoming `IndexInput` has an index header and that its segment ID matches the expected one, and then copies that index header into the provided `DataOutput`.

    Constructors in org.apache.lucene.codecs with parameters of type IndexInput
    Constructor and Description
    `MultiLevelSkipListReader(IndexInput skipStream, int maxSkipLevels, int skipInterval)` Creates a `MultiLevelSkipListReader`, where `skipInterval` and `skipMultiplier` are the same.
    `MultiLevelSkipListReader(IndexInput skipStream, int maxSkipLevels, int skipInterval, int skipMultiplier)` Creates a `MultiLevelSkipListReader`.

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

    Methods in org.apache.lucene.codecs.lucene50 with parameters of type IndexInput
    Modifier and Type | Method and Description
    --- | ---
    `void` | Lucene50PostingsReader.`init(IndexInput termsIn, SegmentReadState state)`

  - ### Uses of IndexInput in org.apache.lucene.store

    Subclasses of IndexInput in org.apache.lucene.store
    Modifier and Type | Class and Description
    --- | ---
    `class` | `BufferedChecksumIndexInput` Simple implementation of `ChecksumIndexInput` that wraps another input and delegates calls.
    `class` | `BufferedIndexInput` Base implementation class for buffered `IndexInput`.
    `class` | `ByteArrayIndexInput` DataInput backed by a byte array.
    `class` | `ChecksumIndexInput` Extension of IndexInput, computing checksum as it goes.
    `class` | `RAMInputStream` A memory-resident `IndexInput` implementation.

    Methods in org.apache.lucene.store that return IndexInput
    Modifier and Type | Method and Description
    --- | ---
    `IndexInput` | IndexInput.`clone()` Returns a clone of this stream.
    `IndexInput` | BufferedChecksumIndexInput.`clone()`
    `IndexInput` | RAMDirectory.`openInput(String name, IOContext context)` Returns a stream reading an existing file.
    `IndexInput` | FilterDirectory.`openInput(String name, IOContext context)`
    `IndexInput` | FileSwitchDirectory.`openInput(String name, IOContext context)`
    `abstract IndexInput` | Directory.`openInput(String name, IOContext context)` Returns a stream reading an existing file.
    `IndexInput` | SimpleFSDirectory.`openInput(String name, IOContext context)` Creates an IndexInput for the file with the given name.
    `IndexInput` | NIOFSDirectory.`openInput(String name, IOContext context)`
    `IndexInput` | MMapDirectory.`openInput(String name, IOContext context)` Creates an IndexInput for the file with the given name.
    `IndexInput` | NRTCachingDirectory.`openInput(String name, IOContext context)`
    `IndexInput` | RAMInputStream.`slice(String sliceDescription, long offset, long sliceLength)`
    `IndexInput` | ByteArrayIndexInput.`slice(String sliceDescription, long offset, long length)`
    `abstract IndexInput` | IndexInput.`slice(String sliceDescription, long offset, long length)` Creates a slice of this index input, with the given description, offset, and length.
    `IndexInput` | BufferedIndexInput.`slice(String sliceDescription, long offset, long length)`
    `IndexInput` | BufferedChecksumIndexInput.`slice(String sliceDescription, long offset, long length)`

    Methods in org.apache.lucene.store with parameters of type IndexInput
    Modifier and Type | Method and Description
    --- | ---
    `static BufferedIndexInput` | BufferedIndexInput.`wrap(String sliceDescription, IndexInput other, long offset, long length)` Wraps a portion of another IndexInput with buffering.

    Constructors in org.apache.lucene.store with parameters of type IndexInput
    Constructor and Description
    `BufferedChecksumIndexInput(IndexInput main)` Creates a new BufferedChecksumIndexInput

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

    Methods in org.apache.lucene.util with parameters of type IndexInput
    Modifier and Type | Method and Description
    --- | ---
    `void` | PagedBytes.`copy(IndexInput in, long byteCount)` Read this many bytes from in

  - ### Uses of IndexInput in org.apache.lucene.util.bkd

    Constructors in org.apache.lucene.util.bkd with parameters of type IndexInput
    Constructor and Description
    `BKDReader(IndexInput in)` Caller must pre-seek the provided `IndexInput` to the index location that `BKDWriter.finish(org.apache.lucene.store.IndexOutput)` returned
    `IntersectState(IndexInput in, int numDims, int packedBytesLength, int maxPointsInLeafNode, PointValues.IntersectVisitor visitor, BKDReader.IndexTree indexVisitor)`

  - ### Uses of IndexInput in org.apache.lucene.util.packed

    Methods in org.apache.lucene.util.packed with parameters of type IndexInput
    Modifier and Type | Method and Description
    --- | ---
    `static PackedInts.Reader` | PackedInts.`getDirectReader(IndexInput in)` Construct a direct `PackedInts.Reader` from an `IndexInput`.
    `static PackedInts.Reader` | PackedInts.`getDirectReaderNoHeader(IndexInput in, PackedInts.Format format, int version, int valueCount, int bitsPerValue)` Expert: Construct a direct `PackedInts.Reader` from a stream without reading metadata at the beginning of the stream.
    `static DirectMonotonicReader.Meta` | DirectMonotonicReader.`loadMeta(IndexInput metaIn, long numValues, int blockShift)` Load metadata from the given `IndexInput`.
    `static MonotonicBlockPackedReader` | MonotonicBlockPackedReader.`of(IndexInput in, int packedIntsVersion, int blockSize, long valueCount, boolean direct)` Sole constructor.

    Constructors in org.apache.lucene.util.packed with parameters of type IndexInput
    Constructor and Description
    `BlockPackedReader(IndexInput in, int packedIntsVersion, int blockSize, long valueCount, boolean direct)` Sole constructor.

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