Package uk.ac.starlink.fits
Class SimpleMappedInput
java.lang.Object
uk.ac.starlink.fits.SimpleMappedInput
- All Implemented Interfaces:
BasicInput
Random-access BasicInput implementation based on a single byte buffer.
Note: DO NOT use an instance
of this class from multiple threads - see Unmapper
.
- Since:
- 1 Dec 2014
- Author:
- Mark Taylor
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
This does not close the BufManager.long
Returns the curent position in this stream (optional operation).boolean
isRandom()
Indicates whether this object supports random access.byte
readByte()
Reads a byte from the stream.void
readBytes
(byte[] bbuf) Reads bytes into an array from the stream.double
Reads an 8-byte floating point value from the stream.float
Reads a 4-byte floating point value from the stream.int
readInt()
Reads a 4-byte integer from the stream.long
readLong()
Reads an 8-byte integer from the stream.short
Reads a 2-byte integer from the stream.void
seek
(long pos) Moves the current position of this stream to a given byte offset (optional operation).void
skip
(long nbyte) Skips a given number of bytes forwards through the stream.
-
Constructor Details
-
SimpleMappedInput
Constructor.- Parameters:
bufManager
- buffer manager for the file region- Throws:
IOException
-
-
Method Details
-
isRandom
public boolean isRandom()Description copied from interface:BasicInput
Indicates whether this object supports random access. The seek and getOffset methods may only be called if this method returns true.- Specified by:
isRandom
in interfaceBasicInput
- Returns:
- true iff random access is supported
-
seek
Description copied from interface:BasicInput
Moves the current position of this stream to a given byte offset (optional operation).- Specified by:
seek
in interfaceBasicInput
- Throws:
EOFException
-
getOffset
public long getOffset()Description copied from interface:BasicInput
Returns the curent position in this stream (optional operation).- Specified by:
getOffset
in interfaceBasicInput
-
skip
Description copied from interface:BasicInput
Skips a given number of bytes forwards through the stream. An exception is thrown if there are not enough bytes left.- Specified by:
skip
in interfaceBasicInput
- Parameters:
nbyte
- number of bytes to skip- Throws:
IOException
-
readByte
Description copied from interface:BasicInput
Reads a byte from the stream. The current position is advanced.- Specified by:
readByte
in interfaceBasicInput
- Returns:
- byte value
- Throws:
EOFException
-
readShort
Description copied from interface:BasicInput
Reads a 2-byte integer from the stream. The current position is advanced.- Specified by:
readShort
in interfaceBasicInput
- Returns:
- short value
- Throws:
EOFException
-
readInt
Description copied from interface:BasicInput
Reads a 4-byte integer from the stream. The current position is advanced.- Specified by:
readInt
in interfaceBasicInput
- Returns:
- int value
- Throws:
EOFException
-
readLong
Description copied from interface:BasicInput
Reads an 8-byte integer from the stream. The current position is advanced.- Specified by:
readLong
in interfaceBasicInput
- Returns:
- long value
- Throws:
EOFException
-
readFloat
Description copied from interface:BasicInput
Reads a 4-byte floating point value from the stream. The current position is advanced.- Specified by:
readFloat
in interfaceBasicInput
- Returns:
- float value
- Throws:
EOFException
-
readDouble
Description copied from interface:BasicInput
Reads an 8-byte floating point value from the stream. The current position is advanced.- Specified by:
readDouble
in interfaceBasicInput
- Returns:
- double value
- Throws:
EOFException
-
readBytes
Description copied from interface:BasicInput
Reads bytes into an array from the stream. The current position is advanced.- Specified by:
readBytes
in interfaceBasicInput
- Parameters:
bbuf
- array into which the bytes are read; the number of bytes read is the length of the array- Throws:
EOFException
-
close
public void close()This does not close the BufManager.- Specified by:
close
in interfaceBasicInput
-