freenet.support.api

Interface RandomAccessBucket

All Superinterfaces:

Bucket

All Known Implementing Classes:

ArrayBucket, BaseFileBucket, DelayedFreeRandomAccessBucket, EncryptedRandomAccessBucket, FileBucket, NullBucket, PaddedRandomAccessBucket, PersistentTempFileBucket, RAFBucket, SimpleReadOnlyArrayBucket, TempBucketFactory.TempBucket, TempFileBucket

public interface RandomAccessBucket
extends Bucket

A Bucket which can be converted to a LockableRandomAccessBuffer without copying. Mostly we need this where the size of something we will later use as a RandomAccessBuffer is uncertain. It provides a separate object because the API's are incompatible; in particular, the size of a RandomAccessBuffer is fixed (and this is mostly a good thing). FINALIZERS: Persistent RandomAccessBucket's should never free on finalize. Transient RABs can free on finalize, but must ensure that this only happens if both the Bucket and the RAB are no longer reachable.

Method Summary

Modifier and Type	Method and Description
RandomAccessBucket	createShadow() Create a shallow read-only copy of this bucket, using different objects but using the same external storage.
LockableRandomAccessBuffer	toRandomAccessBuffer() Convert the Bucket to a LockableRandomAccessBuffer.

Methods inherited from interface freenet.support.api.Bucket

free, getInputStream, getInputStreamUnbuffered, getName, getOutputStream, getOutputStreamUnbuffered, isReadOnly, onResume, setReadOnly, size, storeTo

Method Detail

toRandomAccessBuffer

LockableRandomAccessBuffer toRandomAccessBuffer()
                                         throws java.io.IOException

Convert the Bucket to a LockableRandomAccessBuffer. Must be efficient, i.e. will not copy the data. Freeing the Bucket is unnecessary if you free the LockableRandomAccessBuffer. Both the parent Bucket and the return value will be made read only.

Throws:

java.io.IOException

createShadow

RandomAccessBucket createShadow()

Description copied from interface: Bucket

Create a shallow read-only copy of this bucket, using different objects but using the same external storage. If this is not possible, return null. Note that if the underlying bucket is deleted, the copy will become invalid and probably throw an IOException on read, or possibly return too-short data etc. In some use cases e.g. on fproxy, this is acceptable.

Specified by:

createShadow in interface Bucket