freenet.support.io

Class ByteArrayRandomAccessBuffer

java.lang.Object

freenet.support.io.ByteArrayRandomAccessBuffer

All Implemented Interfaces:

LockableRandomAccessBuffer, RandomAccessBuffer, java.io.Closeable, java.io.Serializable, java.lang.AutoCloseable

public class ByteArrayRandomAccessBuffer
extends java.lang.Object
implements LockableRandomAccessBuffer, java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface freenet.support.api.LockableRandomAccessBuffer

LockableRandomAccessBuffer.RAFLock

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ByteArrayRandomAccessBuffer()
	ByteArrayRandomAccessBuffer(byte[] padded)
	ByteArrayRandomAccessBuffer(byte[] initialContents, int offset, int size, boolean readOnly)
	ByteArrayRandomAccessBuffer(int size)

Method Summary

Modifier and Type	Method and Description
void	close()
void	free() Free the underlying resources.
boolean	isReadOnly()
LockableRandomAccessBuffer.RAFLock	lockOpen() Keep the RAF open.
void	onResume(ClientContext context) Called on resuming, i.e.
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)
void	setReadOnly()
long	size()
void	storeTo(java.io.DataOutputStream dos) Write enough data to reconstruct the Bucket, or throw UnsupportedOperationException.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface freenet.support.api.LockableRandomAccessBuffer

equals, hashCode

Constructor Detail

ByteArrayRandomAccessBuffer

public ByteArrayRandomAccessBuffer(byte[] padded)

ByteArrayRandomAccessBuffer

public ByteArrayRandomAccessBuffer(int size)

ByteArrayRandomAccessBuffer

public ByteArrayRandomAccessBuffer(byte[] initialContents,
                                   int offset,
                                   int size,
                                   boolean readOnly)

ByteArrayRandomAccessBuffer

protected ByteArrayRandomAccessBuffer()

Method Detail

close

public void close()

Specified by:

close in interface RandomAccessBuffer

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

pread

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

Description copied from interface: RandomAccessBuffer

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.

Specified by:

pread in interface RandomAccessBuffer

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.

pwrite

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

Specified by:

pwrite in interface RandomAccessBuffer

Throws:

java.io.IOException

size

public long size()

Specified by:

size in interface RandomAccessBuffer

setReadOnly

public void setReadOnly()

isReadOnly

public boolean isReadOnly()

lockOpen

public LockableRandomAccessBuffer.RAFLock lockOpen()

Description copied from interface: LockableRandomAccessBuffer

Keep the RAF open. Does not prevent others from writing to it. Will block until a slot is available if necessary. Hence can deadlock.

Specified by:

lockOpen in interface LockableRandomAccessBuffer

free

public void free()

Description copied from interface: RandomAccessBuffer

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

Specified by:

free in interface RandomAccessBuffer

onResume

public void onResume(ClientContext context)

Description copied from interface: LockableRandomAccessBuffer

Called on resuming, i.e. after serialization. Use to e.g. register with the list of temporary files.

Specified by:

onResume in interface LockableRandomAccessBuffer

storeTo

public void storeTo(java.io.DataOutputStream dos)

Description copied from interface: LockableRandomAccessBuffer

Write enough data to reconstruct the Bucket, or throw UnsupportedOperationException. Used for recovering in emergencies, should be versioned if necessary. To make this work, write a fixed, unique integer magic value for the class, and add a clause to BucketTools.restoreRAFFrom().

Specified by:

storeTo in interface LockableRandomAccessBuffer