BsonParser (bson4jackson 2.13.1 API)

java.lang.Object
- com.fasterxml.jackson.core.JsonParser
- - com.fasterxml.jackson.core.base.ParserMinimalBase
  - - com.fasterxml.jackson.core.base.ParserBase
    - - de.undercouch.bson4jackson.BsonParser

All Implemented Interfaces:

com.fasterxml.jackson.core.Versioned, java.io.Closeable, java.lang.AutoCloseable
```
public class BsonParser
extends com.fasterxml.jackson.core.base.ParserBase
```
Reads a BSON document from the provided input stream

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`BsonParser.BsonLocation` Extends `JsonLocation` to offer a specialized string representation
`protected static class`	`BsonParser.Context` Information about the element currently begin parsed
`static class`	`BsonParser.Feature` Defines toggable features
`protected static class`	`BsonParser.State` Specifies what the parser is currently parsing (field name or value) or if it is done with the current element

Nested classes/interfaces inherited from class com.fasterxml.jackson.core.JsonParser
com.fasterxml.jackson.core.JsonParser.NumberType

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`_bsonFeatures` The features for this parser
`protected boolean`	`_closed` True if the parser has been closed
`protected com.fasterxml.jackson.core.ObjectCodec`	`_codec` The ObjectCodec used to parse the Bson object(s)
`protected CountingInputStream`	`_counter` Counts the number of bytes read from `_in`
`protected BsonParser.Context`	`_currentContext` The current parser state
`protected LittleEndianInputStream`	`_in` The input stream to read from
`protected java.io.InputStream`	`_rawInputStream` The raw input stream passed in
`protected int`	`_tokenPos` The position of the current token

Fields inherited from class com.fasterxml.jackson.core.base.ParserBase
_binaryValue, _byteArrayBuilder, _currInputProcessed, _currInputRow, _currInputRowStart, _expLength, _fractLength, _inputEnd, _inputPtr, _intLength, _ioContext, _nameCopied, _nameCopyBuffer, _nextToken, _numberBigDecimal, _numberBigInt, _numberDouble, _numberInt, _numberLong, _numberNegative, _numTypesValid, _parsingContext, _textBuffer, _tokenInputCol, _tokenInputRow, _tokenInputTotal, JSON_READ_CAPABILITIES

Fields inherited from class com.fasterxml.jackson.core.base.ParserMinimalBase
_currToken, _lastClearedToken, BD_MAX_INT, BD_MAX_LONG, BD_MIN_INT, BD_MIN_LONG, BI_MAX_INT, BI_MAX_LONG, BI_MIN_INT, BI_MIN_LONG, CHAR_NULL, INT_0, INT_9, INT_APOS, INT_ASTERISK, INT_BACKSLASH, INT_COLON, INT_COMMA, INT_CR, INT_e, INT_E, INT_HASH, INT_LBRACKET, INT_LCURLY, INT_LF, INT_MINUS, INT_PERIOD, INT_PLUS, INT_QUOTE, INT_RBRACKET, INT_RCURLY, INT_SLASH, INT_SPACE, INT_TAB, MAX_ERROR_TOKEN_LENGTH, MAX_INT_D, MAX_INT_L, MAX_LONG_D, MIN_INT_D, MIN_INT_L, MIN_LONG_D, NO_BYTES, NO_INTS, NR_BIGDECIMAL, NR_BIGINT, NR_DOUBLE, NR_FLOAT, NR_INT, NR_LONG, NR_UNKNOWN

Fields inherited from class com.fasterxml.jackson.core.JsonParser
_features, _requestPayload, DEFAULT_READ_CAPABILITIES

Constructor Summary

