org.bson.io

Class OutputBuffer

java.lang.Object

java.io.OutputStream

org.bson.io.OutputBuffer

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

BasicOutputBuffer, PoolOutputBuffer

public abstract class OutputBuffer
extends OutputStream

An abstract base class for classes implementing BsonOutput.

Constructor Summary

Constructors

Constructor and Description
OutputBuffer()

Method Summary

Methods

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.
void	backpatchSize(int size) Backpatches the size of a document or string by writing the size into the four bytes starting at getPosition() - size.
protected void	backpatchSize(int size, int additionalOffset) Backpatches the size of a document or string by writing the size into the four bytes starting at getPosition() - size - additionalOffset.
abstract int	getPosition() Gets the current position in the stream.
String	hex() Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.
String	md5() Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.
abstract int	pipe(OutputStream out) Pipe the contents of this output buffer into the given output stream
abstract void	seekEnd() Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.
abstract void	seekStart() Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.
abstract void	setPosition(int position) Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.
abstract int	size() Gets the output size in bytes.
byte[]	toByteArray() Gets a copy of the buffered bytes.
String	toString()
void	truncateToPosition(int newPosition) Truncates the buffer to the given new position, which must be greater than or equal to zero and less than or equal to the current size of this buffer.
abstract void	write(byte[] b)
abstract void	write(byte[] b, int off, int len)
abstract void	write(int b)
int	writeCString(String str) Writes C string (null-terminated string) to underlying buffer.
void	writeDouble(double x) Writes a BSON double to the stream.
void	writeInt(int x) Writes the given integer value to the buffer.
void	writeInt(int pos, int x) Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.
void	writeIntBE(int x) Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.
void	writeLong(long x) Writes the given long value to the buffer.
void	writeString(String str) Writes a BSON String to the stream.

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

OutputBuffer

public OutputBuffer()

Method Detail

write

public abstract void write(byte[] b)

Overrides:

write in class OutputStream

write

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

Overrides:

write in class OutputStream

write

public abstract void write(int b)

Specified by:

write in class OutputStream

getPosition

public abstract int getPosition()

Gets the current position in the stream.

Returns:

the current position

setPosition

@Deprecated
public abstract void setPosition(int position)

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

Parameters:

position - the position to set

seekEnd

@Deprecated
public abstract void seekEnd()

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

seekStart

@Deprecated
public abstract void seekStart()

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

size

public abstract int size()

Gets the output size in bytes.

Returns:

the size

pipe

public abstract int pipe(OutputStream out)
                  throws IOException

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

Parameters:

out - the stream to pipe to

Returns:

number of bytes written to the stream

Throws:

IOException - if the stream throws an exception

toByteArray

public byte[] toByteArray()

Gets a copy of the buffered bytes.

Returns:

the byte array

See Also:

pipe(java.io.OutputStream)

asString

@Deprecated
public String asString()

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

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.

Throws:

UnsupportedEncodingException

hex

@Deprecated
public String hex()

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

md5

@Deprecated
public String md5()

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

writeInt

public void writeInt(int x)

Writes the given integer value to the buffer.

Parameters:

x - the value to write

writeIntBE

@Deprecated
public void writeIntBE(int x)

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

writeInt

@Deprecated
public void writeInt(int pos,
                       int x)

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

writeLong

public void writeLong(long x)

Writes the given long value to the buffer.

Parameters:

x - the value to write

writeDouble

public void writeDouble(double x)

Writes a BSON double to the stream.

Parameters:

x - the value

writeString

public void writeString(String str)

Writes a BSON String to the stream.

Parameters:

str - the value

writeCString

public int writeCString(String str)

Writes C string (null-terminated string) to underlying buffer.

Parameters:

str - the string

Returns:

number of bytes written

toString

public String toString()

Overrides:

toString in class Object

backpatchSize

public void backpatchSize(int size)

Backpatches the size of a document or string by writing the size into the four bytes starting at getPosition() - size.

Parameters:

size - the size of the document/string

backpatchSize

protected void backpatchSize(int size,
                 int additionalOffset)

Backpatches the size of a document or string by writing the size into the four bytes starting at getPosition() - size - additionalOffset.

Parameters:

size - the size of the document/string

additionalOffset - the offset from the current position to write the size

truncateToPosition

public void truncateToPosition(int newPosition)

Truncates the buffer to the given new position, which must be greater than or equal to zero and less than or equal to the current size of this buffer.

Parameters:

newPosition - the position to truncate this buffer to