Package org.bson

Interface BsonReader

All Superinterfaces:
AutoCloseable, Closeable
All Known Implementing Classes:
AbstractBsonReader, BsonBinaryReader, BsonDocumentReader, JsonReader
public interface BsonReader extends Closeable
An interface for reading a logical BSON document using a pull-oriented API.
Since:
3.0

  • Method Details

    • getCurrentBsonType

      BsonType getCurrentBsonType()
      Returns:
      The current BsonType.

    • getCurrentName

      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:

    • 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:

    • readBinaryData

      BsonBinary readBinaryData(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(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(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(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(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(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(String name)
      Reads a BSON Decimal128 element from the reader.
      Parameters:
      name - The name of the element.
      Returns:
      A Decimal128
      Since:
      3.4

    • readJavaScript

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

    • readJavaScript

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

    • readJavaScriptWithScope

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

    • readJavaScriptWithScope

      String readJavaScriptWithScope(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(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(String name)
      Reads a BSON MinKey element from the reader.
      Parameters:
      name - The name of the element.

    • readName

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

    • readName

      void readName(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(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(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(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(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

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

    • readString

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

    • readSymbol

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

    • readSymbol

      String readSymbol(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(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(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).

    • getMark

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

    • close

      void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable