org.apache.pdfbox.io

Class ScratchFile

java.lang.Object

org.apache.pdfbox.io.ScratchFile

All Implemented Interfaces:

Closeable, AutoCloseable

public class ScratchFile
extends Object
implements Closeable

A temporary file which can hold multiple buffers of temporary data. A new temporary file is created for each new ScratchFile instance, and is deleted when the ScratchFile is closed.

Multiple buffers can be creating by calling the createBuffer() method.

The file is split into pages, each page containing a pointer to the previous and next pages. This allows for multiple, separate streams in the same file.

Author:

Jesse Long

Constructor Summary

Constructors

Constructor and Description
ScratchFile(File scratchFileDirectory) Creates a new scratch file.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes and deletes the temporary file.
RandomAccess	createBuffer() Creates a new buffer in the scratch file.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScratchFile

public ScratchFile(File scratchFileDirectory)
            throws IOException

Creates a new scratch file. If a {code scratchFileDirectory} is supplied, then the scratch file is created in that directory.

Parameters:

scratchFileDirectory - The directory in which to create the scratch file, or {code null} if the scratch should be created in the default temporary directory.

Throws:

IOException - If there was a problem creating a temporary file.

Method Detail

createBuffer

public RandomAccess createBuffer()
                          throws IOException

Creates a new buffer in the scratch file.

Returns:

A new buffer.

Throws:

IOException - If an error occurred.

close

public void close()
           throws IOException

Closes and deletes the temporary file. No further interaction with the scratch file or associated buffers can happen after this method is called.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - If there was a problem closing or deleting the temporary file.