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

- Packages that use IndexOutput
  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.codecs.lucene60 | Components from the Lucene 6.0 index format.
  org.apache.lucene.index | Code to maintain and access indices.
  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 IndexOutput in org.apache.lucene.codecs

    Methods in org.apache.lucene.codecs with parameters of type IndexOutput
    Modifier and Type | Method and Description
    --- | ---
    `abstract void` | PostingsWriterBase.`init(IndexOutput termsOut, SegmentWriteState state)` Called once after startup, before any terms have been added.
    `static void` | CodecUtil.`writeFooter(IndexOutput out)` Writes a codec footer, which records both a checksum algorithm ID and a checksum.
    `long` | MultiLevelSkipListWriter.`writeSkip(IndexOutput output)` Writes the buffered skip lists to the given output.
    `protected abstract void` | MultiLevelSkipListWriter.`writeSkipData(int level, IndexOutput skipBuffer)` Subclasses must implement the actual skip data encoding in this method.

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

    Methods in org.apache.lucene.codecs.lucene50 with parameters of type IndexOutput
    Modifier and Type | Method and Description
    --- | ---
    `void` | Lucene50PostingsWriter.`init(IndexOutput termsOut, SegmentWriteState state)`

  - ### Uses of IndexOutput in org.apache.lucene.codecs.lucene60

    Fields in org.apache.lucene.codecs.lucene60 declared as IndexOutput
    Modifier and Type | Field and Description
    --- | ---
    `protected IndexOutput` | Lucene60PointsWriter.`dataOut` Output used to write the BKD tree data file

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

    Methods in org.apache.lucene.index with parameters of type IndexOutput
    Modifier and Type | Method and Description
    --- | ---
    `void` | SegmentInfos.`write(Directory directory, IndexOutput out)` Write ourselves to the provided `IndexOutput`

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

    Subclasses of IndexOutput in org.apache.lucene.store
    Modifier and Type | Class and Description
    --- | ---
    `class` | `OutputStreamIndexOutput` Implementation class for buffered `IndexOutput` that writes to an `OutputStream`.
    `class` | `RAMOutputStream` A memory-resident `IndexOutput` implementation.
    `class` | `RateLimitedIndexOutput` A `rate limiting` `IndexOutput`

    Methods in org.apache.lucene.store that return IndexOutput
    Modifier and Type | Method and Description
    --- | ---
    `IndexOutput` | RAMDirectory.`createOutput(String name, IOContext context)`
    `IndexOutput` | FilterDirectory.`createOutput(String name, IOContext context)`
    `IndexOutput` | FileSwitchDirectory.`createOutput(String name, IOContext context)`
    `IndexOutput` | FSDirectory.`createOutput(String name, IOContext context)`
    `abstract IndexOutput` | Directory.`createOutput(String name, IOContext context)` Creates a new, empty file in the directory with the given name.
    `IndexOutput` | TrackingDirectoryWrapper.`createOutput(String name, IOContext context)`
    `IndexOutput` | LockValidatingDirectoryWrapper.`createOutput(String name, IOContext context)`
    `IndexOutput` | NRTCachingDirectory.`createOutput(String name, IOContext context)`
    `IndexOutput` | RAMDirectory.`createTempOutput(String prefix, String suffix, IOContext context)`
    `IndexOutput` | FilterDirectory.`createTempOutput(String prefix, String suffix, IOContext context)`
    `IndexOutput` | FileSwitchDirectory.`createTempOutput(String prefix, String suffix, IOContext context)`
    `IndexOutput` | FSDirectory.`createTempOutput(String prefix, String suffix, IOContext context)`
    `abstract IndexOutput` | Directory.`createTempOutput(String prefix, String suffix, IOContext context)` Creates a new, empty file for writing in the directory, with a temporary file name including prefix and suffix, ending with the reserved extension `.tmp`.
    `IndexOutput` | TrackingDirectoryWrapper.`createTempOutput(String prefix, String suffix, IOContext context)`
    `IndexOutput` | NRTCachingDirectory.`createTempOutput(String prefix, String suffix, IOContext context)`

    Methods in org.apache.lucene.store with parameters of type IndexOutput
    Modifier and Type | Method and Description
    --- | ---
    `protected int` | BufferedIndexInput.`flushBuffer(IndexOutput out, long numBytes)` Flushes the in-memory buffer to the given output, copying at most `numBytes`.

    Constructors in org.apache.lucene.store with parameters of type IndexOutput
    Constructor and Description
    `RateLimitedIndexOutput(RateLimiter rateLimiter, IndexOutput delegate)`

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

    Fields in org.apache.lucene.util declared as IndexOutput
    Modifier and Type | Field and Description
    --- | ---
    `protected IndexOutput` | OfflineSorter.ByteSequencesWriter.`out`

    Methods in org.apache.lucene.util with parameters of type IndexOutput
    Modifier and Type | Method and Description
    --- | ---
    `protected OfflineSorter.ByteSequencesWriter` | OfflineSorter.`getWriter(IndexOutput out, long itemCount)` Subclasses can override to change how byte sequences are written to disk.

    Constructors in org.apache.lucene.util with parameters of type IndexOutput
    Constructor and Description
    `ByteSequencesWriter(IndexOutput out)` Constructs a ByteSequencesWriter to the provided DataOutput

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

    Fields in org.apache.lucene.util.bkd declared as IndexOutput
    Modifier and Type | Field and Description
    --- | ---
    `IndexOutput` | OfflinePointWriter.`out`

    Methods in org.apache.lucene.util.bkd with parameters of type IndexOutput
    Modifier and Type | Method and Description
    --- | ---
    `long` | BKDWriter.`finish(IndexOutput out)` Writes the BKD tree to the provided `IndexOutput` and returns the file offset where index was written.
    `long` | BKDWriter.`merge(IndexOutput out, List<MergeState.DocMap> docMaps, List<BKDReader> readers)` More efficient bulk-add for incoming `BKDReader`s.
    `long` | BKDWriter.`writeField(IndexOutput out, String fieldName, MutablePointsReader reader)` Write a field from a `MutablePointsReader`.

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

    Methods in org.apache.lucene.util.packed with parameters of type IndexOutput
    Modifier and Type | Method and Description
    --- | ---
    `static DirectMonotonicWriter` | DirectMonotonicWriter.`getInstance(IndexOutput metaOut, IndexOutput dataOut, long numValues, int blockShift)` Returns an instance suitable for encoding `numValues` into monotonic blocks of 2`blockShift` values.
    `static DirectWriter` | DirectWriter.`getInstance(IndexOutput output, long numValues, int bitsPerValue)` Returns an instance suitable for encoding `numValues` using `bitsPerValue`

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