Constructors
Constructor and Description
`BsonParser(com.fasterxml.jackson.core.io.IOContext ctxt, int jsonFeatures, int bsonFeatures, java.io.InputStream in)` Constructs a new parser

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`_closeInput()`
`protected void`	`_finishString()`
`protected void`	`_handleEOF()`
`void`	`close()`
`java.math.BigInteger`	`getBigIntegerValue()`
`byte[]`	`getBinaryValue(com.fasterxml.jackson.core.Base64Variant b64variant)`
`com.fasterxml.jackson.core.ObjectCodec`	`getCodec()`
`protected BsonParser.Context`	`getContext()`
`byte`	`getCurrentBsonType()`
`com.fasterxml.jackson.core.JsonLocation`	`getCurrentLocation()`
`java.lang.String`	`getCurrentName()`
`java.math.BigDecimal`	`getDecimalValue()`
`double`	`getDoubleValue()`
`java.lang.Object`	`getEmbeddedObject()`
`float`	`getFloatValue()`
`int`	`getIntValue()`
`long`	`getLongValue()`
`com.fasterxml.jackson.core.JsonParser.NumberType`	`getNumberType()`
`java.lang.Number`	`getNumberValue()`
`java.lang.Number`	`getNumberValueExact()`
`java.lang.String`	`getText()`
`char[]`	`getTextCharacters()`
`int`	`getTextLength()`
`int`	`getTextOffset()`
`com.fasterxml.jackson.core.JsonLocation`	`getTokenLocation()`
`protected com.fasterxml.jackson.core.JsonToken`	`handleBinary()` Reads binary data from the input stream
`protected com.fasterxml.jackson.core.JsonToken`	`handleDBPointer()` Reads a DBPointer from the stream
`protected com.fasterxml.jackson.core.JsonToken`	`handleJavascriptWithScope()` Can be called when embedded javascript code with scope is found.
`protected com.fasterxml.jackson.core.JsonToken`	`handleNewDocument(boolean array)` Can be called when a new embedded document is found.
`protected com.fasterxml.jackson.core.JsonToken`	`handleRegEx()` Reads and compiles a regular expression
`boolean`	`hasTextCharacters()`
`boolean`	`isClosed()`
`protected boolean`	`isEnabled(BsonParser.Feature f)` Checks if a generator feature is enabled
`boolean`	`isExpectedStartArrayToken()`
`protected boolean`	`loadMore()`
`com.fasterxml.jackson.core.JsonToken`	`nextToken()`
`protected java.lang.String`	`readCString()`
`protected java.util.Map<java.lang.String,java.lang.Object>`	`readDocument()` Fully reads an embedded document, reusing this parser
`protected ObjectId`	`readObjectId()` Reads a ObjectID from the input stream
`protected java.lang.String`	`readString()` Reads a string that consists of a integer denoting the number of bytes, the bytes (including a terminating 0 byte)
`protected Symbol`	`readSymbol()` Reads a symbol object from the input stream
`protected Timestamp`	`readTimestamp()` Reads a timestamp object from the input stream
`protected int`	`regexStrToFlags(java.lang.String pattern)` Converts a BSON regex pattern string to a combined value of Java flags that can be used in `Pattern.compile(String, int)`
`void`	`setCodec(com.fasterxml.jackson.core.ObjectCodec c)`
`protected void`	`skipCString()` Skips over a null-terminated string in the input stream

Methods inherited from class com.fasterxml.jackson.core.base.ParserBase
_checkStdFeatureChanges, _contentReference, _decodeBase64Escape, _decodeBase64Escape, _decodeEscaped, _eofAsNextChar, _getByteArrayBuilder, _getSourceReference, _handleBase64MissingPadding, _handleUnrecognizedCharacterEscape, _parseIntValue, _parseNumericValue, _releaseBuffers, _reportMismatchedEndMarker, _reportTooLongIntegral, _throwUnquotedSpace, _validJsonTokenList, _validJsonValueList, convertNumberToBigDecimal, convertNumberToBigInteger, convertNumberToDouble, convertNumberToInt, convertNumberToLong, disable, enable, getCurrentValue, getParsingContext, getTokenCharacterOffset, getTokenColumnNr, getTokenLineNr, growArrayBy, isNaN, loadMoreGuaranteed, overrideCurrentName, overrideStdFeatures, reportInvalidBase64Char, reportInvalidBase64Char, reset, resetAsNaN, resetFloat, resetInt, setCurrentValue, setFeatureMask, version

