freenet.support.api

Interface LockableRandomAccessBufferFactory

All Known Implementing Classes:

ByteArrayRandomAccessBufferFactory, DiskSpaceCheckingRandomAccessBufferFactory, MaybeEncryptedRandomAccessBufferFactory, PooledFileRandomAccessBufferFactory, TempBucketFactory

public interface LockableRandomAccessBufferFactory

Serves a similar function to BucketFactory. Different factories may serve different functions e.g. temporary storage (not persistent across restarts) only.

Method Summary

Modifier and Type	Method and Description
LockableRandomAccessBuffer	makeRAF(byte[] initialContents, int offset, int size, boolean readOnly) Create a bucket with specified initial contents.
LockableRandomAccessBuffer	makeRAF(long size) Create a bucket.

Method Detail

makeRAF

LockableRandomAccessBuffer makeRAF(long size)
                            throws java.io.IOException

Create a bucket.

Parameters:

size - The maximum size of the data. Most factories will pre-allocate this space, and it may not be exceeded. However we do not guarantee that any I/O operation will complete; even if we have pre-allocated the disk space, we may be unable to write to it because of e.g. a hardware error.

Returns:

A LockableRandomAccessBuffer of the requested size.

Throws:

java.io.IOException - If an I/O error prevented the operation.

java.lang.IllegalArgumentException - If size < 0.

makeRAF

LockableRandomAccessBuffer makeRAF(byte[] initialContents,
                                   int offset,
                                   int size,
                                   boolean readOnly)
                            throws java.io.IOException

Create a bucket with specified initial contents.

Parameters:

initialContents - Byte array from which to copy data. Data will be copied even if the underlying implementation is a byte array, for reasons of consistency.

offset - Offset within the array to start copying data from.

size - Number of bytes to copy i.e. length of the new RandomAccessBuffer.

Returns:

Throws:

java.io.IOException - If an I/O error prevented the operation.