org.bson.io

Class BasicOutputBuffer

java.lang.Object

java.io.OutputStream

org.bson.io.OutputBuffer

org.bson.io.BasicOutputBuffer

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class BasicOutputBuffer
extends OutputBuffer

A BSON output stream that stores the output in a single, un-pooled byte array.

Constructor Summary

Constructors

Constructor and Description
BasicOutputBuffer()

Method Summary

Modifier and Type	Method and Description
String	asString() Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.
String	asString(String encoding) Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.
int	getPosition() Gets the current position in the stream.
int	pipe(DataOutput out) Deprecated.
int	pipe(OutputStream out) Pipe the contents of this output buffer into the given output stream
void	seekEnd() Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.
void	seekStart() Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.
void	setPosition(int position) Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.
int	size() Gets the output size in bytes.
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class org.bson.io.OutputBuffer

backpatchSize, backpatchSize, hex, md5, toByteArray, toString, truncateToPosition, writeCString, writeDouble, writeInt, writeInt, writeIntBE, writeLong, writeString

Methods inherited from class java.io.OutputStream

close, flush

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicOutputBuffer

public BasicOutputBuffer()

Method Detail

write

public void write(byte[] b)

Specified by:

write in class OutputBuffer

write

public void write(byte[] b,
                  int off,
                  int len)

Specified by:

write in class OutputBuffer

write

public void write(int b)

Specified by:

write in class OutputBuffer

getPosition

public int getPosition()

Description copied from class: OutputBuffer

Gets the current position in the stream.

Specified by:

getPosition in class OutputBuffer

Returns:

the current position

setPosition

@Deprecated
public void setPosition(int position)

Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.

Specified by:

setPosition in class OutputBuffer

Parameters:

position - the position to set

seekEnd

@Deprecated
public void seekEnd()

Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.

Specified by:

seekEnd in class OutputBuffer

seekStart

@Deprecated
public void seekStart()

Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.

Specified by:

seekStart in class OutputBuffer

size

public int size()

Description copied from class: OutputBuffer

Gets the output size in bytes.

Specified by:

size in class OutputBuffer

Returns:

the size

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

pipe

@Deprecated
public int pipe(DataOutput out)
                     throws IOException

Deprecated.

Pipe the contents of this output buffer into the given DataOutput

Parameters:

out - the DataOutput to pipe to

Returns:

number of bytes written to the stream

Throws:

IOException - if the stream throws an exception

asString

@Deprecated
public String asString()

Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.

Overrides:

asString in class OutputBuffer

Returns:

the underlying byte array as a string

asString

@Deprecated
public String asString(String encoding)
                            throws UnsupportedEncodingException

Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.

Overrides:

asString in class OutputBuffer

Throws:

UnsupportedEncodingException