Methods inherited from class com.fasterxml.jackson.core.base.ParserMinimalBase
_ascii, _asciiBytes, _constructError, _decodeBase64, _getCharDesc, _hasTextualNull, _longIntegerDesc, _longNumberDesc, _reportError, _reportError, _reportError, _reportInputCoercion, _reportInvalidEOF, _reportInvalidEOF, _reportInvalidEOF, _reportInvalidEOFInValue, _reportInvalidEOFInValue, _reportMissingRootWS, _reportUnexpectedChar, _throwInternal, _throwInvalidSpace, _wrapError, clearCurrentToken, currentToken, currentTokenId, getCurrentToken, getCurrentTokenId, getLastClearedToken, getValueAsBoolean, getValueAsDouble, getValueAsInt, getValueAsInt, getValueAsLong, getValueAsLong, getValueAsString, getValueAsString, hasCurrentToken, hasToken, hasTokenId, isExpectedNumberIntToken, isExpectedStartObjectToken, nextValue, reportInvalidNumber, reportOverflowInt, reportOverflowInt, reportOverflowInt, reportOverflowLong, reportOverflowLong, reportOverflowLong, reportUnexpectedNumberChar, skipChildren

Methods inherited from class com.fasterxml.jackson.core.JsonParser
_codec, _constructError, _constructReadException, _constructReadException, _constructReadException, _constructReadException, _constructReadException, _reportUnsupportedOperation, assignCurrentValue, canParseAsync, canReadObjectId, canReadTypeId, canUseSchema, configure, currentLocation, currentName, currentTokenLocation, currentValue, finishToken, getBinaryValue, getBooleanValue, getByteValue, getFeatureMask, getFormatFeatures, getInputSource, getNonBlockingInputFeeder, getObjectId, getReadCapabilities, getSchema, getShortValue, getText, getTypeId, getValueAsBoolean, getValueAsDouble, isEnabled, isEnabled, nextBooleanValue, nextFieldName, nextFieldName, nextIntValue, nextLongValue, nextTextValue, overrideFormatFeatures, readBinaryValue, readBinaryValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, releaseBuffered, requiresCustomCodec, setRequestPayloadOnError, setRequestPayloadOnError, setRequestPayloadOnError, setSchema

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

- Field Detail
  - _bsonFeatures
```
protected int _bsonFeatures
```
    The features for this parser
  - _in
```
protected LittleEndianInputStream _in
```
    The input stream to read from
  - _counter
```
protected CountingInputStream _counter
```
    Counts the number of bytes read from _in
  - _rawInputStream
```
protected java.io.InputStream _rawInputStream
```
    The raw input stream passed in
  - _closed
```
protected boolean _closed
```
    True if the parser has been closed
  - _codec
```
protected com.fasterxml.jackson.core.ObjectCodec _codec
```
    The ObjectCodec used to parse the Bson object(s)
  - _tokenPos
```
protected int _tokenPos
```
    The position of the current token
  - _currentContext
```
protected BsonParser.Context _currentContext
```
    The current parser state
- Constructor Detail
  - BsonParser
```
public BsonParser(com.fasterxml.jackson.core.io.IOContext ctxt,
                  int jsonFeatures,
                  int bsonFeatures,
                  java.io.InputStream in)
```
    Constructs a new parser
    
    Parameters:
    
    ctxt - the Jackson IO context
    
    jsonFeatures - bit flag composed of bits that indicate which JsonParser.Features are enabled.
    
    bsonFeatures - bit flag composed of bits that indicate which BsonParser.Features are enabled.
    
    in - the input stream to parse.
- Method Detail
  - isEnabled
```
protected boolean isEnabled(BsonParser.Feature f)
```
    Checks if a generator feature is enabled
    
    Parameters:
    
    f - the feature
    
    Returns:
    
    true if the given feature is enabled
  - isExpectedStartArrayToken
