loci.common

Interface IRandomAccess

All Superinterfaces:

DataInput, DataOutput

All Known Implementing Classes:

AbstractNIOHandle, ByteArrayHandle, BZip2Handle, FileHandle, GZipHandle, NIOFileHandle, StreamHandle, URLHandle, ZipHandle

public interface IRandomAccess
extends DataInput, DataOutput

Interface for random access into structures (e.g., files or arrays).

Author:

Curtis Rueden ctrueden at wisc.edu

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this random access stream and releases any system resources associated with the stream.
long	getFilePointer() Returns the current offset in this stream.
ByteOrder	getOrder() Returns the current order of the stream.
long	length() Returns the length of this stream.
int	read(byte[] b) Reads up to b.length bytes of data from this stream into an array of bytes.
int	read(byte[] b, int off, int len) Reads up to len bytes of data from this stream into an array of bytes.
int	read(ByteBuffer buffer) Reads up to buffer.capacity() bytes of data from this stream into a ByteBuffer.
int	read(ByteBuffer buffer, int offset, int len) Reads up to len bytes of data from this stream into a ByteBuffer.
void	seek(long pos) Sets the stream pointer offset, measured from the beginning of this stream, at which the next read or write occurs.
void	setOrder(ByteOrder order) Sets the byte order of the stream.
void	write(ByteBuffer buf) Writes up to buffer.capacity() bytes of data from the given ByteBuffer to this stream.
void	write(ByteBuffer buf, int off, int len) Writes up to len bytes of data from the given ByteBuffer to this stream.

Methods inherited from interface java.io.DataInput

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

Methods inherited from interface java.io.DataOutput

write, write, write, writeBoolean, writeByte, writeBytes, writeChar, writeChars, writeDouble, writeFloat, writeInt, writeLong, writeShort, writeUTF

Method Detail

close

void close()
           throws IOException

Closes this random access stream and releases any system resources associated with the stream.

Throws:

IOException

getFilePointer

long getFilePointer()
                    throws IOException

Returns the current offset in this stream.

Throws:

IOException

length

long length()
            throws IOException

Returns the length of this stream.

Throws:

IOException

getOrder

ByteOrder getOrder()

Returns the current order of the stream.

Returns:

See above.

setOrder

void setOrder(ByteOrder order)

Sets the byte order of the stream.

Parameters:

order - Order to set.

read

int read(byte[] b)
         throws IOException

Reads up to b.length bytes of data from this stream into an array of bytes.

Returns:

the total number of bytes read into the buffer.

Throws:

IOException

read

int read(byte[] b,
       int off,
       int len)
         throws IOException

Reads up to len bytes of data from this stream into an array of bytes.

Returns:

the total number of bytes read into the buffer.

Throws:

IOException

read

int read(ByteBuffer buffer)
         throws IOException

Reads up to buffer.capacity() bytes of data from this stream into a ByteBuffer.

Throws:

IOException

read

int read(ByteBuffer buffer,
       int offset,
       int len)
         throws IOException

Reads up to len bytes of data from this stream into a ByteBuffer.

Returns:

the total number of bytes read into the buffer.

Throws:

IOException

seek

void seek(long pos)
          throws IOException

Sets the stream pointer offset, measured from the beginning of this stream, at which the next read or write occurs.

Throws:

IOException

write

void write(ByteBuffer buf)
           throws IOException

Writes up to buffer.capacity() bytes of data from the given ByteBuffer to this stream.

Throws:

IOException

write

void write(ByteBuffer buf,
         int off,
         int len)
           throws IOException

Writes up to len bytes of data from the given ByteBuffer to this stream.

Throws:

IOException