org.elasticsearch.common.io.stream

Class BytesStreamOutput

java.lang.Object

java.io.OutputStream

org.elasticsearch.common.io.stream.StreamOutput

org.elasticsearch.common.io.stream.BytesStreamOutput

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, BytesStream

Direct Known Subclasses:

ReleasableBytesStreamOutput

public class BytesStreamOutput
extends StreamOutput
implements BytesStream

A @link StreamOutput that uses BigArrays to acquire pages of bytes, which avoids frequent reallocation & copying of the internal data.

Field Summary

Fields

Modifier and Type	Field and Description
protected BigArrays	bigarrays
protected ByteArray	bytes
protected int	count

Constructor Summary

Constructors

Modifier	Constructor and Description
	BytesStreamOutput() Create a non recycling BytesStreamOutput with an initial capacity of 0.
	BytesStreamOutput(int expectedSize) Create a non recycling BytesStreamOutput with enough initial pages acquired to satisfy the capacity given by expected size.
protected	BytesStreamOutput(int expectedSize, BigArrays bigarrays)

Method Summary

Modifier and Type	Method and Description
BytesReference	bytes()
void	close() Closes this stream to further operations.
void	flush() Forces any buffered output to be written.
long	position()
long	ramBytesUsed() Returns the number of bytes used by the underlying ByteArray
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.

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

getVersion, setVersion, write, write, writeBoolean, writeByteArray, writeBytes, writeBytes, writeBytesRef, writeBytesReference, writeDouble, writeDoubleArray, writeFloat, writeFloatArray, writeGenericValue, writeGeoPoint, writeInt, writeIntArray, writeList, writeLong, writeLongArray, writeMap, writeOptionalBoolean, writeOptionalStreamable, writeOptionalString, writeOptionalText, writeOptionalVInt, writeShort, writeString, writeStringArray, writeStringArrayNullable, writeTaskStatus, writeText, writeThrowable, writeVInt, writeVIntArray, writeVLong, writeVLongArray

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

Field Detail

bigarrays

protected final BigArrays bigarrays

bytes

protected ByteArray bytes

count

protected int count

Constructor Detail

BytesStreamOutput

public BytesStreamOutput()

Create a non recycling BytesStreamOutput with an initial capacity of 0.

BytesStreamOutput

public BytesStreamOutput(int expectedSize)

Create a non recycling BytesStreamOutput with enough initial pages acquired to satisfy the capacity given by expected size.

Parameters:

expectedSize - the expected maximum size of the stream in bytes.

BytesStreamOutput

protected BytesStreamOutput(int expectedSize,
                            BigArrays bigarrays)

Method Detail

position

public long position()
              throws IOException

Overrides:

position in class StreamOutput

Throws:

IOException

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

reset

public void reset()

Specified by:

reset in class StreamOutput

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

seek

public void seek(long position)
          throws IOException

Overrides:

seek in class StreamOutput

Throws:

IOException

skip

public void skip(int length)

close

public void close()
           throws IOException

Description copied from class: StreamOutput

Closes this stream to further operations.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class StreamOutput

Throws:

IOException

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.count

bytes

public BytesReference bytes()

Specified by:

bytes in interface BytesStream

ramBytesUsed

public long ramBytesUsed()

Returns the number of bytes used by the underlying ByteArray

See Also:

Accountable.ramBytesUsed()