```
public boolean isExpectedStartArrayToken()
```
    Overrides:
    
    isExpectedStartArrayToken in class com.fasterxml.jackson.core.base.ParserMinimalBase
  - getCodec
```
public com.fasterxml.jackson.core.ObjectCodec getCodec()
```
    Specified by:
    
    getCodec in class com.fasterxml.jackson.core.JsonParser
  - setCodec
```
public void setCodec(com.fasterxml.jackson.core.ObjectCodec c)
```
    Specified by:
    
    setCodec in class com.fasterxml.jackson.core.JsonParser
  - close
```
public void close()
           throws java.io.IOException
```
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Overrides:
    
    close in class com.fasterxml.jackson.core.base.ParserBase
    
    Throws:
    
    java.io.IOException
  - nextToken
```
public com.fasterxml.jackson.core.JsonToken nextToken()
                                               throws java.io.IOException
```
    Specified by:
    
    nextToken in class com.fasterxml.jackson.core.base.ParserMinimalBase
    
    Throws:
    
    java.io.IOException
  - handleNewDocument
```
protected com.fasterxml.jackson.core.JsonToken handleNewDocument(boolean array)
                                                          throws java.io.IOException
```
    Can be called when a new embedded document is found. Reads the document's header and creates a new context on the stack.
    
    Parameters:
    
    array - true if the document is an embedded array
    
    Returns:
    
    the json token read
    
    Throws:
    
    java.io.IOException - if an I/O error occurs
  - handleBinary
```
protected com.fasterxml.jackson.core.JsonToken handleBinary()
                                                     throws java.io.IOException
```
    Reads binary data from the input stream
    
    Returns:
    
    the json token read
    
    Throws:
    
    java.io.IOException - if an I/O error occurs
  - regexStrToFlags
```
protected int regexStrToFlags(java.lang.String pattern)
                       throws com.fasterxml.jackson.core.JsonParseException
```
    Converts a BSON regex pattern string to a combined value of Java flags that can be used in Pattern.compile(String, int)
    
    Parameters:
    
    pattern - the regex pattern string
    
    Returns:
    
    the Java flags
    
    Throws:
    
    com.fasterxml.jackson.core.JsonParseException - if the pattern string contains a unsupported flag
  - handleRegEx
```
protected com.fasterxml.jackson.core.JsonToken handleRegEx()
                                                    throws java.io.IOException
```
    Reads and compiles a regular expression
    
    Returns:
    
    the json token read
    
    Throws:
    
    java.io.IOException - if an I/O error occurs
  - handleDBPointer
```
protected com.fasterxml.jackson.core.JsonToken handleDBPointer()
                                                        throws java.io.IOException
```
    Reads a DBPointer from the stream
    
    Returns:
    
    the json token read
    
    Throws:
    
    java.io.IOException - if an I/O error occurs
  - handleJavascriptWithScope
```
protected com.fasterxml.jackson.core.JsonToken handleJavascriptWithScope()
                                                                  throws java.io.IOException
```
    Can be called when embedded javascript code with scope is found. Reads the code and the embedded document.
    
    Returns:
    
    the json token read
    
    Throws:
    
    java.io.IOException - if an I/O error occurs
  - readCString
```
protected java.lang.String readCString()
                                throws java.io.IOException
```
    Returns:
    
    a null-terminated string read from the input stream
    
    Throws:
    
    java.io.IOException - if the string could not be read
  - skipCString
```
protected void skipCString()
                    throws java.io.IOException
```
    Skips over a null-terminated string in the input stream
    
    Throws:
    
    java.io.IOException - if an I/O error occurs
  - readString
```
protected java.lang.String readString()
                               throws java.io.IOException
```
    Reads a string that consists of a integer denoting the number of bytes, the bytes (including a terminating 0 byte)
    
    Returns:
    
    the string
    
    Throws:
    
    java.io.IOException - if the string could not be read
  - readSymbol
