## 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.lucene3x | Codec to support Lucene 3.x indexes (readonly)
  org.apache.lucene.codecs.lucene40 | Lucene 4.0 file format.
  org.apache.lucene.codecs.lucene41 | Lucene 4.1 file 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.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
    --- | ---
    `abstract void` | PostingsReaderBase.`init(IndexInput termsIn)` Performs any initialization, such as reading and verifying the header from the provided terms dictionary `IndexInput`.
    `protected int` | BlockTreeTermsReader.`readHeader(IndexInput input)` Reads terms file header.
    `protected int` | BlockTreeTermsReader.`readIndexHeader(IndexInput input)` Reads index file header.
    `protected abstract int` | MultiLevelSkipListReader.`readSkipData(int level, IndexInput skipStream)` Subclasses must implement the actual skip data encoding in this method.
    `abstract void` | PostingsReaderBase.`readTermsBlock(IndexInput termsIn, FieldInfo fieldInfo, BlockTermState termState)` Reads data for all terms in the next block; this method should merely load the byte[] blob but not decode, which is done in `PostingsReaderBase.nextTerm(org.apache.lucene.index.FieldInfo, org.apache.lucene.codecs.BlockTermState)`.
    `protected void` | BlockTreeTermsReader.`seekDir(IndexInput input, long dirOffset)` Seek `input` to the directory offset.

    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.lucene3x

    Methods in org.apache.lucene.codecs.lucene3x with parameters of type IndexInput
    Modifier and Type | Method and Description
    --- | ---
    `static void` | Lucene3xSegmentInfoReader.`readLegacyInfos(SegmentInfos infos, Directory directory, IndexInput input, int format)` Deprecated.

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

    Methods in org.apache.lucene.codecs.lucene40 that return IndexInput
    Modifier and Type | Method and Description
    --- | ---
    `IndexInput` | Lucene40StoredFieldsReader.`rawDocs(int[] lengths, int startDocID, int numDocs)` Returns the length in bytes of each raw document in a contiguous range of length numDocs starting with startDocID.

    Methods in org.apache.lucene.codecs.lucene40 with parameters of type IndexInput
    Modifier and Type | Method and Description
    --- | ---
    `void` | Lucene40StoredFieldsWriter.`addRawDocuments(IndexInput stream, int[] lengths, int numDocs)` Bulk write a contiguous series of documents.
    `void` | Lucene40PostingsReader.`init(IndexInput termsIn)` Deprecated.
    `protected int` | Lucene40SkipListReader.`readSkipData(int level, IndexInput skipStream)` Deprecated.
    `void` | Lucene40PostingsReader.`readTermsBlock(IndexInput termsIn, FieldInfo fieldInfo, BlockTermState _termState)` Deprecated.

    Constructors in org.apache.lucene.codecs.lucene40 with parameters of type IndexInput
    Constructor and Description
    `Lucene40SkipListReader(IndexInput skipStream, int maxSkipLevels, int skipInterval)` Deprecated. Sole constructor.

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

    Methods in org.apache.lucene.codecs.lucene41 with parameters of type IndexInput
    Modifier and Type | Method and Description
    --- | ---
    `void` | Lucene41PostingsReader.`init(IndexInput termsIn)`
    `void` | Lucene41PostingsReader.`readTermsBlock(IndexInput termsIn, FieldInfo fieldInfo, BlockTermState _termState)`

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

    Subclasses of IndexInput in org.apache.lucene.store
    Modifier and Type | Class and Description
    --- | ---
    `class` | `BufferedIndexInput` Base implementation class for buffered `IndexInput`.
    `class` | `ChecksumIndexInput` Reads bytes through to a primary IndexInput, computing checksum as it goes.
    `protected static class` | `FSDirectory.FSIndexInput` Base class for reading input from a RandomAccessFile
    `protected static class` | `NIOFSDirectory.NIOFSIndexInput` Reads bytes with `FileChannel.read(ByteBuffer, long)`
    `class` | `RAMInputStream` A memory-resident `IndexInput` implementation.
    `protected static class` | `SimpleFSDirectory.SimpleFSIndexInput` Reads bytes with `RandomAccessFile.seek(long)` followed by `RandomAccessFile.read(byte[], int, int)`.

    Methods in org.apache.lucene.store that return IndexInput
    Modifier and Type | Method and Description
    --- | ---
    `IndexInput` | IndexInput.`clone()` Returns a clone of this stream.
    `abstract IndexInput` | Directory.IndexInputSlicer.`openFullSlice()` Deprecated. Only for reading CFS files from 3.x indexes.
    `IndexInput` | TrackingDirectoryWrapper.`openInput(String name, IOContext context)`
    `IndexInput` | SimpleFSDirectory.`openInput(String name, IOContext context)` Creates an IndexInput for the file with the given name.
    `IndexInput` | RateLimitedDirectoryWrapper.`openInput(String name, IOContext context)`
    `IndexInput` | RAMDirectory.`openInput(String name, IOContext context)` Returns a stream reading an existing file.
    `IndexInput` | NRTCachingDirectory.`openInput(String name, IOContext context)`
    `IndexInput` | NIOFSDirectory.`openInput(String name, IOContext context)` Creates an IndexInput for the file with the given name.
    `IndexInput` | MMapDirectory.`openInput(String name, IOContext context)` Creates an IndexInput for the file with the given name.
    `IndexInput` | FileSwitchDirectory.`openInput(String name, IOContext context)`
    `abstract IndexInput` | Directory.`openInput(String name, IOContext context)` Returns a stream reading an existing file, with the specified read buffer size.
    `IndexInput` | CompoundFileDirectory.`openInput(String name, IOContext context)`
    `abstract IndexInput` | Directory.IndexInputSlicer.`openSlice(String sliceDescription, long offset, long length)` Returns an `IndexInput` slice starting at the given offset with the given length.

    Constructors in org.apache.lucene.store with parameters of type IndexInput
    Constructor and Description
    `ChecksumIndexInput(IndexInput main)`

  - ### 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.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 PackedInts.Reader` | PackedInts.`getDirectReaderNoHeader(IndexInput in, PackedInts.Header header)` Expert: Construct a direct `PackedInts.Reader` from an `IndexInput` without reading metadata at the beginning of the stream.

    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.
    `MonotonicBlockPackedReader(IndexInput in, int packedIntsVersion, int blockSize, long valueCount, boolean direct)` Sole constructor.

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