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

- Packages that use IOContext
  Package | Description
  --- | ---
  org.apache.lucene.codecs | Codecs API: API for customization of the encoding and structure of the index.
  org.apache.lucene.codecs.compressing | StoredFieldsFormat that allows cross-document and cross-field compression of stored fields.
  org.apache.lucene.codecs.lucene50 | Components from the Lucene 5.0 index format See `org.apache.lucene.codecs.lucene80` for an overview of the index format.
  org.apache.lucene.codecs.lucene60 | Components from the Lucene 6.0 index format.
  org.apache.lucene.codecs.lucene86 | Lucene 8.6 file format.
  org.apache.lucene.codecs.lucene87 | Lucene 8.7 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.

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

    Methods in org.apache.lucene.codecs with parameters of type IOContext
    Modifier and Type | Method and Description
    --- | ---
    `IndexOutput` | CompoundDirectory.`createOutput(String name, IOContext context)`
    `IndexOutput` | CompoundDirectory.`createTempOutput(String prefix, String suffix, IOContext context)`
    `abstract StoredFieldsReader` | StoredFieldsFormat.`fieldsReader(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context)` Returns a `StoredFieldsReader` to load stored fields.
    `abstract StoredFieldsWriter` | StoredFieldsFormat.`fieldsWriter(Directory directory, SegmentInfo si, IOContext context)` Returns a `StoredFieldsWriter` to write stored fields.
    `abstract CompoundDirectory` | CompoundFormat.`getCompoundReader(Directory dir, SegmentInfo si, IOContext context)` Returns a Directory view (read-only) for the compound files in this segment
    `abstract FieldInfos` | FieldInfosFormat.`read(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, IOContext iocontext)` Read the `FieldInfos` previously written with `FieldInfosFormat.write(org.apache.lucene.store.Directory, org.apache.lucene.index.SegmentInfo, java.lang.String, org.apache.lucene.index.FieldInfos, org.apache.lucene.store.IOContext)`.
    `abstract SegmentInfo` | SegmentInfoFormat.`read(Directory directory, String segmentName, byte[] segmentID, IOContext context)` Read `SegmentInfo` data from a directory.
    `abstract Bits` | LiveDocsFormat.`readLiveDocs(Directory dir, SegmentCommitInfo info, IOContext context)` Read live docs bits.
    `abstract TermVectorsReader` | TermVectorsFormat.`vectorsReader(Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, IOContext context)` Returns a `TermVectorsReader` to read term vectors.
    `abstract TermVectorsWriter` | TermVectorsFormat.`vectorsWriter(Directory directory, SegmentInfo segmentInfo, IOContext context)` Returns a `TermVectorsWriter` to write term vectors.
    `abstract void` | CompoundFormat.`write(Directory dir, SegmentInfo si, IOContext context)` Packs the provided segment's files into a compound format.
    `abstract void` | SegmentInfoFormat.`write(Directory dir, SegmentInfo info, IOContext ioContext)` Write `SegmentInfo` data.
    `abstract void` | FieldInfosFormat.`write(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, FieldInfos infos, IOContext context)` Writes the provided `FieldInfos` to the directory.
    `abstract void` | LiveDocsFormat.`writeLiveDocs(Bits bits, Directory dir, SegmentCommitInfo info, int newDelCount, IOContext context)` Persist live docs bits.

  - ### Uses of IOContext in org.apache.lucene.codecs.compressing

    Methods in org.apache.lucene.codecs.compressing with parameters of type IOContext
    Modifier and Type | Method and Description
    --- | ---
    `StoredFieldsReader` | CompressingStoredFieldsFormat.`fieldsReader(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context)`
    `StoredFieldsWriter` | CompressingStoredFieldsFormat.`fieldsWriter(Directory directory, SegmentInfo si, IOContext context)`
    `TermVectorsReader` | CompressingTermVectorsFormat.`vectorsReader(Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, IOContext context)`
    `TermVectorsWriter` | CompressingTermVectorsFormat.`vectorsWriter(Directory directory, SegmentInfo segmentInfo, IOContext context)`

    Constructors in org.apache.lucene.codecs.compressing with parameters of type IOContext
    Constructor and Description
    `CompressingStoredFieldsReader(Directory d, SegmentInfo si, String segmentSuffix, FieldInfos fn, IOContext context, String formatName, CompressionMode compressionMode)` Sole constructor.
    `CompressingTermVectorsReader(Directory d, SegmentInfo si, String segmentSuffix, FieldInfos fn, IOContext context, String formatName, CompressionMode compressionMode)` Sole constructor.

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

    Methods in org.apache.lucene.codecs.lucene50 with parameters of type IOContext
    Modifier and Type | Method and Description
    --- | ---
    `CompoundDirectory` | Lucene50CompoundFormat.`getCompoundReader(Directory dir, SegmentInfo si, IOContext context)`
    `FieldInfos` | Lucene50FieldInfosFormat.`read(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, IOContext context)`
    `Bits` | Lucene50LiveDocsFormat.`readLiveDocs(Directory dir, SegmentCommitInfo info, IOContext context)`
    `void` | Lucene50CompoundFormat.`write(Directory dir, SegmentInfo si, IOContext context)`
    `void` | Lucene50FieldInfosFormat.`write(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, FieldInfos infos, IOContext context)`
    `void` | Lucene50LiveDocsFormat.`writeLiveDocs(Bits bits, Directory dir, SegmentCommitInfo info, int newDelCount, IOContext context)`

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

    Methods in org.apache.lucene.codecs.lucene60 with parameters of type IOContext
    Modifier and Type | Method and Description
    --- | ---
    `FieldInfos` | Lucene60FieldInfosFormat.`read(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, IOContext context)`
    `void` | Lucene60FieldInfosFormat.`write(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, FieldInfos infos, IOContext context)`

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

    Methods in org.apache.lucene.codecs.lucene86 with parameters of type IOContext
    Modifier and Type | Method and Description
    --- | ---
    `SegmentInfo` | Lucene86SegmentInfoFormat.`read(Directory dir, String segment, byte[] segmentID, IOContext context)`
    `void` | Lucene86SegmentInfoFormat.`write(Directory dir, SegmentInfo si, IOContext ioContext)`

  - ### Uses of IOContext in org.apache.lucene.codecs.lucene87

    Methods in org.apache.lucene.codecs.lucene87 with parameters of type IOContext
    Modifier and Type | Method and Description
    --- | ---
    `StoredFieldsReader` | Lucene87StoredFieldsFormat.`fieldsReader(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context)`
    `StoredFieldsWriter` | Lucene87StoredFieldsFormat.`fieldsWriter(Directory directory, SegmentInfo si, IOContext context)`

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

    Fields in org.apache.lucene.index declared as IOContext
    Modifier and Type | Field and Description
    --- | ---
    `IOContext` | SegmentReadState.`context` `IOContext` to pass to `Directory.openInput(String,IOContext)`.
    `IOContext` | SegmentWriteState.`context` `IOContext` for all writes; you should pass this to `Directory.createOutput(String,IOContext)`.

    Constructors in org.apache.lucene.index with parameters of type IOContext
    Constructor and Description
    `SegmentReadState(Directory dir, SegmentInfo info, FieldInfos fieldInfos, IOContext context)` Create a `SegmentReadState`.
    `SegmentReadState(Directory dir, SegmentInfo info, FieldInfos fieldInfos, IOContext context, String segmentSuffix)` Create a `SegmentReadState`.
    `SegmentWriteState(InfoStream infoStream, Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, org.apache.lucene.index.BufferedUpdates segUpdates, IOContext context)` Sole constructor.
    `SegmentWriteState(InfoStream infoStream, Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, org.apache.lucene.index.BufferedUpdates segUpdates, IOContext context, String segmentSuffix)` Constructor which takes segment suffix.

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

    Fields in org.apache.lucene.store declared as IOContext
    Modifier and Type | Field and Description
    --- | ---
    `static IOContext` | IOContext.`DEFAULT`
    `static IOContext` | IOContext.`READ`
    `static IOContext` | IOContext.`READONCE`

    Methods in org.apache.lucene.store with parameters of type IOContext
    Modifier and Type | Method and Description
    --- | ---
    `static int` | BufferedIndexInput.`bufferSize(IOContext context)` Returns default buffer sizes for the given `IOContext`
    `void` | LockValidatingDirectoryWrapper.`copyFrom(Directory from, String src, String dest, IOContext context)`
    `void` | TrackingDirectoryWrapper.`copyFrom(Directory from, String src, String dest, IOContext context)`
    `void` | Directory.`copyFrom(Directory from, String src, String dest, IOContext context)` Copies an existing `src` file from directory `from` to a non-existent file `dest` in this directory.
    `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)`
    `protected boolean` | NRTCachingDirectory.`doCacheWrite(String name, IOContext context)` Subclass can override this to customize logic; return true if this file should be written to the RAMDirectory.
    `ChecksumIndexInput` | Directory.`openChecksumInput(String name, IOContext context)` Opens a checksum-computing stream for reading an existing file.
    `IndexInput` | RAMDirectory.`openInput(String name, IOContext context)` Deprecated. Returns a stream reading an existing file.
    `IndexInput` | NRTCachingDirectory.`openInput(String name, IOContext context)`
    `IndexInput` | MMapDirectory.`openInput(String name, IOContext context)` Creates an IndexInput for the file with the given name.
    `IndexInput` | ByteBuffersDirectory.`openInput(String name, IOContext context)`
    `IndexInput` | FileSwitchDirectory.`openInput(String name, IOContext context)`
    `abstract IndexInput` | Directory.`openInput(String name, IOContext context)` Opens a stream for reading an existing file.
    `IndexInput` | SimpleFSDirectory.`openInput(String name, IOContext context)` Deprecated. Creates an IndexInput for the file with the given name.
    `IndexInput` | NIOFSDirectory.`openInput(String name, IOContext context)`
    `IndexInput` | FilterDirectory.`openInput(String name, IOContext context)`

    Constructors in org.apache.lucene.store with parameters of type IOContext
    Constructor and Description
    `BufferedIndexInput(String resourceDesc, IOContext context)`
    `IOContext(IOContext ctxt, boolean readOnce)` This constructor is used to initialize a `IOContext` instance with a new value for the readOnce variable.
    `RAMDirectory(FSDirectory dir, IOContext context)` Deprecated. Creates a new `RAMDirectory` instance from a different `Directory` implementation.

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