BsonInput (mongo-java-driver 3.7.0 API)

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

ByteBufferBsonInput
```
public interface BsonInput
extends Closeable
```
An input stream that is optimized for reading BSON values directly from the underlying stream.

Since:

3.0

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`close()`
`BsonInputMark`	`getMark(int readLimit)`	Gets a mark for the current position in the stream.
`int`	`getPosition()`	Gets the current position in the stream
`boolean`	`hasRemaining()`	Returns true if there are more bytes left in the stream.
`void`	`mark(int readLimit)`	Deprecated. Use `getMark(int)` instead
`byte`	`readByte()`	Reads a single byte from the stream
`void`	`readBytes(byte[] bytes)`	Reads the specified number of bytes into the given byte array.
`void`	`readBytes(byte[] bytes, int offset, int length)`	Reads the specified number of bytes into the given byte array starting at the specified offset.
`String`	`readCString()`	Reads a BSON CString value from the stream.
`double`	`readDouble()`	Reads a BSON Double value from the stream.
`int`	`readInt32()`	Reads a BSON Int32 value from the stream.
`long`	`readInt64()`	Reads a BSON Int64 value from the stream.
`ObjectId`	`readObjectId()`	Reads a BSON ObjectId value from the stream.
`String`	`readString()`	Reads a BSON String value from the stream.
`void`	`reset()`	Resets the stream to the current mark.
`void`	`skip(int numBytes)`	Skips the specified number of bytes in the stream.
`void`	`skipCString()`	Skips a BSON CString value from the stream.

- Method Detail
  - getPosition
```
int getPosition()
```
    Gets the current position in the stream
    
    Returns:
    
    the current position
  - readByte
```
byte readByte()
```
    Reads a single byte from the stream
    
    Returns:
    
    the byte value
  - readBytes
```
void readBytes(byte[] bytes)
```
    Reads the specified number of bytes into the given byte array. This is equivalent to to readBytes(bytes, 0, bytes.length).
    
    Parameters:
    
    bytes - the byte array to write into
  - readBytes
```
void readBytes(byte[] bytes,
               int offset,
               int length)
```
    Reads the specified number of bytes into the given byte array starting at the specified offset.
    
    Parameters:
    
    bytes - the byte array to write into
    
    offset - the offset to start writing
    
    length - the number of bytes to write
  - readInt64
```
long readInt64()
```
    Reads a BSON Int64 value from the stream.
    
    Returns:
    
    the Int64 value
  - readDouble
```
double readDouble()
```
    Reads a BSON Double value from the stream.
    
    Returns:
    
    the double value
  - readInt32
```
int readInt32()
```
    Reads a BSON Int32 value from the stream.
    
    Returns:
    
    the Int32 value
  - readString
```
String readString()
```
    Reads a BSON String value from the stream.
    
    Returns:
    
    the string
  - readObjectId
```
ObjectId readObjectId()
```
    Reads a BSON ObjectId value from the stream.
    
    Returns:
    
    the ObjectId
  - readCString
```
String readCString()
```
    Reads a BSON CString value from the stream.
    
    Returns:
    
    the CString
  - skipCString
```
void skipCString()
```
    Skips a BSON CString value from the stream.
  - skip
```
void skip(int numBytes)
```
    Skips the specified number of bytes in the stream.
    
    Parameters:
    
    numBytes - the number of bytes to skip
  - mark
```
@Deprecated
void mark(int readLimit)
```
    Deprecated. Use getMark(int) instead
    
    Marks the current position in the stream. This method obeys the contract as specified in the same method in InputStream.
    
    Parameters:
    
    readLimit - the maximum limit of bytes that can be read before the mark position becomes invalid
  - getMark
```
BsonInputMark getMark(int readLimit)
```
    Gets a mark for the current position in the stream.
    
    Parameters:
    
    readLimit - the maximum limit of bytes that can be read before the mark position becomes invalid
    
    Returns:
    
    the mark
    
    Since:
    
    3.7
  - reset
```
void reset()
```
    Resets the stream to the current mark. This method obeys the contract as specified in the same method in InputStream.
  - hasRemaining
```
boolean hasRemaining()
```
    Returns true if there are more bytes left in the stream.
    
    Returns:
    
    true if there are more bytes left in the stream.
  - close
```
void close()
```
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable

Interface BsonInput

Method Summary

Method Detail

getPosition

readByte

readBytes

readBytes

readInt64

readDouble

readInt32

readString

readObjectId

readCString

skipCString

skip

mark

getMark

reset

hasRemaining

close