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

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()
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)
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()
byte[]	toByteArray() mostly for testing
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)
void	writeInt(int x)
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)
void	writeString(String str)

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()

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.

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()

Returns:

size of data so far

pipe

public abstract int pipe(OutputStream out)
                  throws IOException

Returns:

bytes written

Throws:

IOException

toByteArray

public byte[] toByteArray()

mostly for testing

asString

@Deprecated
public String asString()

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

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)

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)

writeDouble

public void writeDouble(double x)

writeString

public void writeString(String str)

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