BsonOutputStream (mongodb-async-driver 2.0.1 API)

java.lang.Object
- com.allanbank.mongodb.bson.io.BsonOutputStream

```
public class BsonOutputStream
extends Object
```
A wrapper for an OutputStream to handle writing BSON primitives.

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
Modifier and Type	Field and Description
`protected IOException`	`myError` Any thrown exceptions.
`protected OutputStream`	`myOutput` Output buffer for spooling the written document.
`protected StringEncoder`	`myStringEncoder` The encoder for strings.
`protected com.allanbank.mongodb.bson.io.WriteVisitor`	`myWriteVisitor` The visitor for writing BSON documents.
`static Charset`	`UTF8` UTF-8 Character set for encoding strings.

Constructor Summary

Constructors
Constructor and Description
`BsonOutputStream(OutputStream output)` Creates a new `BsonOutputStream`.
`BsonOutputStream(OutputStream output, StringEncoderCache cache)` Creates a new `BsonOutputStream`.

Method Summary

Methods
Modifier and Type	Method and Description
`IOException`	`getError()` Returns the I/O exception encountered by the visitor.
`int`	`getMaxCachedStringEntries()` Deprecated. The cache `StringEncoderCache` should be controlled directory. This method will be removed after the 2.1.0 release.
`int`	`getMaxCachedStringLength()` Deprecated. The cache `StringDecoderCache` should be controlled directory. This method will be removed after the 2.1.0 release.
`StringEncoder`	`getStringEncoder()` Returns the encoder value.
`boolean`	`hasError()` Returns true if the visitor had an I/O error.
`void`	`reset()` Clears any errors.
`void`	`setMaxCachedStringEntries(int maxCacheEntries)` Deprecated. The cache `StringEncoderCache` should be controlled directory. This method will be removed after the 2.1.0 release.
`void`	`setMaxCachedStringLength(int maxlength)` Deprecated. The cache `StringEncoderCache` should be controlled directory. This method will be removed after the 2.1.0 release.
`int`	`sizeOf(Document document)` Deprecated. Replaced with `Document.size()`. This method will be removed after the 2.2.0 release.
`int`	`sizeOfCString(String... strings)` Returns the size of the writing the `strings` as a c-string.
`int`	`sizeOfString(String string)` Returns the size of the writing the `string` as a string.
`void`	`writeByte(byte b)` Writes a single byte to the stream.
`void`	`writeBytes(byte[] data)` Writes a sequence of bytes to the under lying stream.
`protected void`	`writeBytes(byte[] data, int offset, int length)` Writes a sequence of bytes to the under lying stream.
`void`	`writeCString(String... strings)` Writes a "Cstring" to the stream.
`void`	`writeDocument(Document document)` Writes a BSON `Document` to the stream.
`void`	`writeInt(int value)` Write the integer value in little-endian byte order.
`void`	`writeLong(long value)` Write the long value in little-endian byte order.
`void`	`writeString(String string)` Writes a "string" to the stream.
`protected void`	`writeUtf8(String string)` Writes the string as a UTF-8 string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - UTF8
```
public static final Charset UTF8
```
    UTF-8 Character set for encoding strings.
  - myError
```
protected IOException myError
```
    Any thrown exceptions.
  - myOutput
```
protected final OutputStream myOutput
```
    Output buffer for spooling the written document.
  - myStringEncoder
```
protected final StringEncoder myStringEncoder
```
    The encoder for strings.
  - myWriteVisitor
```
protected final com.allanbank.mongodb.bson.io.WriteVisitor myWriteVisitor
```
    The visitor for writing BSON documents.
- Constructor Detail
  - BsonOutputStream
```
public BsonOutputStream(OutputStream output)
```
    Creates a new BsonOutputStream.
    
    Parameters:
    output - The underlying Stream to write to.
  - BsonOutputStream
```
public BsonOutputStream(OutputStream output,
                StringEncoderCache cache)
```
    Creates a new BsonOutputStream.
    
    Parameters:
    output - The underlying Stream to write to.
    cache - The cache for encoding string.
- Method Detail
  - getError
```
public IOException getError()
```
    Returns the I/O exception encountered by the visitor.
    
    Returns:
    The I/O exception encountered by the visitor.
  - getMaxCachedStringEntries
```
@Deprecated
public int getMaxCachedStringEntries()
```
    Deprecated. The cache StringEncoderCache should be controlled directory. This method will be removed after the 2.1.0 release.
    
    Returns the maximum number of strings that may have their encoded form cached.
    
    Returns:
    The maximum number of strings that may have their encoded form cached.
  - getMaxCachedStringLength
