## 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.lucene84 | Components from the Lucene 8.4 index format.
  org.apache.lucene.codecs.lucene86 | Lucene 8.6 file 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 that return IndexOutput
    Modifier and Type | Method and Description
    --- | ---
    `IndexOutput` | CompoundDirectory.`createOutput(String name, IOContext context)`
    `IndexOutput` | CompoundDirectory.`createTempOutput(String prefix, String suffix, IOContext context)`

    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.
    `protected void` | MultiLevelSkipListWriter.`writeLevelLength(long levelLength, IndexOutput output)` Writes the length of a level to the given output.
    `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.lucene84

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

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

    Fields in org.apache.lucene.codecs.lucene86 declared as IndexOutput
    Modifier and Type | Field and Description
    --- | ---
    `protected IndexOutput` | Lucene86PointsWriter.`dataOut` Outputs used to write the BKD tree data files.
    `protected IndexOutput` | Lucene86PointsWriter.`indexOut` Outputs used to write the BKD tree data files.
    `protected IndexOutput` | Lucene86PointsWriter.`metaOut` Outputs used to write the BKD tree data files.

  - ### 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(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` | `ByteBuffersIndexOutput` An `IndexOutput` writing to a `ByteBuffersDataOutput`.
    `class` | `OutputStreamIndexOutput` Implementation class for buffered `IndexOutput` that writes to an `OutputStream`.
    `class` | `RAMOutputStream` Deprecated. This class uses inefficient synchronization and is discouraged in favor of `MMapDirectory`. It will be removed in future versions of Lucene.
    `class` | `RateLimitedIndexOutput` A `rate limiting` `IndexOutput`

    Methods in org.apache.lucene.store that return IndexOutput
    Modifier and Type | Method and Description
    --- | ---
    `IndexOutput` | LockValidatingDirectoryWrapper.`createOutput(String name, IOContext context)`
    `IndexOutput` | RAMDirectory.`createOutput(String name, IOContext context)` Deprecated.
    `IndexOutput` | NRTCachingDirectory.`createOutput(String name, IOContext context)`
    `IndexOutput` | ByteBuffersDirectory.`createOutput(String name, IOContext context)`
    `IndexOutput` | TrackingDirectoryWrapper.`createOutput(String name, IOContext context)`
    `IndexOutput` | FSDirectory.`createOutput(String name, IOContext context)`
    `IndexOutput` | FileSwitchDirectory.`createOutput(String name, IOContext context)`
    `abstract IndexOutput` | Directory.`createOutput(String name, IOContext context)` Creates a new, empty file in the directory and returns an `IndexOutput` instance for appending data to this file.
    `IndexOutput` | FilterDirectory.`createOutput(String name, IOContext context)`
    `IndexOutput` | RAMDirectory.`createTempOutput(String prefix, String suffix, IOContext context)` Deprecated.
    `IndexOutput` | NRTCachingDirectory.`createTempOutput(String prefix, String suffix, IOContext context)`
    `IndexOutput` | ByteBuffersDirectory.`createTempOutput(String prefix, String suffix, IOContext context)`
    `IndexOutput` | TrackingDirectoryWrapper.`createTempOutput(String prefix, String suffix, IOContext context)`
    `IndexOutput` | FSDirectory.`createTempOutput(String prefix, String suffix, IOContext context)`
    `IndexOutput` | FileSwitchDirectory.`createTempOutput(String prefix, String suffix, IOContext context)`
    `abstract IndexOutput` | Directory.`createTempOutput(String prefix, String suffix, IOContext context)` Creates a new, empty, temporary file in the directory and returns an `IndexOutput` instance for appending data to this file.
    `IndexOutput` | FilterDirectory.`createTempOutput(String prefix, String suffix, IOContext context)`

    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
    --- | ---
    `Runnable` | BKDWriter.`finish(IndexOutput metaOut, IndexOutput indexOut, IndexOutput dataOut)` Writes the BKD tree to the provided `IndexOutput`s and returns a `Runnable` that writes the index of the tree if at least one point has been added, or `null` otherwise.
    `Runnable` | BKDWriter.`merge(IndexOutput metaOut, IndexOutput indexOut, IndexOutput dataOut, List<MergeState.DocMap> docMaps, List<BKDReader> readers)` More efficient bulk-add for incoming `BKDReader`s.
    `Runnable` | BKDWriter.`writeField(IndexOutput metaOut, IndexOutput indexOut, IndexOutput dataOut, String fieldName, MutablePointValues reader)` Write a field from a `MutablePointValues`.

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

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