Package com.aurumsmods.littlebigio

Class BinaryInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.aurumsmods.littlebigio.BinaryInputStream

All Implemented Interfaces:

ByteOrdered, UnsignedIntInput, Closeable, DataInput, AutoCloseable

public class BinaryInputStream
extends FilterInputStream
implements DataInput, ByteOrdered, UnsignedIntInput

A binary input stream provides readability of primitive data types from an underlying input stream. The order in which the bytes are interpreted can be either little endian or big endian (see ByteOrder).

This implements DataInput but intentionally violates the specifications prescribed by the contract. This is because DataInput explicitly states the implementation of big-endian byte ordering.

BinaryInputStream is not necessarily thread-safe due to it using a buffer to read multiple bytes at once.

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
BinaryInputStream(InputStream in)	Creates a new BinaryInputStream that uses the given underlying InputStream.
BinaryInputStream(InputStream in, ByteOrder byteOrder)	Creates a new BinaryInputStream that uses the given underlying InputStream.

Method Summary

Modifier and Type	Method	Description
ByteOrder	getOrder()	Returns the ByteOrder.
boolean	readBoolean()	Reads one input byte from the input stream. and returns true if that byte is nonzero, false if that byte is zero.
byte	readByte()	Reads and returns one signed byte from the input stream.
char	readChar()	Reads two bytes from the input stream and returns the char value converted from these bytes.
double	readDouble()	Reads eight bytes from the input stream and returns the double value converted from these bytes.
float	readFloat()	Reads four bytes from the input stream and returns the float value converted from these bytes.
void	readFully(byte[] b)	Reads some bytes from the input stream into the given byte array.
void	readFully(byte[] b, int off, int len)	Reads the specified number of bytes from the input stream into the given byte array.
int	readInt()	Reads four bytes from the input stream and returns the signed int value converted from these bytes.
String	readLine()	Deprecated. Use BufferedReader.readLine() instead.
long	readLong()	Reads eight bytes from the input stream and returns the signed long value converted from these bytes.
short	readShort()	Reads two bytes from the input stream and returns the signed short value converted from these bytes.
int	readUnsignedByte()	Reads and returns one unsigned byte from the input stream.
long	readUnsignedInt()	Reads four bytes from the input stream and returns the unsigned int value converted from these bytes.
int	readUnsignedShort()	Reads two bytes from the input stream and returns the unsigned short value converted from these bytes.
String	readUTF()	Reads and returns a Unicode character string encoded in modified UTF-8 format from the input stream.
void	setOrder(ByteOrder byteOrder)	Sets the ByteOrder to the specified value.
int	skipBytes(int n)	Skips over and discards exactly n bytes of data from this input stream.

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

Methods inherited from interface com.aurumsmods.littlebigio.ByteOrdered

isBigEndian, isLittleEndian, isNativeOrder, swapOrder

Constructor Details

BinaryInputStream

public BinaryInputStream(InputStream in)

Creates a new BinaryInputStream that uses the given underlying InputStream. The system's native byte order will be used when reading data.

Parameters:

in - the InputStream to read from.

See Also:

• ByteOrder.nativeOrder()

BinaryInputStream

public BinaryInputStream(InputStream in,
 ByteOrder byteOrder)

Creates a new BinaryInputStream that uses the given underlying InputStream. The specified byte order will be used when reading data.

Parameters:

in - the InputStream to read from.

byteOrder - the ByteOrder that specifies how to read data.

Throws:

NullPointerException - if byteOrder is null.

Method Details

getOrder

public ByteOrder getOrder()

Returns the ByteOrder.

Specified by:

getOrder in interface ByteOrdered

Returns:

the ByteOrder.

setOrder

public void setOrder(ByteOrder byteOrder)

Sets the ByteOrder to the specified value. If the value is null, a NullPointerException is thrown.

Specified by:

setOrder in interface ByteOrdered

Parameters:

byteOrder - the ByteOrder.

Throws:

NullPointerException - if byteOrder is null.

readFully

public void readFully(byte[] b)
               throws IOException

Reads some bytes from the input stream into the given byte array. The number of bytes read is equal to the length of b. This method blocks until len bytes of input data have been read, end of stream is detected, or an exception is thrown. This does not close the stream.

Specified by:

readFully in interface DataInput

Parameters:

b - the byte array into which the data is read.

Throws:

NullPointerException - if b is null.

IOException - if an I/O error occurs.

EOFException - if the input stream reaches the end before reading all bytes.

See Also:

• InputStream.readNBytes(byte[], int, int)

readFully

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

Reads the specified number of bytes from the input stream into the given byte array. This method blocks until len bytes of input data have been read, end of stream is detected, or an exception is thrown. This does not close the stream.

Specified by:

readFully in interface DataInput

Parameters:

b - the byte array into which the data is read.

off - the offset in b at which the data is written.

len - the maximum number of bytes to read.

Throws:

NullPointerException - if b is null.

IndexOutOfBoundsException - if off is negative, len is negative, or len is greater than b.length - off.

IOException - if an I/O error occurs.

EOFException - if the input stream reaches the end before reading all bytes.

See Also:

• InputStream.readNBytes(byte[], int, int)

