Package org.bson

Class BsonDocumentReader

java.lang.Object

org.bson.AbstractBsonReader

org.bson.BsonDocumentReader

All Implemented Interfaces:

Closeable, AutoCloseable, BsonReader

public class BsonDocumentReader
extends AbstractBsonReader

A BsonReader implementation that reads from an instance of BsonDocument. This can be used to decode a BsonDocument using a Decoder.

Since:

3.0

See Also:

• BsonDocument
• Decoder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	BsonDocumentReader.Context	An implementation of AbstractBsonReader.Context.
protected class	BsonDocumentReader.Mark	An implementation of AbstractBsonReader.Mark.

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

AbstractBsonReader.State

Constructor Summary

Constructors

Constructor	Description
BsonDocumentReader(BsonDocument document)	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
protected int	doPeekBinarySize()	Handles the logic to peek at the binary size.
protected byte	doPeekBinarySubType()	Handles the logic to peek at the binary subtype.
protected BsonBinary	doReadBinaryData()	Handles the logic to read binary data
protected boolean	doReadBoolean()	Handles the logic to read booleans
protected long	doReadDateTime()	Handles the logic to read date time
protected BsonDbPointer	doReadDBPointer()	Handles the logic to read a DBPointer
Decimal128	doReadDecimal128()	Handles the logic to read Decimal128
protected double	doReadDouble()	Handles the logic to read doubles
protected void	doReadEndArray()	Handles the logic when reading the end of an array
protected void	doReadEndDocument()	Handles the logic when reading the end of a document
protected int	doReadInt32()	Handles the logic to read 32 bit ints
protected long	doReadInt64()	Handles the logic to read 64 bit ints
protected String	doReadJavaScript()	Handles the logic to read JavaScript functions
protected String	doReadJavaScriptWithScope()	Handles the logic to read scoped JavaScript functions
protected void	doReadMaxKey()	Handles the logic to read a Max key
protected void	doReadMinKey()	Handles the logic to read a Min key
protected void	doReadNull()	Handles the logic to read a null value
protected ObjectId	doReadObjectId()	Handles the logic to read an ObjectId
protected BsonRegularExpression	doReadRegularExpression()	Handles the logic to read a regular expression
protected void	doReadStartArray()	Handles the logic to read the start of an array
protected void	doReadStartDocument()	Handles the logic to read the start of a document
protected String	doReadString()	Handles the logic to read a String
protected String	doReadSymbol()	Handles the logic to read a Symbol
protected BsonTimestamp	doReadTimestamp()	Handles the logic to read a timestamp
protected void	doReadUndefined()	Handles the logic to read an Undefined value
protected void	doSkipName()	Handles any logic required to skip the name (reader must be positioned on a name).
protected void	doSkipValue()	Handles any logic required to skip the value (reader must be positioned on a value).
protected BsonDocumentReader.Context	getContext()	Get the context, which will indicate which state the reader is in, for example which part of a document it's currently reading.
BsonReaderMark	getMark()	Gets a mark representing the current state of the reader.
BsonType	readBsonType()	Reads a BSONType from the reader.

Methods inherited from class org.bson.AbstractBsonReader

checkPreconditions, close, getCurrentBsonType, getCurrentName, getNextState, getState, isClosed, 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, setContext, setCurrentBsonType, setCurrentName, setState, skipName, skipValue, throwInvalidContextType, throwInvalidState, verifyBSONType, verifyName

Methods inherited from class java.lang.Object

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

Constructor Details

BsonDocumentReader

public BsonDocumentReader(BsonDocument document)

Construct a new instance.

Parameters:

document - the document to read from

Method Details

doReadBinaryData

protected BsonBinary doReadBinaryData()

Description copied from class: AbstractBsonReader

Handles the logic to read binary data

Specified by:

doReadBinaryData in class AbstractBsonReader

Returns:

the BsonBinary value

doPeekBinarySubType

protected byte doPeekBinarySubType()

Description copied from class: AbstractBsonReader

Handles the logic to peek at the binary subtype.

Specified by:

doPeekBinarySubType in class AbstractBsonReader

Returns:

the binary subtype

doPeekBinarySize

protected int doPeekBinarySize()

Description copied from class: AbstractBsonReader

Handles the logic to peek at the binary size.

Specified by:

doPeekBinarySize in class AbstractBsonReader

Returns:

the binary size

doReadBoolean

protected boolean doReadBoolean()

Description copied from class: AbstractBsonReader

Handles the logic to read booleans

Specified by:

doReadBoolean in class AbstractBsonReader

Returns:

the boolean value

doReadDateTime

protected long doReadDateTime()

Description copied from class: AbstractBsonReader

Handles the logic to read date time

Specified by:

doReadDateTime in class AbstractBsonReader

Returns:

the long value

doReadDouble

protected double doReadDouble()

Description copied from class: AbstractBsonReader

Handles the logic to read doubles

Specified by:

doReadDouble in class AbstractBsonReader

Returns:

