freenet.support.io

Class PersistentTempFileBucket

java.lang.Object

freenet.support.io.BaseFileBucket

freenet.support.io.TempFileBucket

freenet.support.io.PersistentTempFileBucket

All Implemented Interfaces:

Bucket, RandomAccessBucket, java.io.Serializable

public class PersistentTempFileBucket
extends TempFileBucket
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAGIC

Fields inherited from class freenet.support.io.TempFileBucket

generator

Fields inherited from class freenet.support.io.BaseFileBucket

fileRestartCounter, tempDir

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PersistentTempFileBucket()
protected	PersistentTempFileBucket(java.io.DataInputStream dis)
	PersistentTempFileBucket(long id, FilenameGenerator generator, PersistentFileTracker tracker)
protected	PersistentTempFileBucket(long id, FilenameGenerator generator, PersistentFileTracker tracker, boolean deleteOnFree)

Method Summary

Modifier and Type	Method and Description
RandomAccessBucket	createShadow() Must override createShadow() so it creates a persistent bucket, which will have deleteOnExit() = deleteOnFinalize() = false.
protected boolean	deleteOnExit()
java.io.OutputStream	getOutputStream() Returns an OutputStream that is used to put data in this Bucket, from the beginning.
java.io.OutputStream	getOutputStreamUnbuffered() Get an OutputStream which is not buffered.
protected long	getPersistentTempID()
protected void	innerResume(ClientContext context)
protected int	magic()
protected boolean	persistent()

Methods inherited from class freenet.support.io.TempFileBucket

createFileOnly, deleteOnFree, equals, getFile, hashCode, isReadOnly, onResume, setReadOnly, storeTo, tempFileAlreadyExists

Methods inherited from class freenet.support.io.BaseFileBucket

deleteFile, free, free, getInputStream, getInputStreamUnbuffered, getName, getTempDir, getTempfile, setDeleteOnExit, setTempDir, size, split, toRandomAccessBuffer, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface freenet.support.api.Bucket

free, getInputStream, getInputStreamUnbuffered, getName, size

Field Detail

MAGIC

public static final int MAGIC

See Also:

Constant Field Values

Constructor Detail

PersistentTempFileBucket

public PersistentTempFileBucket(long id,
                                FilenameGenerator generator,
                                PersistentFileTracker tracker)

PersistentTempFileBucket

protected PersistentTempFileBucket(long id,
                                   FilenameGenerator generator,
                                   PersistentFileTracker tracker,
                                   boolean deleteOnFree)

PersistentTempFileBucket

protected PersistentTempFileBucket()

PersistentTempFileBucket

protected PersistentTempFileBucket(java.io.DataInputStream dis)
                            throws java.io.IOException,
                                   StorageFormatException

Throws:

java.io.IOException

StorageFormatException

Method Detail

deleteOnExit

protected boolean deleteOnExit()

Overrides:

deleteOnExit in class TempFileBucket

getOutputStreamUnbuffered

public java.io.OutputStream getOutputStreamUnbuffered()
                                               throws java.io.IOException

Description copied from interface: Bucket

Get an OutputStream which is not buffered. Should be called when we will buffer the stream at a higher level or when we will only be doing large writes (e.g. copying data from one Bucket to another). Does not make any more persistence guarantees than getOutputStream() does, this is just to save memory.

Specified by:

getOutputStreamUnbuffered in interface Bucket

Overrides:

getOutputStreamUnbuffered in class BaseFileBucket

Throws:

java.io.IOException

getOutputStream

public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException

Description copied from interface: Bucket

Returns an OutputStream that is used to put data in this Bucket, from the beginning. It is not possible to append data to a Bucket! This simplifies the code significantly for some classes. If you need to append, just pass the OutputStream around. Will be buffered if appropriate (e.g. byte array backed buckets don't need to be buffered).

Specified by:

getOutputStream in interface Bucket

Overrides:

getOutputStream in class BaseFileBucket

Throws:

java.io.IOException

createShadow

public RandomAccessBucket createShadow()

Must override createShadow() so it creates a persistent bucket, which will have deleteOnExit() = deleteOnFinalize() = false.

Specified by:

createShadow in interface Bucket

Specified by:

createShadow in interface RandomAccessBucket

Overrides:

createShadow in class TempFileBucket

innerResume

protected void innerResume(ClientContext context)
                    throws ResumeFailedException

Overrides:

innerResume in class TempFileBucket

Throws:

ResumeFailedException

persistent

protected boolean persistent()

Overrides:

persistent in class TempFileBucket

magic

protected int magic()

Overrides:

magic in class TempFileBucket

getPersistentTempID

protected long getPersistentTempID()

Overrides:

getPersistentTempID in class BaseFileBucket