org.elasticsearch.common.io.stream

Class ReleasableBytesStreamOutput

java.lang.Object

java.io.OutputStream

org.elasticsearch.common.io.stream.StreamOutput

org.elasticsearch.common.io.stream.BytesStreamOutput

org.elasticsearch.common.io.stream.ReleasableBytesStreamOutput

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable, BytesStream, ReleasableBytesStream

public class ReleasableBytesStreamOutput
extends BytesStreamOutput
implements ReleasableBytesStream

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

Please note, its is the responsibility of the caller to make sure the bytes reference do not "escape" and are released only once.

Field Summary

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

bigArrays, bytes, count

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ReleasablePagedBytesReference	bytes()

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

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

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

getVersion, setVersion, write, write, writeArray, writeBoolean, writeByteArray, writeBytes, writeBytes, writeBytesRef, writeBytesReference, writeDouble, writeDoubleArray, writeException, writeFloat, writeFloatArray, writeGenericValue, writeGeoPoint, writeInt, writeIntArray, writeList, writeLong, writeLongArray, writeMap, writeMapOfLists, writeMapWithConsistentOrder, writeNamedWriteable, writeNamedWriteableList, writeOptionalArray, writeOptionalBoolean, writeOptionalBytesReference, writeOptionalDouble, writeOptionalFloat, writeOptionalLong, writeOptionalNamedWriteable, writeOptionalStreamable, writeOptionalString, writeOptionalStringArray, writeOptionalText, writeOptionalTimeZone, writeOptionalVInt, writeOptionalWriteable, writeShort, writeStreamableList, writeString, writeStringArray, writeStringArrayNullable, writeStringList, writeText, writeTimeZone, writeVInt, writeVIntArray, writeVLong, writeVLongArray, writeZLong

Methods inherited from class java.io.OutputStream

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()

Specified by:

bytes in interface BytesStream

Specified by:

bytes in interface ReleasableBytesStream

Overrides:

bytes in class BytesStreamOutput