Package org.bson

Interface BsonReader

    • Method Detail

      • getCurrentBsonType

        BsonType getCurrentBsonType()
        Returns:
        The current BsonType.

      • getCurrentName

        java.lang.String getCurrentName()
        Gets the most recently read name.
        Returns:
        the most recently read name

      • readBinaryData

        BsonBinary readBinaryData()
        Reads BSON Binary data from the reader.
        Returns:
        A Binary.

      • peekBinarySubType

        byte peekBinarySubType()
        Peeks the subtype of the binary data that the reader is positioned at. This operation is not permitted if the mark is already set.
        Returns:
        the subtype
        See Also:
        mark()

      • peekBinarySize

        int peekBinarySize()
        Peeks the size of the binary data that the reader is positioned at. This operation is not permitted if the mark is already set.
        Returns:
        the size of the binary data
        Since:
        3.4
        See Also:
        mark()

      • readBinaryData

        BsonBinary readBinaryData​(java.lang.String name)
        Reads a BSON Binary data element from the reader.
        Parameters:
        name - The name of the element.
        Returns:
        A Binary.

      • readBoolean

        boolean readBoolean()
        Reads a BSON Boolean from the reader.
        Returns:
        A Boolean.

      • readBoolean

        boolean readBoolean​(java.lang.String name)
        Reads a BSON Boolean element from the reader.
        Parameters:
        name - The name of the element.
        Returns:
        A Boolean.

      • readBsonType

        BsonType readBsonType()
        Reads a BSONType from the reader.
        Returns:
        A BSONType.

      • readDateTime

        long readDateTime()
        Reads a BSON DateTime from the reader.
        Returns:
        The number of milliseconds since the Unix epoch.

      • readDateTime

        long readDateTime​(java.lang.String name)
        Reads a BSON DateTime element from the reader.
        Parameters:
        name - The name of the element.
        Returns:
        The number of milliseconds since the Unix epoch.

      • readDouble

        double readDouble()
        Reads a BSON Double from the reader.
        Returns:
        A Double.

      • readDouble

        double readDouble​(java.lang.String name)
        Reads a BSON Double element from the reader.
        Parameters:
        name - The name of the element.
        Returns:
        A Double.

      • readEndArray

        void readEndArray()
        Reads the end of a BSON array from the reader.

      • readEndDocument

        void readEndDocument()
        Reads the end of a BSON document from the reader.

      • readInt32

        int readInt32()
        Reads a BSON Int32 from the reader.
        Returns:
        An Int32.

      • readInt32

        int readInt32​(java.lang.String name)
        Reads a BSON Int32 element from the reader.
        Parameters:
        name - The name of the element.
        Returns:
        An Int32.

      • readInt64

        long readInt64()
        Reads a BSON Int64 from the reader.
        Returns:
        An Int64.

      • readInt64

        long readInt64​(java.lang.String name)
        Reads a BSON Int64 element from the reader.
        Parameters:
        name - The name of the element.
        Returns:
        An Int64.

      • readDecimal128

        Decimal128 readDecimal128()
        Reads a BSON Decimal128 from the reader.
        Returns:
        A Decimal128
        Since:
        3.4

      • readDecimal128

        Decimal128 readDecimal128​(java.lang.String name)
        Reads a BSON Decimal128 element from the reader.
        Parameters:
        name - The name of the element.
        Returns:
        A Decimal128
        Since:
        3.4

      • readJavaScript

        java.lang.String readJavaScript()
        Reads a BSON JavaScript from the reader.
        Returns:
        A string.

      • readJavaScript

        java.lang.String readJavaScript​(java.lang.String name)
        Reads a BSON JavaScript element from the reader.
        Parameters:
        name - The name of the element.
        Returns:
        A string.

      • readJavaScriptWithScope

        java.lang.String readJavaScriptWithScope()
        Reads a BSON JavaScript with scope from the reader (call readStartDocument next to read the scope).
        Returns:
        A string.

      • readJavaScriptWithScope

        java.lang.String readJavaScriptWithScope​(java.lang.String name)
        Reads a BSON JavaScript with scope element from the reader (call readStartDocument next to read the scope).
        Parameters:
        name - The name of the element.
        Returns:
        A string.

      • readMaxKey

        void readMaxKey()
        Reads a BSON MaxKey from the reader.

      • readMaxKey

        void readMaxKey​(java.lang.String name)
        Reads a BSON MaxKey element from the reader.
        Parameters:
        name - The name of the element.

      • readMinKey

        void readMinKey()
        Reads a BSON MinKey from the reader.

      • readMinKey

        void readMinKey​(java.lang.String name)
        Reads a BSON MinKey element from the reader.
        Parameters:
        name - The name of the element.

      • readName

        java.lang.String readName()
        Reads the name of an element from the reader.
        Returns:
        The name of the element.

      • readName

        void readName​(java.lang.String name)
        Reads the name of an element from the reader.
        Parameters:
        name - The name of the element.

      • readNull

        void readNull()
        Reads a BSON null from the reader.

      • readNull

        void readNull​(java.lang.String name)
        Reads a BSON null element from the reader.
        Parameters:
        name - The name of the element.

      • readObjectId

        ObjectId readObjectId()
        Reads a BSON ObjectId from the reader.
        Returns:
        the ObjectId value

      • readObjectId

        ObjectId readObjectId​(java.lang.String name)
        Reads a BSON ObjectId element from the reader.
        Parameters:
        name - The name of the element.
        Returns:
        ObjectId.

      • readRegularExpression

        BsonRegularExpression readRegularExpression()
        Reads a BSON regular expression from the reader.
        Returns:
        A regular expression.

      • readRegularExpression

        BsonRegularExpression readRegularExpression​(java.lang.String name)
        Reads a BSON regular expression element from the reader.
        Parameters:
        name - The name of the element.
        Returns:
        A regular expression.

      • readDBPointer

        BsonDbPointer readDBPointer()
        Reads a BSON DBPointer from the reader.
        Returns:
        A DBPointer.

      • readDBPointer

        BsonDbPointer readDBPointer​(java.lang.String name)
        Reads a BSON DBPointer element from the reader.
        Parameters:
        name - The name of the element.
        Returns:
        A DBPointer.

      • readStartArray

        void readStartArray()
        Reads the start of a BSON array.

      • readStartDocument

        void readStartDocument()
        Reads the start of a BSON document.

      • readString

        java.lang.String readString()
        Reads a BSON String from the reader.
        Returns:
        A String.

      • readString

        java.lang.String readString​(java.lang.String name)
        Reads a BSON string element from the reader.
        Parameters:
        name - The name of the element.
        Returns:
        A String.

      • readSymbol

        java.lang.String readSymbol()
        Reads a BSON symbol from the reader.
        Returns:
        A string.

      • readSymbol

        java.lang.String readSymbol​(java.lang.String name)
        Reads a BSON symbol element from the reader.
        Parameters:
        name - The name of the element.
        Returns:
        A string.

      • readTimestamp

        BsonTimestamp readTimestamp()
        Reads a BSON timestamp from the reader.
        Returns:
        The combined timestamp/increment.

      • readTimestamp

        BsonTimestamp readTimestamp​(java.lang.String name)
        Reads a BSON timestamp element from the reader.
        Parameters:
        name - The name of the element.
        Returns:
        The combined timestamp/increment.

      • readUndefined

        void readUndefined()
        Reads a BSON undefined from the reader.

      • readUndefined

        void readUndefined​(java.lang.String name)
        Reads a BSON undefined element from the reader.
        Parameters:
        name - The name of the element.

      • skipName

        void skipName()
        Skips the name (reader must be positioned on a name).

      • skipValue

        void skipValue()
        Skips the value (reader must be positioned on a value).

      • mark

        @Deprecated
void mark()
        Deprecated.
        Use getMark() instead
        Creates a bookmark in the BsonReader's input The previous mark must be cleared before creating a new one

      • getMark

        BsonReaderMark getMark()
        Gets a mark representing the current state of the reader.
        Returns:
        the mark
        Since:
        3.5

      • reset

        @Deprecated
void reset()
        Deprecated.
        Prefer getMark()
        Go back to the state at the last mark and removes the mark
        Throws:
        BSONException - if no mark has been set

      • close

        void close()
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable