auxtestlib

Class TemporaryFile

java.lang.Object

auxtestlib.TemporaryFile

public class TemporaryFile
extends Object

Class that creates a temporary file or directory. This file or directory is removed when the JVM terminates (it may be deleted sooner if the delete() method is called explicitly). If the created file is a directory, it will be removed recursively.

Constructor Summary

Constructors

Constructor and Description
TemporaryFile(boolean directory) Creates a new temporary file (or directory).
TemporaryFile(File path, boolean directory, String prefix, String suffix) Creates a new file (or directory).

Method Summary

Modifier and Type	Method and Description
void	delete() Deletes the file or directory.
File	file() Obtains a reference to the created file.
File	getFile() Deprecated. use file() instead

Methods inherited from class java.lang.Object

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

Constructor Detail

TemporaryFile

public TemporaryFile(boolean directory)
              throws IOException

Creates a new temporary file (or directory). This is equivalent to call TemporaryFile(File, boolean, String, String) with all other arguments as null.

Parameters:

directory - should a directory be created? If false a file is created

Throws:

IOException - failed to create the file

TemporaryFile

public TemporaryFile(File path,
                     boolean directory,
                     String prefix,
                     String suffix)
              throws IOException

Creates a new file (or directory).

Parameters:

path - path to the parent directory. If null the file/directory will be created on the default location.

directory - should a directory be created? If false a file is created

prefix - an optional prefix for the file (it a prefix is provided it must contain at least 3 characters).

suffix - an optional suffix for the file

Throws:

IOException - failed to create the file

Method Detail

getFile

@Deprecated
public File getFile()

Deprecated. use file() instead

Obtains a reference to the created file.

Returns:

the created file (or directory).

file

public File file()

Obtains a reference to the created file.

Returns:

the created file (or directory).

delete

public void delete()

Deletes the file or directory. If this represents a directory, all its contents are recursively deleted.