public interface BinaryDataInput
Byte level input (i.e., for byte, int, long, float, etc.) should always be byte aligned. For example, a request to read an int should always realign the input at the byte level.
The implementation of this interface should clearly define if multi-byte input data is read in little- or big-endian byte ordering (least significant byte first or most significant byte first, respectively).
EndianType
Modifier and Type | Method and Description |
---|---|
int |
getByteOrdering()
Returns the endianess (i.e., byte ordering) of the implementing
class.
|
byte |
readByte()
Should read a signed byte (i.e., 8 bit) from the input.
|
double |
readDouble()
Should read an IEEE double precision (i.e., 64 bit)
floating-point number from the input.
|
float |
readFloat()
Should read an IEEE single precision (i.e., 32 bit)
floating-point number from the input.
|
int |
readInt()
Should read a signed int (i.e., 32 bit) from the input.
|
long |
readLong()
Should read a signed long (i.e., 64 bit) from the input.
|
short |
readShort()
Should read a signed short (i.e., 16 bit) from the input.
|
int |
readUnsignedByte()
Should read an unsigned byte (i.e., 8 bit) from the input.
|
long |
readUnsignedInt()
Should read an unsigned int (i.e., 32 bit) from the input.
|
int |
readUnsignedShort()
Should read an unsigned short (i.e., 16 bit) from the input.
|
int |
skipBytes(int n)
Skips n bytes from the input.
|
byte readByte() throws EOFException, IOException
EOFException
- If the end-of file was reached before
getting all the necessary data.IOException
- If an I/O error ocurred.int readUnsignedByte() throws EOFException, IOException
EOFException
- If the end-of file was reached before
getting all the necessary data.IOException
- If an I/O error ocurred.short readShort() throws EOFException, IOException
EOFException
- If the end-of file was reached before
getting all the necessary data.IOException
- If an I/O error ocurred.int readUnsignedShort() throws EOFException, IOException
EOFException
- If the end-of file was reached before
getting all the necessary data.IOException
- If an I/O error ocurred.int readInt() throws EOFException, IOException
EOFException
- If the end-of file was reached before
getting all the necessary data.IOException
- If an I/O error ocurred.long readUnsignedInt() throws EOFException, IOException
EOFException
- If the end-of file was reached before
getting all the necessary data.IOException
- If an I/O error ocurred.long readLong() throws EOFException, IOException
EOFException
- If the end-of file was reached before
getting all the necessary data.IOException
- If an I/O error ocurred.float readFloat() throws EOFException, IOException
EOFException
- If the end-of file was reached before
getting all the necessary data.IOException
- If an I/O error ocurred.double readDouble() throws EOFException, IOException
EOFException
- If the end-of file was reached before
getting all the necessary data.IOException
- If an I/O error ocurred.int getByteOrdering()
EndianType
int skipBytes(int n) throws EOFException, IOException
n
- The number of bytes to skipEOFException
- If the end-of file was reached before
all the bytes could be skipped.IOException
- If an I/O error ocurred.Copyright © 2016 Open Microscopy Environment