Interface RandomAccess

All Superinterfaces:

ArrayDataInput, AutoCloseable, Closeable, DataInput, FitsIO, InputReader, OutputWriter, ReadWriteAccess

All Known Implementing Classes:

BufferedFile, FitsFile

public interface RandomAccess
extends ReadWriteAccess, ArrayDataInput

Interface that combines file-based random acesss with high-throughput array IO

Field Summary

Fields inherited from interface FitsIO

BITS_OF_1_BYTE, BITS_OF_2_BYTES, BITS_OF_3_BYTES, BITS_OF_4_BYTES, BITS_OF_5_BYTES, BITS_OF_6_BYTES, BITS_OF_7_BYTES, BYTE_1_OF_LONG_MASK, BYTE_2_OF_LONG_MASK, BYTE_3_OF_LONG_MASK, BYTE_4_OF_LONG_MASK, BYTE_MASK, BYTES_IN_BOOLEAN, BYTES_IN_BYTE, BYTES_IN_CHAR, BYTES_IN_DOUBLE, BYTES_IN_FLOAT, BYTES_IN_INTEGER, BYTES_IN_LONG, BYTES_IN_SHORT, DEFAULT_BUFFER_SIZE, HIGH_INTEGER_MASK, INTEGER_MASK, SHORT_MASK, SHORT_OF_LONG_MASK

Modifier and Type	Field	Description
static final int	BITS_OF_1_BYTE	number of bits in one byte.
static final int	BITS_OF_2_BYTES	number of bits in two byte.
static final int	BITS_OF_3_BYTES	number of bits in three byte.
static final int	BITS_OF_4_BYTES	number of bits in four byte.
static final int	BITS_OF_5_BYTES	number of bits in five byte.
static final int	BITS_OF_6_BYTES	number of bits in six byte.
static final int	BITS_OF_7_BYTES	number of bits in seven byte.
static final long	BYTE_1_OF_LONG_MASK	bit mask to get the lowest byte of a long.
static final long	BYTE_2_OF_LONG_MASK	bit mask to get the second lowest byte of a long.
static final long	BYTE_3_OF_LONG_MASK	bit mask to get the third lowest byte of a long.
static final long	BYTE_4_OF_LONG_MASK	bit mask to get the fourth lowest byte of a long.
static final int	BYTE_MASK	bit mask to get the lowest byte from an integer.
static final int	BYTES_IN_BOOLEAN	number of bytes occupied by a boolean.
static final int	BYTES_IN_BYTE	number of bytes occupied by a byte.
static final int	BYTES_IN_CHAR	number of bytes occupied by a char.
static final int	BYTES_IN_DOUBLE	number of bytes occupied by a double.
static final int	BYTES_IN_FLOAT	number of bytes occupied by a float.
static final int	BYTES_IN_INTEGER	number of bytes occupied by a integer.
static final int	BYTES_IN_LONG	number of bytes occupied by a long.
static final int	BYTES_IN_SHORT	number of bytes occupied by a short.
static final int	DEFAULT_BUFFER_SIZE	default buffer size to use unless specified otherwise.
static final long	HIGH_INTEGER_MASK	bit mask to get the highest integer from an long.
static final long	INTEGER_MASK	bit mask to get the lowest integer from an long.
static final int	SHORT_MASK	bit mask to get the lowest short of a integer.
static final long	SHORT_OF_LONG_MASK	bit mask to get the lowest short of a long.

Method Summary

Modifier and Type	Method	Description
long	getFilePointer()	Returns the current offset from the beginning of the input.
default long	position()	Returns the current read/write position in this instance.
default void	position(long pos)	Sets a new position for the next read or write in this instance.
void	seek(long offsetFromStart)	Move to a specified location in the stream.

Methods inherited from interface ArrayDataInput

mark, markSupported, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, readArray, readArrayFully, readFully, readImage, readLArray, reset, skip, skipAllBytes, skipAllBytes

