uk.ac.starlink.table.storage.ByteStoreAccess Maven / Gradle / Ivy
package uk.ac.starlink.table.storage;
import java.io.IOException;
/**
* Interface for random access reading for data that has been written
* into a byte store.
* This resembles {@link java.io.DataInput}, but omits some of the methods
* there, and adds {@link #seek} and {@link #skip} methods.
* A pointer is maintained, and is advanced appropriately by the various
* read methods.
*
* @author Mark Taylor
* @since 20 Aug 2010
*/
public interface ByteStoreAccess {
/**
* Reads a byte from the current position.
*
* @return read value
*/
byte readByte() throws IOException;
/**
* Reads a short from the current position.
*
* @return read value
*/
short readShort() throws IOException;
/**
* Reads a char from the current position.
*
* @return read value
*/
char readChar() throws IOException;
/**
* Reads an int from the current position.
*
* @return read value
*/
int readInt() throws IOException;
/**
* Reads a long from the current position.
*
* @return read value
*/
long readLong() throws IOException;
/**
* Reads a float from the current position.
*
* @return read value
*/
float readFloat() throws IOException;
/**
* Reads a double from the current position.
*
* @return read value
*/
double readDouble() throws IOException;
/**
* Reads bytes into a buffer from the current position.
*
* @param b buffer to receive bytes
* @param off offset into b for first byte
* @param len number of bytes to read
*/
void readBytes( byte[] b, int off, int len ) throws IOException;
/**
* Sets the position to the given value.
*
* @param pos new position
*/
void seek( long pos ) throws IOException;
/**
* Advances the position by a given number of bytes.
*
* @param len number of bytes
*/
void skip( int len ) throws IOException;
}