```
@Deprecated
public int getMaxCachedStringLength()
```
    Deprecated. The cache StringDecoderCache should be controlled directory. This method will be removed after the 2.1.0 release.
    
    Returns the maximum length for a string that the stream is allowed to cache.
    
    Returns:
    The maximum length for a string that the stream is allowed to cache.
  - getStringEncoder
```
public StringEncoder getStringEncoder()
```
    Returns the encoder value.
    
    Returns:
    The encoder value.
  - hasError
```
public boolean hasError()
```
    Returns true if the visitor had an I/O error.
    
    Returns:
    True if the visitor had an I/O error, false otherwise.
  - reset
```
public void reset()
```
    Clears any errors.
  - setMaxCachedStringEntries
```
@Deprecated
public void setMaxCachedStringEntries(int maxCacheEntries)
```
    Deprecated. The cache StringEncoderCache should be controlled directory. This method will be removed after the 2.1.0 release.
    
    Sets the value of maximum number of strings that may have their encoded form cached.
    
    Parameters:
    maxCacheEntries - The new value for the maximum number of strings that may have their encoded form cached.
  - setMaxCachedStringLength
```
@Deprecated
public void setMaxCachedStringLength(int maxlength)
```
    Deprecated. The cache StringEncoderCache should be controlled directory. This method will be removed after the 2.1.0 release.
    
    Sets the value of length for a string that the stream is allowed to cache to the new value. This can be used to stop a single long string from pushing useful values out of the cache.
    
    Parameters:
    maxlength - The new value for the length for a string that the encoder is allowed to cache.
  - sizeOf
```
@Deprecated
public int sizeOf(Document document)
```
    Deprecated. Replaced with Document.size(). This method will be removed after the 2.2.0 release.
    
    Returns the size of the writing the Document as a BSON document.
    
    Parameters:
    document - The document to determine the size of.
    
    Returns:
    The size of the writing Document as a BSON document.
  - sizeOfCString
```
public int sizeOfCString(String... strings)
```
    Returns the size of the writing the strings as a c-string.
    
    Parameters:
    strings - The 'C' strings to determine the size of.
    
    Returns:
    The size of the writing the strings as a c-string.
  - sizeOfString
```
public int sizeOfString(String string)
```
    Returns the size of the writing the string as a string.
    
    Parameters:
    string - The 'UTF8' string to determine the size of.
    
    Returns:
    The size of the writing the string as a string.
  - writeByte
```
public void writeByte(byte b)
```
    Writes a single byte to the stream.
    
    Parameters:
    b - The byte to write.
  - writeBytes
```
public void writeBytes(byte[] data)
```
    Writes a sequence of bytes to the under lying stream.
    
    Parameters:
    data - The bytes to write.
  - writeCString
```
public void writeCString(String... strings)
```
    Writes a "Cstring" to the stream.
    
    Parameters:
    strings - The CString to write. The strings are concatenated into a single CString value.
  - writeDocument
```
public void writeDocument(Document document)
                   throws IOException
```
    Writes a BSON Document to the stream.
    
    Parameters:
    document - The Document to write.
    
    Throws:
    
    IOException - On a failure writing the document.
  - writeInt
```
public void writeInt(int value)
```
    Write the integer value in little-endian byte order.
    
    Parameters:
    value - The integer to write.
  - writeLong
```
public void writeLong(long value)
```
    Write the long value in little-endian byte order.
    
    Parameters:
    value - The long to write.
  - writeString
```
public void writeString(String string)
```
    Writes a "string" to the stream.
    
    Parameters:
    string - The String to write.
  - writeBytes
```
protected void writeBytes(byte[] data,
              int offset,
              int length)
```
    Writes a sequence of bytes to the under lying stream.
    
    Parameters:
    data - The bytes to write.
    offset - The offset into the buffer to start writing data from.
    length - The number of bytes to write.
  - writeUtf8
```
protected void writeUtf8(String string)
```
    Writes the string as a UTF-8 string. This method handles the "normal/easy" cases and delegates to the full character set if things get complicated.
    
    Parameters:
    string - The string to encode.

Class BsonOutputStream

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UTF8

myError

myOutput

myStringEncoder

myWriteVisitor

Constructor Detail

BsonOutputStream

BsonOutputStream

Method Detail

getError

getMaxCachedStringEntries

getMaxCachedStringLength

getStringEncoder

hasError

reset

setMaxCachedStringEntries

setMaxCachedStringLength

sizeOf

sizeOfCString

sizeOfString

writeByte

writeBytes

writeCString

writeDocument

writeInt

writeLong

writeString

writeBytes

writeUtf8