```
protected Symbol readSymbol()
                     throws java.io.IOException
```
    Reads a symbol object from the input stream
    
    Returns:
    
    the symbol
    
    Throws:
    
    java.io.IOException - if the symbol could not be read
  - readTimestamp
```
protected Timestamp readTimestamp()
                           throws java.io.IOException
```
    Reads a timestamp object from the input stream
    
    Returns:
    
    the timestamp
    
    Throws:
    
    java.io.IOException - if the timestamp could not be read
  - readObjectId
```
protected ObjectId readObjectId()
                         throws java.io.IOException
```
    Reads a ObjectID from the input stream
    
    Returns:
    
    the ObjectID
    
    Throws:
    
    java.io.IOException - if the ObjectID could not be read
  - readDocument
```
protected java.util.Map<java.lang.String,java.lang.Object> readDocument()
                                                                 throws java.io.IOException
```
    Fully reads an embedded document, reusing this parser
    
    Returns:
    
    the parsed document
    
    Throws:
    
    java.io.IOException - if the document could not be read
  - getContext
```
protected BsonParser.Context getContext()
                                 throws java.io.IOException
```
    Returns:
    
    the context of the current element
    
    Throws:
    
    java.io.IOException - if there is no context
  - isClosed
```
public boolean isClosed()
```
    Overrides:
    
    isClosed in class com.fasterxml.jackson.core.base.ParserBase
  - getCurrentName
```
public java.lang.String getCurrentName()
```
    Overrides:
    
    getCurrentName in class com.fasterxml.jackson.core.base.ParserBase
  - getCurrentBsonType
```
public byte getCurrentBsonType()
```
    Returns:
    
    the BSON type of the current element
  - getTokenLocation
```
public com.fasterxml.jackson.core.JsonLocation getTokenLocation()
```
    Overrides:
    
    getTokenLocation in class com.fasterxml.jackson.core.base.ParserBase
  - getCurrentLocation
```
public com.fasterxml.jackson.core.JsonLocation getCurrentLocation()
```
    Overrides:
    
    getCurrentLocation in class com.fasterxml.jackson.core.base.ParserBase
  - getText
```
public java.lang.String getText()
```
    Specified by:
    
    getText in class com.fasterxml.jackson.core.base.ParserMinimalBase
  - getTextCharacters
```
public char[] getTextCharacters()
```
    Specified by:
    
    getTextCharacters in class com.fasterxml.jackson.core.base.ParserMinimalBase
  - getTextLength
```
public int getTextLength()
```
    Specified by:
    
    getTextLength in class com.fasterxml.jackson.core.base.ParserMinimalBase
  - getTextOffset
```
public int getTextOffset()
```
    Specified by:
    
    getTextOffset in class com.fasterxml.jackson.core.base.ParserMinimalBase
  - hasTextCharacters
```
public boolean hasTextCharacters()
```
    Overrides:
    
    hasTextCharacters in class com.fasterxml.jackson.core.base.ParserBase
  - getNumberValue
```
public java.lang.Number getNumberValue()
                                throws java.io.IOException
```
    Overrides:
    
    getNumberValue in class com.fasterxml.jackson.core.base.ParserBase
    
    Throws:
    
    java.io.IOException
  - getNumberValueExact
```
public java.lang.Number getNumberValueExact()
                                     throws java.io.IOException
```
    Overrides:
    
    getNumberValueExact in class com.fasterxml.jackson.core.base.ParserBase
    
    Throws:
    
    java.io.IOException
  - getNumberType
```
public com.fasterxml.jackson.core.JsonParser.NumberType getNumberType()
```
    Overrides:
    
    getNumberType in class com.fasterxml.jackson.core.base.ParserBase
  - getIntValue
```
public int getIntValue()
                throws java.io.IOException
```
    Overrides:
    
    getIntValue in class com.fasterxml.jackson.core.base.ParserBase
    
    Throws:
    
    java.io.IOException
  - getLongValue
```
public long getLongValue()
                  throws java.io.IOException
```
    Overrides:
    
    getLongValue in class com.fasterxml.jackson.core.base.ParserBase
    
    Throws:
    
    java.io.IOException
  - getBigIntegerValue
