freenet.support.api

Interface RandomAccessBuffer

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Subinterfaces:

LockableRandomAccessBuffer

All Known Implementing Classes:

ByteArrayRandomAccessBuffer, DelayedFreeRandomAccessBuffer, EncryptedRandomAccessBuffer, FileRandomAccessBuffer, NullRandomAccessBuffer, PaddedRandomAccessBuffer, PooledFileRandomAccessBuffer, ReadOnlyRandomAccessBuffer

public interface RandomAccessBuffer
extends java.io.Closeable

Trivial random access file base interface. Guaranteed to be thread-safe - that is, either the implementation will serialise reads, or it will support parallel reads natively. The length of the file is constant. Many implementations will provide a nulling constructor - one that takes a size and creates a RandomAccessBuffer of that length whose content is all 0's.

Method Summary

Modifier and Type	Method and Description
void	close()
void	free() Free the underlying resources.
void	pread(long fileOffset, byte[] buf, int bufOffset, int length) Read a block of data from a specific location in the file.
void	pwrite(long fileOffset, byte[] buf, int bufOffset, int length)
long	size()

Method Detail

size

long size()

pread

void pread(long fileOffset,
           byte[] buf,
           int bufOffset,
           int length)
    throws java.io.IOException

Read a block of data from a specific location in the file. Guaranteed to read the whole range or to throw, like DataInputStream.readFully(). Must throw if the file is closed.

Parameters:

fileOffset - The offset within the file to read from.

buf - The buffer to write to.

bufOffset - The offset within the buffer to the first read byte.

length - The length of data to read.

Throws:

java.io.IOException - If we were unable to read the required number of bytes etc.

java.lang.IllegalArgumentException - If fileOffset is negative.

pwrite

void pwrite(long fileOffset,
            byte[] buf,
            int bufOffset,
            int length)
     throws java.io.IOException

Throws:

java.io.IOException

close

void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

free

void free()

Free the underlying resources. May do nothing in some implementations. You should make sure the object can be GC'ed as well.