org.bson

Class BsonBinaryReader

java.lang.Object

org.bson.AbstractBsonReader

org.bson.BsonBinaryReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, BsonReader

public class BsonBinaryReader
extends AbstractBsonReader

A BsonReader implementation that reads from a binary stream of data. This is the most commonly used implementation.

Since:

3.0

Nested Class Summary

Nested classes/interfaces inherited from class org.bson.AbstractBsonReader

AbstractBsonReader.State

Constructor Summary

Constructors

Constructor and Description
BsonBinaryReader(BsonInput bsonInput) Construct an instance.
BsonBinaryReader(java.nio.ByteBuffer byteBuffer) Construct an instance.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the reader.
Decimal128	doReadDecimal128() Handles the logic to read Decimal128
void	doReadStartArray() Handles the logic to read the start of an array
BsonInput	getBsonInput() Gets the BSON input backing this instance.
BsonReaderMark	getMark() Gets a mark representing the current state of the reader.
void	mark() Deprecated.
BsonType	readBsonType() Reads a BSONType from the reader.
void	reset() Deprecated.

Methods inherited from class org.bson.AbstractBsonReader

getCurrentBsonType, getCurrentName, getState, peekBinarySize, peekBinarySubType, readBinaryData, readBinaryData, readBoolean, readBoolean, readDateTime, readDateTime, readDBPointer, readDBPointer, readDecimal128, readDecimal128, readDouble, readDouble, readEndArray, readEndDocument, readInt32, readInt32, readInt64, readInt64, readJavaScript, readJavaScript, readJavaScriptWithScope, readJavaScriptWithScope, readMaxKey, readMaxKey, readMinKey, readMinKey, readName, readName, readNull, readNull, readObjectId, readObjectId, readRegularExpression, readRegularExpression, readStartArray, readStartDocument, readString, readString, readSymbol, readSymbol, readTimestamp, readTimestamp, readUndefined, readUndefined, skipName, skipValue

Methods inherited from class java.lang.Object

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

Constructor Detail

BsonBinaryReader

public BsonBinaryReader(java.nio.ByteBuffer byteBuffer)

Construct an instance.

Parameters:

byteBuffer - the input for this reader

BsonBinaryReader

public BsonBinaryReader(BsonInput bsonInput)

Construct an instance.

Parameters:

bsonInput - the input for this reader

Method Detail

close

public void close()

Description copied from class: AbstractBsonReader

Closes the reader.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface BsonReader

Overrides:

close in class AbstractBsonReader

getBsonInput

public BsonInput getBsonInput()

Gets the BSON input backing this instance.

Returns:

the BSON input

readBsonType

public BsonType readBsonType()

Description copied from interface: BsonReader

Reads a BSONType from the reader.

Specified by:

readBsonType in interface BsonReader

Specified by:

readBsonType in class AbstractBsonReader

Returns:

A BSONType.

doReadDecimal128

public Decimal128 doReadDecimal128()

Description copied from class: AbstractBsonReader

Handles the logic to read Decimal128

Returns:

the Decimal128 value

doReadStartArray

public void doReadStartArray()

Description copied from class: AbstractBsonReader

Handles the logic to read the start of an array

mark

@Deprecated
public void mark()

Deprecated.

Description copied from interface: BsonReader

Creates a bookmark in the BsonReader's input The previous mark must be cleared before creating a new one

getMark

public BsonReaderMark getMark()

Description copied from interface: BsonReader

Gets a mark representing the current state of the reader.

Returns:

the mark

reset

@Deprecated
public void reset()

Deprecated.

Description copied from interface: BsonReader

Go back to the state at the last mark and removes the mark