de.innovationgate.utils

Class TemporaryFile

java.lang.Object

de.innovationgate.utils.TemporaryFile

public class TemporaryFile
extends java.lang.Object

A helper object to use temporary files that must have a special file name in file system. The object does not directly drop the temporary file in the temp folder but creates a parent directory with temporary name to drop it in there. Because of this the file may have any file name desired.

The file and directory will NOT be automatically deleted on VM termination anymore (see B000048C2). They should be manually deleted by calling delete() when you are finished with them, or be bound to the eviction of a context object by using deleteOnEviction(Object).

Constructor Summary

Constructors

Constructor and Description
TemporaryFile(java.lang.String name, java.io.InputStream in, java.io.File tempFolder) Constructs a temporary file object and initializes it with the data from an input stream If the input stream that is providing data is a java.util.zip.ZipInputStream it is NOT closed after the file data is read (to allow further reading of other file entries in the zip data)!

Method Summary

Methods

Modifier and Type	Method and Description
java.io.OutputStream	createOutputStream() Creates an output stream to write binary data to the file.
java.io.PrintWriter	createWriter() Creates a writer to write UTF-8 character data to the file.
java.io.PrintWriter	createWriter(java.lang.String charset) Creates a writer to write character data to the file.
void	delete() Manually delete the temporary file and it's temporary directory
void	deleteOnEviction(java.lang.Object obj) Will keep the file alive until the given object is garbage-collected.
java.io.File	getFile() The temporary file as Java file object
static void	stopEviction() Stops the eviction thread

Methods inherited from class java.lang.Object

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

Constructor Detail

TemporaryFile

public TemporaryFile(java.lang.String name,
             java.io.InputStream in,
             java.io.File tempFolder)
              throws java.io.IOException

Constructs a temporary file object and initializes it with the data from an input stream

If the input stream that is providing data is a java.util.zip.ZipInputStream it is NOT closed after the file data is read (to allow further reading of other file entries in the zip data)! All other stream types are closed automatically after object creation.

Parameters:

name - The name that file should have in file system

in - The input stream providing data for the temporary file. Omit to leave the file empty

tempFolder - The temp folder containing temporary files

Throws:

java.io.IOException

Method Detail

stopEviction

public static void stopEviction()

Stops the eviction thread

delete

public void delete()

Manually delete the temporary file and it's temporary directory

deleteOnEviction

public void deleteOnEviction(java.lang.Object obj)

Will keep the file alive until the given object is garbage-collected. Then the file will be deleted

Parameters:

obj -

getFile

public java.io.File getFile()

The temporary file as Java file object

createWriter

public java.io.PrintWriter createWriter(java.lang.String charset)
                                 throws java.io.UnsupportedEncodingException,
                                        java.io.FileNotFoundException

Creates a writer to write character data to the file.

Parameters:

charset - Target charset of the file

Throws:

java.io.FileNotFoundException

java.io.UnsupportedEncodingException

createWriter

public java.io.PrintWriter createWriter()
                                 throws java.io.UnsupportedEncodingException,
                                        java.io.FileNotFoundException

Creates a writer to write UTF-8 character data to the file.

Throws:

java.io.FileNotFoundException

java.io.UnsupportedEncodingException

createOutputStream

public java.io.OutputStream createOutputStream()
                                        throws java.io.FileNotFoundException

Creates an output stream to write binary data to the file.

Throws:

java.io.FileNotFoundException