com.allanbank.mongodb.bson.io

Class BufferingBsonOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

com.allanbank.mongodb.bson.io.BufferingBsonOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class BufferingBsonOutputStream
extends FilterOutputStream

BufferingBsonOutputStream provides a class to write BSON documents based on the BSON specification.

API Notice:

This class is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2011-2013, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
BufferingBsonOutputStream(OutputStream output) Creates a new BufferingBsonOutputStream.
BufferingBsonOutputStream(RandomAccessOutputStream output) Creates a new BufferingBsonOutputStream.

Method Summary

Methods

Modifier and Type	Method and Description
long	write(Document doc) Writes the Document in BSON format to the underlying stream.

Methods inherited from class java.io.FilterOutputStream

close, flush, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferingBsonOutputStream

public BufferingBsonOutputStream(OutputStream output)

Creates a new BufferingBsonOutputStream.

Parameters:

output - The stream to write to.

BufferingBsonOutputStream

public BufferingBsonOutputStream(RandomAccessOutputStream output)

Creates a new BufferingBsonOutputStream.

Parameters:

output - The stream to write to.

Method Detail

write

public long write(Document doc)
           throws IOException

Writes the Document in BSON format to the underlying stream.

Parameters:

doc - The document to write.

Returns:

The number of bytes written for the document.

Throws:

IOException - On a failure to write to the underlying document.