com.mongodb.connection

Class ByteBufferBsonOutput

java.lang.Object

java.io.OutputStream

org.bson.io.OutputBuffer

com.mongodb.connection.ByteBufferBsonOutput

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, BsonOutput

public class ByteBufferBsonOutput
extends OutputBuffer

This class should not be considered as part of the public API, and it may change or be removed at any time.

Field Summary

Fields

Modifier and Type	Field and Description
static int	INITIAL_BUFFER_SIZE
static int	MAX_BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
ByteBufferBsonOutput(BufferProvider bufferProvider) Construct an instance that uses the given buffer provider to allocate byte buffers as needs as it grows.

Method Summary

Modifier and Type	Method and Description
void	close()
List<ByteBuf>	getByteBuffers() Get a list of byte buffers that are prepared to be read from; in other words, whose position is 0 and whose limit is the number of bytes that should read.
int	getPosition() Gets the current position in the stream.
int	getSize() Gets the current size of the stream in number of bytes.
int	pipe(OutputStream out) Pipe the contents of this output buffer into the given output stream
void	truncateToPosition(int newPosition) Truncates this stream to the new position.
protected void	write(int absolutePosition, int value) Write the specified byte at the specified position.
void	writeByte(int value) Write a single byte to the stream.
void	writeBytes(byte[] bytes, int offset, int length) Writes length bytes from the byte array, starting at offset.

Methods inherited from class org.bson.io.OutputBuffer

size, toByteArray, toString, write, write, write, writeBytes, writeCString, writeDouble, writeInt, writeInt32, writeInt32, writeInt64, writeLong, writeObjectId, writeString

Methods inherited from class java.io.OutputStream

flush

Methods inherited from class java.lang.Object

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

Field Detail

INITIAL_BUFFER_SIZE

public static final int INITIAL_BUFFER_SIZE

See Also:

Constant Field Values

MAX_BUFFER_SIZE

public static final int MAX_BUFFER_SIZE

See Also:

Constant Field Values

Constructor Detail

ByteBufferBsonOutput

public ByteBufferBsonOutput(BufferProvider bufferProvider)

Construct an instance that uses the given buffer provider to allocate byte buffers as needs as it grows.

Parameters:

bufferProvider - the non-null buffer provider

Method Detail

writeBytes

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

Description copied from interface: BsonOutput

Writes length bytes from the byte array, starting at offset.

Parameters:

bytes - the non-null byte array

offset - the offset to start writing from

length - the number of bytes to write

writeByte

public void writeByte(int value)

Description copied from interface: BsonOutput

Write a single byte to the stream. The byte to be written is the eight low-order bits of the specified value. The 24 high-order bits of the value are ignored.

Parameters:

value - the value

getPosition

public int getPosition()

Description copied from interface: BsonOutput

Gets the current position in the stream.

Returns:

the current position

getSize

public int getSize()

Description copied from interface: BsonOutput

Gets the current size of the stream in number of bytes.

Returns:

the size of the stream

write

protected void write(int absolutePosition,
                     int value)

Description copied from class: OutputBuffer

Write the specified byte at the specified position.

Specified by:

write in class OutputBuffer

Parameters:

absolutePosition - the position, which must be greater than equal to 0 and at least 4 less than the stream size

value - the value to write. The 24 high-order bits of the value are ignored.

getByteBuffers

public List<ByteBuf> getByteBuffers()

Description copied from class: OutputBuffer

Get a list of byte buffers that are prepared to be read from; in other words, whose position is 0 and whose limit is the number of bytes that should read.

Note that the byte buffers may be read-only.

Specified by:

getByteBuffers in class OutputBuffer

Returns:

the non-null list of byte buffers.

pipe

public int pipe(OutputStream out)
         throws IOException

Description copied from class: OutputBuffer

Pipe the contents of this output buffer into the given output stream

Specified by:

pipe in class OutputBuffer

Parameters:

out - the stream to pipe to

Returns:

number of bytes written to the stream

Throws:

IOException - if the stream throws an exception

truncateToPosition

public void truncateToPosition(int newPosition)

Description copied from interface: BsonOutput

Truncates this stream to the new position. After this call, both size and position will equal the new position.

Specified by:

truncateToPosition in interface BsonOutput

Specified by:

truncateToPosition in class OutputBuffer

Parameters:

newPosition - the new position, which must be greater than or equal to 0 and less than the current size.

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface BsonOutput

Overrides:

close in class OutputBuffer