Package jj2000.j2k.io
Interface BinaryDataInput
-
- All Known Subinterfaces:
RandomAccessIO
- All Known Implementing Classes:
BEBufferedRandomAccessFile
,BufferedRandomAccessFile
,IISRandomAccessIO
,ISRandomAccessIO
public interface BinaryDataInput
This interface defines the input of binary data from streams and/or files.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).
- See Also:
EndianType
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method 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.
-
-
-
Method Detail
-
readByte
byte readByte() throws EOFException, IOException
Should read a signed byte (i.e., 8 bit) from the input. reading, the input should be realigned at the byte level.- Returns:
- The next byte-aligned signed byte (8 bit) from the input.
- Throws:
EOFException
- If the end-of file was reached before getting all the necessary data.IOException
- If an I/O error ocurred.
-
readUnsignedByte
int readUnsignedByte() throws EOFException, IOException
Should read an unsigned byte (i.e., 8 bit) from the input. It is returned as an int since Java does not have an unsigned byte type. Prior to reading, the input should be realigned at the byte level.- Returns:
- The next byte-aligned unsigned byte (8 bit) from the input, as an int.
- Throws:
EOFException
- If the end-of file was reached before getting all the necessary data.IOException
- If an I/O error ocurred.
-
readShort
short readShort() throws EOFException, IOException
Should read a signed short (i.e., 16 bit) from the input. Prior to reading, the input should be realigned at the byte level.- Returns:
- The next byte-aligned signed short (16 bit) from the input.
- Throws:
EOFException
- If the end-of file was reached before getting all the necessary data.IOException
- If an I/O error ocurred.
-
readUnsignedShort
int readUnsignedShort() throws EOFException, IOException
Should read an unsigned short (i.e., 16 bit) from the input. It is returned as an int since Java does not have an unsigned short type. Prior to reading, the input should be realigned at the byte level.- Returns:
- The next byte-aligned unsigned short (16 bit) from the input, as an int.
- Throws:
EOFException
- If the end-of file was reached before getting all the necessary data.IOException
- If an I/O error ocurred.
-
readInt
int readInt() throws EOFException, IOException
Should read a signed int (i.e., 32 bit) from the input. Prior to reading, the input should be realigned at the byte level.- Returns:
- The next byte-aligned signed int (32 bit) from the input.
- Throws:
EOFException
- If the end-of file was reached before getting all the necessary data.IOException
- If an I/O error ocurred.
-
readUnsignedInt
long readUnsignedInt() throws EOFException, IOException
Should read an unsigned int (i.e., 32 bit) from the input. It is returned as a long since Java does not have an unsigned short type. Prior to reading, the input should be realigned at the byte level.- Returns:
- The next byte-aligned unsigned int (32 bit) from the input, as a long.
- Throws:
EOFException
- If the end-of file was reached before getting all the necessary data.IOException
- If an I/O error ocurred.
-
readLong
long readLong() throws EOFException, IOException
Should read a signed long (i.e., 64 bit) from the input. Prior to reading, the input should be realigned at the byte level.- Returns:
- The next byte-aligned signed long (64 bit) from the input.
- Throws:
EOFException
- If the end-of file was reached before getting all the necessary data.IOException
- If an I/O error ocurred.
-
readFloat
float readFloat() throws EOFException, IOException
Should read an IEEE single precision (i.e., 32 bit) floating-point number from the input. Prior to reading, the input should be realigned at the byte level.- Returns:
- The next byte-aligned IEEE float (32 bit) from the input.
- Throws:
EOFException
- If the end-of file was reached before getting all the necessary data.IOException
- If an I/O error ocurred.
-
readDouble
double readDouble() throws EOFException, IOException
Should read an IEEE double precision (i.e., 64 bit) floating-point number from the input. Prior to reading, the input should be realigned at the byte level.- Returns:
- The next byte-aligned IEEE double (64 bit) from the input.
- Throws:
EOFException
- If the end-of file was reached before getting all the necessary data.IOException
- If an I/O error ocurred.
-
getByteOrdering
int getByteOrdering()
Returns the endianess (i.e., byte ordering) of the implementing class. Note that an implementing class may implement only one type of endianness or both, which would be decided at creatiuon time.- Returns:
- Either EndianType.BIG_ENDIAN or EndianType.LITTLE_ENDIAN
- See Also:
EndianType
-
skipBytes
int skipBytes(int n) throws EOFException, IOException
Skips n bytes from the input. Prior to skipping, the input should be realigned at the byte level.- Parameters:
n
- The number of bytes to skip- Throws:
EOFException
- If the end-of file was reached before all the bytes could be skipped.IOException
- If an I/O error ocurred.
-
-