the double value

doReadEndArray

protected void doReadEndArray()

Description copied from class: AbstractBsonReader

Handles the logic when reading the end of an array

Specified by:

doReadEndArray in class AbstractBsonReader

doReadEndDocument

protected void doReadEndDocument()

Description copied from class: AbstractBsonReader

Handles the logic when reading the end of a document

Specified by:

doReadEndDocument in class AbstractBsonReader

doReadInt32

protected int doReadInt32()

Description copied from class: AbstractBsonReader

Handles the logic to read 32 bit ints

Specified by:

doReadInt32 in class AbstractBsonReader

Returns:

the int value

doReadInt64

protected long doReadInt64()

Description copied from class: AbstractBsonReader

Handles the logic to read 64 bit ints

Specified by:

doReadInt64 in class AbstractBsonReader

Returns:

the long value

doReadDecimal128

public Decimal128 doReadDecimal128()

Description copied from class: AbstractBsonReader

Handles the logic to read Decimal128

Specified by:

doReadDecimal128 in class AbstractBsonReader

Returns:

the Decimal128 value

doReadJavaScript

protected String doReadJavaScript()

Description copied from class: AbstractBsonReader

Handles the logic to read JavaScript functions

Specified by:

doReadJavaScript in class AbstractBsonReader

Returns:

the String value

doReadJavaScriptWithScope

protected String doReadJavaScriptWithScope()

Description copied from class: AbstractBsonReader

Handles the logic to read scoped JavaScript functions

Specified by:

doReadJavaScriptWithScope in class AbstractBsonReader

Returns:

the String value

doReadMaxKey

protected void doReadMaxKey()

Description copied from class: AbstractBsonReader

Handles the logic to read a Max key

Specified by:

doReadMaxKey in class AbstractBsonReader

doReadMinKey

protected void doReadMinKey()

Description copied from class: AbstractBsonReader

Handles the logic to read a Min key

Specified by:

doReadMinKey in class AbstractBsonReader

doReadNull

protected void doReadNull()

Description copied from class: AbstractBsonReader

Handles the logic to read a null value

Specified by:

doReadNull in class AbstractBsonReader

doReadObjectId

protected ObjectId doReadObjectId()

Description copied from class: AbstractBsonReader

Handles the logic to read an ObjectId

Specified by:

doReadObjectId in class AbstractBsonReader

Returns:

the ObjectId value

doReadRegularExpression

protected BsonRegularExpression doReadRegularExpression()

Description copied from class: AbstractBsonReader

Handles the logic to read a regular expression

Specified by:

doReadRegularExpression in class AbstractBsonReader

Returns:

the BsonRegularExpression value

doReadDBPointer

protected BsonDbPointer doReadDBPointer()

Description copied from class: AbstractBsonReader

Handles the logic to read a DBPointer

Specified by:

doReadDBPointer in class AbstractBsonReader

Returns:

the BsonDbPointer value

doReadStartArray

protected void doReadStartArray()

Description copied from class: AbstractBsonReader

Handles the logic to read the start of an array

Specified by:

doReadStartArray in class AbstractBsonReader

doReadStartDocument

protected void doReadStartDocument()

Description copied from class: AbstractBsonReader

Handles the logic to read the start of a document

Specified by:

doReadStartDocument in class AbstractBsonReader

doReadString

protected String doReadString()

Description copied from class: AbstractBsonReader

Handles the logic to read a String

Specified by:

doReadString in class AbstractBsonReader

Returns:

the String value

doReadSymbol

protected String doReadSymbol()

Description copied from class: AbstractBsonReader

Handles the logic to read a Symbol

Specified by:

doReadSymbol in class AbstractBsonReader

Returns:

the String value

doReadTimestamp

protected BsonTimestamp doReadTimestamp()

Description copied from class: AbstractBsonReader

Handles the logic to read a timestamp

Specified by:

doReadTimestamp in class AbstractBsonReader

Returns:

the BsonTimestamp value

doReadUndefined

protected void doReadUndefined()

Description copied from class: AbstractBsonReader

Handles the logic to read an Undefined value

Specified by:

doReadUndefined in class AbstractBsonReader

doSkipName

protected void doSkipName()

Description copied from class: AbstractBsonReader

Handles any logic required to skip the name (reader must be positioned on a name).

Specified by:

doSkipName in class AbstractBsonReader

doSkipValue

protected void doSkipValue()

Description copied from class: AbstractBsonReader

Handles any logic required to skip the value (reader must be positioned on a value).

Specified by:

doSkipValue in class AbstractBsonReader

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.

getMark

public BsonReaderMark getMark()

Description copied from interface: BsonReader

Gets a mark representing the current state of the reader.

Returns:

the mark

getContext

protected BsonDocumentReader.Context getContext()

Description copied from class: AbstractBsonReader

Get the context, which will indicate which state the reader is in, for example which part of a document it's currently reading.

Overrides:

getContext in class AbstractBsonReader

Returns:

the context