Package org.elasticsearch.common.io.stream

Class RecyclerBytesStreamOutput

java.lang.Object

java.io.OutputStream

org.elasticsearch.common.io.stream.StreamOutput

org.elasticsearch.common.io.stream.BytesStream

org.elasticsearch.common.io.stream.RecyclerBytesStreamOutput

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, org.elasticsearch.core.Releasable

public class RecyclerBytesStreamOutput
extends BytesStream
implements org.elasticsearch.core.Releasable

A @link StreamOutput that uses Recycler.V<org.apache.lucene.util.BytesRef> to acquire pages of bytes, which avoids frequent reallocation & copying of the internal data. When close() is called, the bytes will be released.

Constructor Summary

Constructors

Constructor	Description
RecyclerBytesStreamOutput(Recycler<org.apache.lucene.util.BytesRef> recycler)

Method Summary

Modifier and Type	Method	Description
BytesReference	bytes()
void	close()	Closes this stream to further operations.
void	flush()	Forces any buffered output to be written.
long	position()
void	reset()
void	seek(long position)
int	size()	Returns the current size of the buffer.
void	skip(int length)
void	writeByte(byte b)	Writes a single byte.
void	writeBytes(byte[] b, int offset, int length)	Writes an array of bytes.
void	writeInt(int i)	Writes an int as four bytes.
void	writeLong(long i)	Writes a long as eight bytes.
void	writeWithSizePrefix(Writeable writeable)	Serializes a writable just like Writeable.writeTo(StreamOutput) would but prefixes it with the serialized size of the result.

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

checkWriteable, getVersion, setVersion, write, write, writeArray, writeArray, writeBoolean, writeByteArray, writeBytes, writeBytes, writeBytesRef, writeBytesReference, writeCollection, writeCollection, writeDouble, writeDoubleArray, writeEnum, writeEnumSet, writeException, writeFloat, writeFloatArray, writeGenericList, writeGenericMap, writeGenericNull, writeGenericString, writeGenericValue, writeGeoPoint, writeInstant, writeIntArray, writeList, writeLongArray, writeMap, writeMap, writeMapOfLists, writeMapValues, writeMapValues, writeMapWithConsistentOrder, writeMissingString, writeMissingWriteable, writeNamedWriteable, writeNamedWriteableList, writeOptionalArray, writeOptionalArray, writeOptionalBoolean, writeOptionalBytesReference, writeOptionalDouble, writeOptionalEnum, writeOptionalFloat, writeOptionalInstant, writeOptionalInt, writeOptionalLong, writeOptionalNamedWriteable, writeOptionalSecureString, writeOptionalString, writeOptionalStringArray, writeOptionalStringCollection, writeOptionalText, writeOptionalTimeValue, writeOptionalVInt, writeOptionalVLong, writeOptionalWriteable, writeOptionalZoneId, writeSecureString, writeShort, writeString, writeStringArray, writeStringArrayNullable, writeStringCollection, writeText, writeTimeValue, 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 Details

RecyclerBytesStreamOutput

public RecyclerBytesStreamOutput(Recycler<org.apache.lucene.util.BytesRef> recycler)

Method Details

position

public long position()

Overrides:

position in class StreamOutput

writeByte

public void writeByte(byte b)

Description copied from class: StreamOutput

Writes a single byte.

Specified by:

writeByte in class StreamOutput

writeBytes

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

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

writeInt

public void writeInt(int i)
              throws IOException

Description copied from class: StreamOutput

Writes an int as four bytes.

Overrides:

writeInt in class StreamOutput

Throws:

IOException

writeLong

public void writeLong(long i)
               throws IOException

Description copied from class: StreamOutput

Writes a long as eight bytes.

Overrides:

writeLong in class StreamOutput

Throws:

IOException

writeWithSizePrefix

public void writeWithSizePrefix(Writeable writeable)
                         throws IOException

Description copied from class: StreamOutput

Serializes a writable just like Writeable.writeTo(StreamOutput) would but prefixes it with the serialized size of the result.

Overrides:

writeWithSizePrefix in class StreamOutput

Parameters:

writeable - Writeable to serialize

Throws:

IOException

reset

public void reset()

Specified by:

reset in class StreamOutput

flush

public void flush()

Description copied from class: StreamOutput

Forces any buffered output to be written.

Specified by:

flush in interface Flushable

Specified by:

flush in class StreamOutput

seek

public void seek(long position)

Overrides:

seek in class StreamOutput

skip

public void skip(int length)

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 org.elasticsearch.core.Releasable

Specified by:

close in class StreamOutput

size

public int size()

Returns the current size of the buffer.

Returns:

the value of the count field, which is the number of valid bytes in this output stream.

See Also:

• ByteArrayOutputStream.size()

bytes

public BytesReference bytes()

Specified by:

bytes in class BytesStream