Package org.bson.io

Class Bits

java.lang.Object

org.bson.io.Bits

public class Bits
extends java.lang.Object

Utility class for reading values from an input stream.

Constructor Summary

Constructors

Constructor and Description
Bits()

Method Summary

Modifier and Type	Method and Description
static void	readFully(java.io.InputStream inputStream, byte[] buffer) Reads bytes from the input stream and puts them into the given byte buffer.
static void	readFully(java.io.InputStream inputStream, byte[] buffer, int length) Reads bytes from the input stream and puts them into the given byte buffer.
static void	readFully(java.io.InputStream inputStream, byte[] buffer, int offset, int length) Reads bytes from the input stream and puts them into the given byte buffer.
static int	readInt(byte[] buffer) Reads and returns a single integer value from the buffer.
static int	readInt(byte[] buffer, int offset) Reads and returns a single integer value from the buffer.
static int	readInt(java.io.InputStream inputStream) Reads and returns a single integer value from the input stream.
static int	readInt(java.io.InputStream inputStream, byte[] buffer) Reads and returns a single integer value from the input stream.
static int	readIntBE(byte[] buffer, int offset) Reads and returns a single big-endian integer value
static long	readLong(byte[] buffer) Reads and returns a single long value from the buffer.
static long	readLong(byte[] buffer, int offset) Reads and returns a single long value from the buffer.
static long	readLong(java.io.InputStream inputStream) Reads and returns a single long value from the input stream.
static long	readLong(java.io.InputStream inputStream, byte[] buffer) Reads and returns a single long value from the input stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

Bits

public Bits()

Method Detail

readFully

public static void readFully(java.io.InputStream inputStream,
                             byte[] buffer)
                      throws java.io.IOException

Reads bytes from the input stream and puts them into the given byte buffer. The equivalent of calling readFully(java.io.InputStream, byte[], int, int) with an offset of zero and a length equal to the length of the buffer.

Parameters:

inputStream - the input stream to read from

buffer - the buffer into which the data is read.

Throws:

java.io.IOException - if there's an error reading from the inputStream

readFully

public static void readFully(java.io.InputStream inputStream,
                             byte[] buffer,
                             int length)
                      throws java.io.IOException

Reads bytes from the input stream and puts them into the given byte buffer. The equivalent of calling readFully(java.io.InputStream, byte[], int, int) with an offset of zero.

Parameters:

inputStream - the input stream to read from

buffer - the buffer into which the data is read.

length - the maximum number of bytes to read.

Throws:

java.io.IOException - if there's an error reading from the inputStream

readFully

public static void readFully(java.io.InputStream inputStream,
                             byte[] buffer,
                             int offset,
                             int length)
                      throws java.io.IOException

Reads bytes from the input stream and puts them into the given byte buffer.

Parameters:

inputStream - the input stream to read from

buffer - the buffer into which the data is read.

offset - the start offset in array buffer at which the data is written.

length - the maximum number of bytes to read.

Throws:

java.io.IOException - if there's an error reading from the inputStream

See Also:

InputStream.read(byte[], int, int)

readInt

public static int readInt(java.io.InputStream inputStream)
                   throws java.io.IOException

Reads and returns a single integer value from the input stream.

Parameters:

inputStream - the input stream to read from

Returns:

the integer value

Throws:

java.io.IOException - if there's an error reading from the inputStream

readInt

public static int readInt(java.io.InputStream inputStream,
                          byte[] buffer)
                   throws java.io.IOException

Reads and returns a single integer value from the input stream.

Parameters:

inputStream - the input stream to read from

buffer - the buffer to write the input stream bytes into

Returns:

the integer value

Throws:

java.io.IOException - if there's an error reading from the inputStream

readInt

public static int readInt(byte[] buffer)

Reads and returns a single integer value from the buffer. The equivalent of calling readInt(byte[], int) with an offset of zero.

Parameters:

buffer - the buffer to read from

Returns:

the integer value

readInt

public static int readInt(byte[] buffer,
                          int offset)

Reads and returns a single integer value from the buffer.

Parameters:

buffer - the buffer to read from

offset - the position to start reading from the buffer

Returns:

the integer value

readIntBE

public static int readIntBE(byte[] buffer,
                            int offset)

Reads and returns a single big-endian integer value

Parameters:

buffer - the buffer to read from

offset - the position to start reading from the buffer

Returns:

the integer value

readLong

public static long readLong(java.io.InputStream inputStream)
                     throws java.io.IOException

Reads and returns a single long value from the input stream.

Parameters:

inputStream - the input stream to read from

Returns:

the long value

Throws:

java.io.IOException - if there's an error reading from the inputStream

readLong

public static long readLong(java.io.InputStream inputStream,
                            byte[] buffer)
                     throws java.io.IOException

Reads and returns a single long value from the input stream.

Parameters:

inputStream - the input stream to read from

buffer - the buffer to write the input stream bytes into

Returns:

the long value

Throws:

java.io.IOException - if there's an error reading from the inputStream

readLong

public static long readLong(byte[] buffer)

Reads and returns a single long value from the buffer. The equivalent of called readLong(byte[], int) with an offset of zero.

Parameters:

buffer - the buffer to read from

Returns:

the long value

readLong

public static long readLong(byte[] buffer,
                            int offset)

Reads and returns a single long value from the buffer.

Parameters:

buffer - the buffer to read from

offset - the position to start reading from the buffer

Returns:

the long value