Package org.elasticsearch.common.io.stream

Class ReleasableBytesStreamOutput

java.lang.Object

java.io.OutputStream

org.elasticsearch.common.io.stream.StreamOutput

org.elasticsearch.common.io.stream.BytesStream

org.elasticsearch.common.io.stream.BytesStreamOutput

org.elasticsearch.common.io.stream.ReleasableBytesStreamOutput

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, Releasable

public class ReleasableBytesStreamOutput
extends BytesStreamOutput
implements Releasable

An bytes stream output that allows providing a BigArrays instance expecting it to require releasing its content (bytes()) once done.

Please note, closing this stream will release the bytes that are in use by any ReleasablePagedBytesReference returned from bytes(), so this stream should only be closed after the bytes have been output or copied elsewhere.

Field Summary

Fields inherited from class org.elasticsearch.common.io.stream.BytesStreamOutput

bigArrays, bytes, count

Constructor Summary

Constructors

Constructor	Description
ReleasableBytesStreamOutput(int expectedSize, BigArrays bigArrays)
ReleasableBytesStreamOutput(BigArrays bigarrays)

Method Summary

Modifier and Type	Method	Description
ReleasablePagedBytesReference	bytes()	Returns a Releasable implementation of a BytesReference that represents the current state of the bytes in the stream.
void	close()	Closes this stream to further operations.
void	reset()

Methods inherited from class org.elasticsearch.common.io.stream.BytesStreamOutput

flush, position, ramBytesUsed, seek, size, skip, writeByte, writeBytes

Methods inherited from class org.elasticsearch.common.io.stream.StreamOutput

getVersion, hasFeature, setFeatures, setVersion, write, write, writeArray, writeArray, writeBoolean, writeByteArray, writeBytes, writeBytes, writeBytesRef, writeBytesReference, writeCollection, writeCollection, writeDouble, writeDoubleArray, writeEnum, writeEnumSet, writeException, writeFloat, writeFloatArray, writeGenericValue, writeGeoPoint, writeInstant, writeInt, writeIntArray, writeList, writeLong, writeLongArray, writeMap, writeMap, writeMapOfLists, writeMapWithConsistentOrder, writeNamedWriteable, writeNamedWriteableList, writeOptionalArray, writeOptionalArray, writeOptionalBoolean, writeOptionalBytesReference, writeOptionalDouble, writeOptionalFloat, writeOptionalInstant, writeOptionalInt, writeOptionalLong, writeOptionalNamedWriteable, writeOptionalSecureString, writeOptionalString, writeOptionalStringArray, writeOptionalText, writeOptionalTimeValue, writeOptionalTimeZone, writeOptionalVInt, writeOptionalWriteable, writeOptionalZoneId, writeSecureString, writeShort, writeString, writeStringArray, writeStringArrayNullable, writeStringCollection, writeText, writeTimeValue, writeTimeZone, writeVInt, writeVIntArray, writeVLong, writeVLongArray, 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 Detail

ReleasableBytesStreamOutput

public ReleasableBytesStreamOutput(BigArrays bigarrays)

ReleasableBytesStreamOutput

public ReleasableBytesStreamOutput(int expectedSize,
                                   BigArrays bigArrays)

Method Detail

bytes

public ReleasablePagedBytesReference bytes()

Returns a Releasable implementation of a BytesReference that represents the current state of the bytes in the stream.

Overrides:

bytes in class BytesStreamOutput

close

public void close()

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 interface Releasable

Overrides:

close in class BytesStreamOutput

reset

public void reset()

Overrides:

reset in class BytesStreamOutput