org.bson

Class BasicBSONDecoder

java.lang.Object

org.bson.BasicBSONDecoder

All Implemented Interfaces:

BSONDecoder

Direct Known Subclasses:

DefaultDBDecoder

public class BasicBSONDecoder
extends Object
implements BSONDecoder

Basic implementation of BSONDecoder interface that creates BasicBSONObject instances

Migration instructions

In driver versions before 2.12 BasicBSONDecoder exposed several protected members to its subclasses:

Fields:

• protected BSONInput _in
• protected BSONCallback _callback
• protected int _len
• protected int _pos

Methods:

• protected void _binary(String)

Nested Classes:

• protected class BSONInput

Solution 1: Custom BSONCallback implementation

With callbacks you can handle the process of creating objects from bytes in BSON format.

For example to get away from overriging BasicBSONDecoder._binary(String) you can use the following piece of code:

public class CustomBSONCallback extends BasicBSONCallback {
         public void gotBinary(String name, byte type, byte[] data) {
             _put(name,toHex(data));
         }
         private static String toHex(byte[] bytes) {...}
     }
 

This solution covers majority of the cases.

Solution 2: Custom BSONDecoder implementation

If you need to customize byte-level decoding at the lowest layer you have to provide you own implementation of the BSONDecoder interface.

Please check http://bsonspec.org/ for more information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BasicBSONDecoder.BSONInput Deprecated. This class should not be a part of API. Please see the class-level documentation for a migration instructions.

Field Summary

Fields

Modifier and Type	Field and Description
protected BSONCallback	_callback Deprecated. This field should not be a part of API. Please see the class-level documentation for a migration instructions.
protected BasicBSONDecoder.BSONInput	_in Deprecated. This field should not be a part of API. Please see the class-level documentation for a migration instructions.
protected int	_len Deprecated. This field should not be a part of API. Please see the class-level documentation for a migration instructions.
protected int	_pos Deprecated. This field should not be a part of API. Please see the class-level documentation for a migration instructions.

Constructor Summary

Constructors

Constructor and Description
BasicBSONDecoder()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	_binary(String name) Deprecated. This method should not be a part of API. Please see the class-level documentation for a migration instructions.
int	decode(byte[] b, BSONCallback callback) Decode a single BSON object into the given callback from the given byte array.
int	decode(InputStream in, BSONCallback callback) Decode a single BSON object into the given callback from the given input stream.
BSONObject	readObject(byte[] b) Read a single BSON object from the given bytes.
BSONObject	readObject(InputStream in) Read a single BSON object from the given input stream.

Methods inherited from class java.lang.Object

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

Field Detail

_in

@Deprecated
protected BasicBSONDecoder.BSONInput _in

Deprecated. This field should not be a part of API. Please see the class-level documentation for a migration instructions.

_callback

@Deprecated
protected BSONCallback _callback

Deprecated. This field should not be a part of API. Please see the class-level documentation for a migration instructions.

_pos

@Deprecated
protected int _pos

Deprecated. This field should not be a part of API. Please see the class-level documentation for a migration instructions.

_len

@Deprecated
protected int _len

Deprecated. This field should not be a part of API. Please see the class-level documentation for a migration instructions.

Constructor Detail

BasicBSONDecoder

public BasicBSONDecoder()

Method Detail

readObject

public BSONObject readObject(byte[] b)

Description copied from interface: BSONDecoder

Read a single BSON object from the given bytes.

Specified by:

readObject in interface BSONDecoder

Parameters:

b - the bytes in BSON format

Returns:

the BSON object for the given bytes

readObject

public BSONObject readObject(InputStream in)
                      throws IOException

Description copied from interface: BSONDecoder

Read a single BSON object from the given input stream.

Specified by:

readObject in interface BSONDecoder

Parameters:

in - the input stream in BSON format

Returns:

the BSON object for the given bytes

Throws:

IOException - if there's a problem reading the object from the InputStream

decode

public int decode(byte[] b,
         BSONCallback callback)

Description copied from interface: BSONDecoder

Decode a single BSON object into the given callback from the given byte array.

Specified by:

decode in interface BSONDecoder

Parameters:

b - the bytes in BSON format

callback - the callback

Returns:

the number of bytes in the BSON object

decode

public int decode(InputStream in,
         BSONCallback callback)
           throws IOException

Description copied from interface: BSONDecoder

Decode a single BSON object into the given callback from the given input stream.

Specified by:

decode in interface BSONDecoder

Parameters:

in - the input stream in BSON format

callback - the callback

Returns:

the number of bytes read from the input stream

Throws:

IOException - if there's a problem reading from the InputStream

_binary

@Deprecated
protected void _binary(String name)
                throws IOException

Deprecated. This method should not be a part of API. Please see the class-level documentation for a migration instructions.

Parameters:

name - the field name

Throws:

IOException