Class BufferedChecksumStreamOutput

java.lang.Object

java.io.OutputStream

org.opensearch.core.common.io.stream.StreamOutput

org.opensearch.core.common.io.stream.BufferedChecksumStreamOutput

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

@PublicApi(since="1.0.0")
public final class BufferedChecksumStreamOutput
extends StreamOutput

Similar to Lucene's BufferedChecksumIndexOutput, however this wraps a StreamOutput so anything written will update the checksum

Opensearch.api:

Constructor Summary

Constructors

Constructor	Description
BufferedChecksumStreamOutput(StreamOutput out)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this stream to further operations.
void	flush()	Forces any buffered output to be written.
long	getChecksum()
void	reset()
void	resetDigest()
void	writeByte(byte b)	Writes a single byte.
void	writeBytes(byte[] b, int offset, int length)	Writes an array of bytes.
void	writeCollection(Collection<? extends Writeable> collection)	Writes a collection to this stream.
void	writeMap(Map<String,Object> map)
<K,V> void	writeMap(Map<K,V> map, Writeable.Writer<K> keyWriter, Writeable.Writer<V> valueWriter)	Write a Map of K-type keys to V-type.
<K,V> void	writeMapValues(Map<K,V> map, Writeable.Writer<V> valueWriter)
void	writeOptionalStringCollection(Collection<String> collection)	Writes an optional collection of a strings.
void	writeStringArray(String[] array)
void	writeStringCollection(Collection<String> collection)	Writes a collection of a strings.
void	writeVLongArray(long[] values)

Methods inherited from class org.opensearch.core.common.io.stream.StreamOutput

checkWriteable, failOnTooManyNestedExceptions, getFeatures, getVersion, getWriter, hasFeature, position, seek, setFeatures, setVersion, write, write, writeArray, writeArray, writeBigInteger, writeBoolean, writeBuild, writeByteArray, writeBytes, writeBytes, writeBytesRef, writeBytesReference, writeCollection, writeDouble, writeDoubleArray, writeEnum, writeEnumSet, writeException, writeFloat, writeFloatArray, writeGenericValue, writeInstant, writeInt, writeIntArray, writeList, writeLong, writeLongArray, writeMapOfLists, writeMapWithConsistentOrder, writeNamedWriteable, writeNamedWriteableList, writeOptionalArray, writeOptionalArray, writeOptionalBoolean, writeOptionalBytesReference, writeOptionalDouble, writeOptionalEnumSet, writeOptionalFloat, writeOptionalInstant, writeOptionalInt, writeOptionalLong, writeOptionalNamedWriteable, writeOptionalSecureString, writeOptionalString, writeOptionalStringArray, writeOptionalText, writeOptionalTimeValue, writeOptionalVInt, writeOptionalVLong, writeOptionalWriteable, writeOptionalWriteable, writeOptionalZoneId, writeSecureString, writeSemverRange, writeShort, writeString, writeStringArrayNullable, writeText, writeTimeValue, writeVersion, writeVInt, writeVIntArray, writeVLong, writeVLongNoCheck, writeZLong, writeZoneId

Methods inherited from class java.io.OutputStream

nullOutputStream, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BufferedChecksumStreamOutput

public BufferedChecksumStreamOutput(StreamOutput out)

Method Details

getChecksum

public long getChecksum()

writeByte

public void writeByte(byte b)
               throws IOException

Description copied from class: StreamOutput

Writes a single byte.

Specified by:

writeByte in class StreamOutput

Throws:

IOException

writeBytes

public void writeBytes(byte[] b,
 int offset,
 int length)
                throws IOException

Description copied from class: StreamOutput

Writes an array of bytes.

Specified by:

writeBytes in class StreamOutput

Parameters:

b - the bytes to write

offset - the offset in the byte array

length - the number of bytes to write

Throws:

IOException

flush

public void flush()
           throws IOException

Description copied from class: StreamOutput

Forces any buffered output to be written.

Specified by:

flush in interface Flushable

Specified by:

flush in class StreamOutput

Throws:

IOException

close

public void close()
           throws IOException

Description copied from class: StreamOutput

Closes this stream to further operations.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class StreamOutput

Throws:

IOException

reset

public void reset()
           throws IOException

Specified by:

reset in class StreamOutput

Throws:

IOException

resetDigest

public void resetDigest()

writeMap

public void writeMap(@Nullable
 Map<String,Object> map)
              throws IOException

Overrides:

writeMap in class StreamOutput

Throws:

IOException

writeMap

public <K,V> void writeMap(Map<K,V> map,
 Writeable.Writer<K> keyWriter,
 Writeable.Writer<V> valueWriter)
                    throws IOException

Description copied from class: StreamOutput

Write a Map of K-type keys to V-type.

 Map<String, String> map = ...;
 out.writeMap(map, StreamOutput::writeString, StreamOutput::writeString);
 

Overrides:

writeMap in class StreamOutput

Parameters:

keyWriter - The key writer

valueWriter - The value writer

Throws:

IOException

writeMapValues

public <K,V> void writeMapValues(Map<K,V> map,
 Writeable.Writer<V> valueWriter)
                          throws IOException

Throws:

IOException

writeStringArray

public void writeStringArray(String[] array)
                      throws IOException

Overrides:

writeStringArray in class StreamOutput

Throws:

IOException

writeVLongArray

public void writeVLongArray(long[] values)
                     throws IOException

Overrides:

writeVLongArray in class StreamOutput

Throws:

IOException

writeCollection

public void writeCollection(Collection<? extends Writeable> collection)
                     throws IOException

Description copied from class: StreamOutput

Writes a collection to this stream. The corresponding collection can be read from a stream input using StreamInput.readList(Writeable.Reader).

Overrides:

writeCollection in class StreamOutput

Parameters:

collection - the collection to write to this stream

Throws:

IOException - if an I/O exception occurs writing the collection

writeStringCollection

public void writeStringCollection(Collection<String> collection)
                           throws IOException

Description copied from class: StreamOutput

Writes a collection of a strings. The corresponding collection can be read from a stream input using StreamInput.readList(Writeable.Reader).

Overrides:

writeStringCollection in class StreamOutput

Parameters:

collection - the collection of strings

Throws:

IOException - if an I/O exception occurs writing the collection

writeOptionalStringCollection

public void writeOptionalStringCollection(Collection<String> collection)
                                   throws IOException

Description copied from class: StreamOutput

Writes an optional collection of a strings. The corresponding collection can be read from a stream input using StreamInput.readList(Writeable.Reader).

Overrides:

writeOptionalStringCollection in class StreamOutput

Parameters:

collection - the collection of strings

Throws:

IOException - if an I/O exception occurs writing the collection