```
public java.math.BigInteger getBigIntegerValue()
                                        throws java.io.IOException
```
    Overrides:
    
    getBigIntegerValue in class com.fasterxml.jackson.core.base.ParserBase
    
    Throws:
    
    java.io.IOException
  - getFloatValue
```
public float getFloatValue()
                    throws java.io.IOException
```
    Overrides:
    
    getFloatValue in class com.fasterxml.jackson.core.base.ParserBase
    
    Throws:
    
    java.io.IOException
  - getDoubleValue
```
public double getDoubleValue()
                      throws java.io.IOException
```
    Overrides:
    
    getDoubleValue in class com.fasterxml.jackson.core.base.ParserBase
    
    Throws:
    
    java.io.IOException
  - getDecimalValue
```
public java.math.BigDecimal getDecimalValue()
                                     throws java.io.IOException
```
    Overrides:
    
    getDecimalValue in class com.fasterxml.jackson.core.base.ParserBase
    
    Throws:
    
    java.io.IOException
  - getBinaryValue
```
public byte[] getBinaryValue(com.fasterxml.jackson.core.Base64Variant b64variant)
                      throws java.io.IOException
```
    Overrides:
    
    getBinaryValue in class com.fasterxml.jackson.core.base.ParserBase
    
    Throws:
    
    java.io.IOException
  - getEmbeddedObject
```
public java.lang.Object getEmbeddedObject()
```
    Overrides:
    
    getEmbeddedObject in class com.fasterxml.jackson.core.JsonParser
  - _handleEOF
```
protected void _handleEOF()
                   throws com.fasterxml.jackson.core.JsonParseException
```
    Overrides:
    
    _handleEOF in class com.fasterxml.jackson.core.base.ParserBase
    
    Throws:
    
    com.fasterxml.jackson.core.JsonParseException
  - loadMore
```
protected boolean loadMore()
```
    Overrides:
    
    loadMore in class com.fasterxml.jackson.core.base.ParserBase
  - _finishString
```
protected void _finishString()
```
    Overrides:
    
    _finishString in class com.fasterxml.jackson.core.base.ParserBase
  - _closeInput
```
protected void _closeInput()
                    throws java.io.IOException
```
    Specified by:
    
    _closeInput in class com.fasterxml.jackson.core.base.ParserBase
    
    Throws:
    
    java.io.IOException

Class BsonParser

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.core.JsonParser

Field Summary

Fields inherited from class com.fasterxml.jackson.core.base.ParserBase

Fields inherited from class com.fasterxml.jackson.core.base.ParserMinimalBase

Fields inherited from class com.fasterxml.jackson.core.JsonParser

Constructor Summary

Method Summary

Methods inherited from class com.fasterxml.jackson.core.base.ParserBase

Methods inherited from class com.fasterxml.jackson.core.base.ParserMinimalBase

Methods inherited from class com.fasterxml.jackson.core.JsonParser

Methods inherited from class java.lang.Object

Field Detail

_bsonFeatures

_in

_counter

_rawInputStream

_closed

_codec

_tokenPos

_currentContext

Constructor Detail

BsonParser

Method Detail

isEnabled

isExpectedStartArrayToken

getCodec

setCodec

close

nextToken

handleNewDocument

handleBinary

regexStrToFlags

handleRegEx

handleDBPointer

handleJavascriptWithScope

readCString

skipCString

readString

readSymbol

readTimestamp

readObjectId

readDocument

getContext

isClosed

getCurrentName

getCurrentBsonType

getTokenLocation

getCurrentLocation

getText

getTextCharacters

getTextLength

getTextOffset

hasTextCharacters

getNumberValue

getNumberValueExact

getNumberType

getIntValue

getLongValue

getBigIntegerValue

getFloatValue

getDoubleValue

getDecimalValue

getBinaryValue

getEmbeddedObject

_handleEOF

loadMore

_finishString

_closeInput