Modifier and Type	Method	Description
void	mark(int readlimit)	See the general contract of the mark method of InputStream.
default boolean	markSupported()	See the general contract of the markSupported method of InputStream.
default int	read(boolean[] buf)	Read an array of boolean's.
int	read(boolean[] buf, int offset, int size)	Read a segment of an array of boolean's.
int	read(byte[] buf)	Read an array of byte's.
default int	read(char[] buf)	Read an array of char's.
int	read(char[] buf, int offset, int size)	Read a segment of an array of char's.
default int	read(double[] buf)	Read an array of double's.
int	read(double[] buf, int offset, int size)	Read a segment of an array of double's.
default int	read(float[] buf)	Read an array of float's.
int	read(float[] buf, int offset, int size)	Read a segment of an array of float's.
default int	read(int[] buf)	Read an array of int's.
int	read(int[] buf, int offset, int size)	Read a segment of an array of int's.
default int	read(long[] buf)	Read a segment of an array of long's.
int	read(long[] buf, int offset, int size)	Read a segment of an array of long's.
default int	read(short[] buf)	Read an array of short's.
int	read(short[] buf, int offset, int size)	Read a segment of an array of short's.
default int	read(Boolean[] buf)	Read an array of booleans, possibly including legal null values.
default int	read(Boolean[] buf, int offset, int size)	Reads into an array of booleans, possibly including legal null values.
default int	readArray(Object o)	Deprecated. Use ArrayDataInput.readLArray(Object) instead.
default void	readArrayFully(Object o)	Reads a Java array from the input, populating all elements, or else throwing and EOFException.
void	readFully(byte[] b, int off, int len)
default void	readImage(Object o)	Like ArrayDataInput.readArrayFully(Object) but strictly for numerical types only.
long	readLArray(Object o)	Reads a Java array from the input, translating it from its binary representation to Java data format.
void	reset()	See the general contract of the reset method of InputStream.
long	skip(long distance)	Skip the number of bytes.
default void	skipAllBytes(int toSkip)	Deprecated. This call is handled by ArrayDataInput.skipAllBytes(long), without the need for a separate implementation.
void	skipAllBytes(long toSkip)	Skips a number of bytes from the input.

Methods inherited from interface DataInput

readBoolean, readByte, readChar, readDouble, readFloat, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedShort, readUTF, skipBytes

Methods inherited from interface FitsIO

close

Modifier and Type	Method	Description
void	close()

Methods inherited from interface InputReader

read, read

Modifier and Type	Method	Description
int	read()	Reads a byte.
int	read(byte[] b, int from, int length)	Reads up to the specified number of bytes into a buffer.

Methods inherited from interface OutputWriter

write, write

Modifier and Type	Method	Description
void	write(byte[] b, int from, int length)	Writes up to the specified number of bytes from a buffer to the stream.
void	write(int b)	Writes a byte.

Methods inherited from interface ReadWriteAccess

length

Modifier and Type	Method	Description
long	length()	Returns the current total length of this instance, that is the total number of bytes that may be read from it.

Method Details

getFilePointer

long getFilePointer()

Returns the current offset from the beginning of the input.

Returns:

the current position in the stream.

seek

void seek(long offsetFromStart)
   throws IOException

Move to a specified location in the stream.

Parameters:

offsetFromStart - set the offset messured from the start

Throws:

IOException - if the operation fails

position

default long position()
               throws IOException

Description copied from interface: ReadWriteAccess

Returns the current read/write position in this instance. The position may exceed the length, depending on implementation, just as seek may go beyond the file size in RandomAccessFile.

Specified by:

position in interface ReadWriteAccess

Returns:

the current read/write position.

Throws:

IOException - if there was an IO error.

See Also:

• ReadWriteAccess.position(long)
• ReadWriteAccess.length()

position

default void position(long pos)
               throws IOException

Description copied from interface: ReadWriteAccess

Sets a new position for the next read or write in this instance. The position may exceed the length, depending on implementation, just as seek may go beyond the file size in RandomAccessFile.

Specified by:

position in interface ReadWriteAccess

Parameters:

pos - the new read/write position.

Throws:

IOException - if there was an IO error.

See Also:

• ReadWriteAccess.position()
• ReadWriteAccess.length()