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

Packages that use DataOutput
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.lucene84: Components from the Lucene 8.4 index format.
org.apache.lucene.index: Code to maintain and access indices.
org.apache.lucene.search: Code to search 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.compress: Compression utilities.
org.apache.lucene.util.fst: Finite state transducers
org.apache.lucene.util.packed: Packed integer arrays and streams.

### Uses of DataOutput in org.apache.lucene.codecs

Methods in org.apache.lucene.codecs with parameters of type DataOutput
`abstract void` PostingsWriterBase.`encodeTerm(DataOutput out, FieldInfo fieldInfo, BlockTermState state, boolean absolute)` Encode metadata as long[] and byte[].
`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`.
`static void` CodecUtil.`writeHeader(DataOutput out, String codec, int version)` Writes a codec header, which records both a string to identify the file and a version number.
`static void` CodecUtil.`writeIndexHeader(DataOutput out, String codec, int version, byte[] id, String suffix)` Writes a codec header for an index file, which records both a string to identify the format of the file, a version number, and data to identify the file instance (ID and auxiliary suffix such as generation).

### Uses of DataOutput in org.apache.lucene.codecs.compressing

Methods in org.apache.lucene.codecs.compressing with parameters of type DataOutput
`abstract void` Compressor.`compress(byte[] bytes, int off, int len, DataOutput out)` Compress bytes into `out`.

### Uses of DataOutput in org.apache.lucene.codecs.lucene84

Methods in org.apache.lucene.codecs.lucene84 with parameters of type DataOutput
`void` Lucene84PostingsWriter.`encodeTerm(DataOutput out, FieldInfo fieldInfo, BlockTermState _state, boolean absolute)`

### Uses of DataOutput in org.apache.lucene.index

Methods in org.apache.lucene.index with parameters of type DataOutput
`static void` SortFieldProvider.`write(SortField sf, DataOutput output)` Writes a SortField to a DataOutput
`abstract void` SortFieldProvider.`writeSortField(SortField sf, DataOutput out)` Writes a SortField to a DataOutput This is used to record index sort information in segment headers

Constructors in org.apache.lucene.index with parameters of type DataOutput
Constructor and Description
`CorruptIndexException(String message, DataOutput output)` Create exception with a message only
`CorruptIndexException(String message, DataOutput output, Throwable cause)` Create exception with message and root cause.

### Uses of DataOutput in org.apache.lucene.search

Methods in org.apache.lucene.search with parameters of type DataOutput
`void` SortField.Provider.`writeSortField(SortField sf, DataOutput out)`
`void` SortedSetSortField.Provider.`writeSortField(SortField sf, DataOutput out)`
`void` SortedNumericSortField.Provider.`writeSortField(SortField sf, DataOutput out)`

### Uses of DataOutput in org.apache.lucene.store

Subclasses of DataOutput in org.apache.lucene.store
`class` `ByteArrayDataOutput` DataOutput backed by a byte array.
`class` `ByteBuffersDataOutput` A `DataOutput` storing data in a list of `ByteBuffer`s.
`class` `ByteBuffersIndexOutput` An `IndexOutput` writing to a `ByteBuffersDataOutput`.
`class` `GrowableByteArrayDataOutput` A `DataOutput` that can be used to build a byte[].
`class` `IndexOutput` A `DataOutput` for appending data to a file in a `Directory`.
`class` `OutputStreamDataOutput` A `DataOutput` wrapping a plain `OutputStream`.
`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 with parameters of type DataOutput
`void` ByteBuffersDataOutput.`copyTo(DataOutput output)` Copy the current content of this object into another `DataOutput`.
`void` RAMOutputStream.`writeTo(DataOutput out)` Deprecated. Copy the current contents of this buffer to the provided `DataOutput`.

### Uses of DataOutput in org.apache.lucene.util

Subclasses of DataOutput in org.apache.lucene.util
`class` `PagedBytes.PagedBytesDataOutput`

### Uses of DataOutput in org.apache.lucene.util.compress

Methods in org.apache.lucene.util.compress with parameters of type DataOutput
`static boolean` LowercaseAsciiCompression.`compress(byte[] in, int len, byte[] tmp, DataOutput out)` Compress `in[0:len]` into `out`.
`static void` LZ4.`compress(byte[] bytes, int off, int len, DataOutput out, org.apache.lucene.util.compress.LZ4.HashTable ht)` Compress `bytes[off:off+len]` into `out` using at most 16KB of memory.

### Uses of DataOutput in org.apache.lucene.util.fst

Methods in org.apache.lucene.util.fst with parameters of type DataOutput
`void` FST.`save(DataOutput metaOut, DataOutput out)`
`void` ByteSequenceOutputs.`write(BytesRef prefix, DataOutput out)`
`void` CharSequenceOutputs.`write(CharsRef prefix, DataOutput out)`
`void` IntSequenceOutputs.`write(IntsRef prefix, DataOutput out)`
`void` PositiveIntOutputs.`write(Long output, DataOutput out)`
`void` NoOutputs.`write(Object prefix, DataOutput out)`
`void` PairOutputs.`write(PairOutputs.Pair<A,B> output, DataOutput writer)`
`abstract void` Outputs.`write(T output, DataOutput out)` Encode an output value into a `DataOutput`.
`void` Outputs.`writeFinalOutput(T output, DataOutput out)` Encode an final node output value into a `DataOutput`.
`void` OnHeapFSTStore.`writeTo(DataOutput out)`
`void` OffHeapFSTStore.`writeTo(DataOutput out)`
`void` FSTStore.`writeTo(DataOutput out)`

### Uses of DataOutput in org.apache.lucene.util.packed

Fields in org.apache.lucene.util.packed declared as DataOutput
`protected DataOutput` PackedInts.Writer.`out`

Methods in org.apache.lucene.util.packed with parameters of type DataOutput
`static DirectWriter` DirectWriter.`getInstance(DataOutput output, long numValues, int bitsPerValue)` Returns an instance suitable for encoding `numValues` using `bitsPerValue`
`static PackedInts.Writer` PackedInts.`getWriter(DataOutput out, int valueCount, int bitsPerValue, float acceptableOverheadRatio)` Create a packed integer array writer for the given output, format, value count, and number of bits per value.
`static PackedInts.Writer` PackedInts.`getWriterNoHeader(DataOutput out, PackedInts.Format format, int valueCount, int bitsPerValue, int mem)` Expert: Create a packed integer array writer for the given output, format, value count, and number of bits per value.
`void` GrowableWriter.`save(DataOutput out)`
`void` PackedInts.Mutable.`save(DataOutput out)` Save this mutable into `out`.

Constructors in org.apache.lucene.util.packed with parameters of type DataOutput
Constructor and Description
`BlockPackedWriter(DataOutput out, int blockSize)` Sole constructor.
`MonotonicBlockPackedWriter(DataOutput out, int blockSize)` Sole constructor.
`PackedDataOutput(DataOutput out)` Create a new instance that wraps `out`.
`Writer(DataOutput out, int valueCount, int bitsPerValue)`