Package de.undercouch.bson4jackson.io

Class LittleEndianInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

de.undercouch.bson4jackson.io.LittleEndianInputStream

All Implemented Interfaces:

Closeable, DataInput, AutoCloseable

public class LittleEndianInputStream
extends FilterInputStream
implements DataInput

Works like DataInputStream but reads values using little-endian encoding. Apart from that, it provides a method that reads an UTF-8 encoded string without reading the number of bytes from the input stream.

Field Summary

Fields

Modifier and Type	Field	Description
protected ByteBuffer	_buf	Wraps around _rawBuf
protected CharBuffer	_lineBuffer	A buffer that will lazily be initialized by readLine()
protected byte[]	_rawBuf	A small buffer to speed up reading slightly
protected static final StaticBuffers.Key	UTF8_BUFFER	A unique key for a buffer used in readUTF(DataInput, int)

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
LittleEndianInputStream(InputStream in)

Method Summary

Modifier and Type	Method	Description
boolean	readBoolean()
byte	readByte()
char	readChar()
double	readDouble()
float	readFloat()
void	readFully(byte[] b)
void	readFully(byte[] b, int off, int len)
int	readInt()
String	readLine()
long	readLong()
short	readShort()
int	readUnsignedByte()
int	readUnsignedShort()
String	readUTF()	Forwards to DataInputStream.readUTF(DataInput) which expects a short value at the beginning of the UTF-8 string that specifies the number of bytes to read.
String	readUTF(int len)	Reads a modified UTF-8 string
String	readUTF(DataInput input, int len)	Reads a modified UTF-8 string from a DataInput object
int	skipBytes(int n)

Methods inherited from class java.io.FilterInputStream

available, close, mark, markSupported, read, read, read, reset, skip

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Field Details

UTF8_BUFFER

protected static final StaticBuffers.Key UTF8_BUFFER

A unique key for a buffer used in readUTF(DataInput, int)

_rawBuf

protected byte[] _rawBuf

A small buffer to speed up reading slightly

_buf

protected ByteBuffer _buf

Wraps around _rawBuf

_lineBuffer

protected CharBuffer _lineBuffer

A buffer that will lazily be initialized by readLine()

Constructor Details

LittleEndianInputStream

public LittleEndianInputStream(InputStream in)

See Also:

• FilterInputStream(InputStream)

Method Details

readFully

public void readFully(byte[] b)
               throws IOException

Specified by:

readFully in interface DataInput

Throws:

IOException

readFully

public void readFully(byte[] b,
 int off,
 int len)
               throws IOException

Specified by:

readFully in interface DataInput

Throws:

IOException

skipBytes

public int skipBytes(int n)
              throws IOException

Specified by:

skipBytes in interface DataInput

Throws:

IOException

readBoolean

public boolean readBoolean()
                    throws IOException

Specified by:

readBoolean in interface DataInput

Throws:

IOException

readByte

public byte readByte()
              throws IOException

Specified by:

readByte in interface DataInput

Throws:

IOException

readUnsignedByte

public int readUnsignedByte()
                     throws IOException

Specified by:

readUnsignedByte in interface DataInput

Throws:

IOException

readShort

public short readShort()
                throws IOException

Specified by:

readShort in interface DataInput

Throws:

IOException

readUnsignedShort

public int readUnsignedShort()
                      throws IOException

Specified by:

readUnsignedShort in interface DataInput

Throws:

IOException

readChar

public char readChar()
              throws IOException

Specified by:

readChar in interface DataInput

Throws:

IOException

readInt

public int readInt()
            throws IOException

Specified by:

readInt in interface DataInput

Throws:

IOException

readLong

public long readLong()
              throws IOException

Specified by:

readLong in interface DataInput

Throws:

IOException

readFloat

public float readFloat()
                throws IOException

Specified by:

readFloat in interface DataInput

Throws:

IOException

readDouble

public double readDouble()
                  throws IOException

Specified by:

readDouble in interface DataInput

Throws:

IOException

readLine

public String readLine()
                throws IOException

Specified by:

readLine in interface DataInput

Throws:

IOException

readUTF

public String readUTF()
               throws IOException

Forwards to DataInputStream.readUTF(DataInput) which expects a short value at the beginning of the UTF-8 string that specifies the number of bytes to read.

If the output stream does no include such a short value, use readUTF(int) to explicitly specify the number of bytes.

Specified by:

readUTF in interface DataInput

Throws:

IOException

readUTF

public String readUTF(int len)
               throws IOException

Reads a modified UTF-8 string

Parameters:

len - the number of bytes to read (please do not mix that up with the number of characters!). If this is -1 then the method will read bytes until the first one is zero (0x00). The zero byte will not be included in the result string.

Returns:

the UTF-8 string

Throws:

IOException - if an I/O error occurs

CharacterCodingException - if an invalid UTF-8 character has been read

readUTF

public String readUTF(DataInput input,
 int len)
               throws IOException

Reads a modified UTF-8 string from a DataInput object

Parameters:

input - the DataInput object to read from

len - the number of bytes to read (please do not mix that up with the number of characters!). If this is -1 then the method will read bytes until the first one is zero (0x00). The zero byte will not be included in the result string.

Returns:

the UTF-8 string

Throws:

IOException - if an I/O error occurs

CharacterCodingException - if an invalid UTF-8 character has been read