skipBytes

public int skipBytes(int n)
              throws IOException

Skips over and discards exactly n bytes of data from this input stream. If n is zero or negative, then no bytes are skipped. This method blocks until n bytes have been skipped, end of stream is detected, or an exception is thrown.

Specified by:

skipBytes in interface DataInput

Parameters:

n - the number of bytes to skip.

Returns:

the number of bytes that were skipped.

Throws:

IOException - if an I/O error occurs.

readBoolean

public boolean readBoolean()
                    throws IOException

Reads one input byte from the input stream. and returns true if that byte is nonzero, false if that byte is zero.

Specified by:

readBoolean in interface DataInput

Returns:

the boolean value read.

Throws:

EOFException - if this stream reached the end before reading the byte.

IOException - if an I/O error occurs.

readByte

public byte readByte()
              throws IOException

Reads and returns one signed byte from the input stream.

Specified by:

readByte in interface DataInput

Returns:

the signed byte value read.

Throws:

EOFException - if this stream reached the end before reading the byte.

IOException - if an I/O error occurs.

readUnsignedByte

public int readUnsignedByte()
                     throws IOException

Reads and returns one unsigned byte from the input stream.

Specified by:

readUnsignedByte in interface DataInput

Returns:

the unsigned byte value read.

Throws:

EOFException - if this stream reached the end before reading the byte.

IOException - if an I/O error occurs.

readShort

public short readShort()
                throws IOException

Reads two bytes from the input stream and returns the signed short value converted from these bytes.

Specified by:

readShort in interface DataInput

Returns:

the signed short value read.

Throws:

EOFException - if this stream reached the end before reading all the bytes.

IOException - if an I/O error occurs.

See Also:

• BitConverter.getShort(byte[], int, ByteOrder)

readUnsignedShort

public int readUnsignedShort()
                      throws IOException

Reads two bytes from the input stream and returns the unsigned short value converted from these bytes.

Specified by:

readUnsignedShort in interface DataInput

Returns:

the unsigned short value read.

Throws:

EOFException - if this stream reached the end before reading all the bytes.

IOException - if an I/O error occurs.

See Also:

• BitConverter.getUnsignedShort(byte[], int, ByteOrder)

readChar

public char readChar()
              throws IOException

Reads two bytes from the input stream and returns the char value converted from these bytes.

Specified by:

readChar in interface DataInput

Returns:

the char value read.

Throws:

EOFException - if this stream reached the end before reading all the bytes.

IOException - if an I/O error occurs.

readInt

public int readInt()
            throws IOException

Reads four bytes from the input stream and returns the signed int value converted from these bytes.

Specified by:

readInt in interface DataInput

Returns:

the signed int value read.

Throws:

EOFException - if this stream reached the end before reading all the bytes.

IOException - if an I/O error occurs.

See Also:

• BitConverter.getInt(byte[], int, ByteOrder)

readUnsignedInt

public long readUnsignedInt()
                     throws IOException

Reads four bytes from the input stream and returns the unsigned int value converted from these bytes.

Specified by:

readUnsignedInt in interface UnsignedIntInput

Returns:

the unsigned int value read.

Throws:

EOFException - if this stream reached the end before reading all the bytes.

IOException - if an I/O error occurs.

See Also:

• BitConverter.getUnsignedInt(byte[], int, ByteOrder)

readLong

public long readLong()
              throws IOException

Reads eight bytes from the input stream and returns the signed long value converted from these bytes.

Specified by:

readLong in interface DataInput

Returns:

the signed long value read.

Throws:

EOFException - if this stream reached the end before reading all the bytes.

IOException - if an I/O error occurs.

See Also:

• BitConverter.getLong(byte[], int, ByteOrder)

readFloat

public float readFloat()
                throws IOException

Reads four bytes from the input stream and returns the float value converted from these bytes.

Specified by:

readFloat in interface DataInput

Returns:

the float value read.

Throws:

EOFException - if this stream reached the end before reading all the bytes.

IOException - if an I/O error occurs.

See Also:

• BitConverter.getFloat(byte[], int, ByteOrder)

readDouble

public double readDouble()
                  throws IOException

Reads eight bytes from the input stream and returns the double value converted from these bytes.

Specified by:

readDouble in interface DataInput

Returns:

the double value read.

Throws:

EOFException - if this stream reached the end before reading all the bytes.

IOException - if an I/O error occurs.

See Also:

• BitConverter.getDouble(byte[], int, ByteOrder)

readLine

@Deprecated
public String readLine()
                throws IOException

Deprecated.

Use BufferedReader.readLine() instead.

Not implemented: use BufferedReader instead. This function always throws a UnsupportedOperationException when invoked.

Specified by:

readLine in interface DataInput

Returns:

n/a

Throws:

IOException - n/a

UnsupportedOperationException - always thrown.

readUTF

public String readUTF()
               throws IOException

Reads and returns a Unicode character string encoded in modified UTF-8 format from the input stream. This calls DataInputStream.readUTF(DataInput). See the class documentation for DataInput for details on the modified UTF-8 format.

Specified by:

readUTF in interface DataInput

Returns:

the Unicode string read.

Throws:

IOException - if an I/O error occurs.