com.palantir.giraffe.file

Class TempPath

java.lang.Object

com.palantir.giraffe.file.TempPath

All Implemented Interfaces:

AutoCloseable

public final class TempPath
extends Object
implements AutoCloseable

A temporary path that is deleted when closed.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this path, deleting the file or directory if it exists.
static TempPath	createDirectory() Creates a new temporary directory in the default temporary file location.
static TempPath	createDirectory(Path dir) Creates a new temporary directory in the specified directory.
static TempPath	createFile() Creates a new temporary file in the default temporary file location.
static TempPath	createFile(Path dir) Creates a new temporary file in the specified directory.
Path	path() Returns the Path to the temporary file or directory.
String	toString()
static TempPath	wrap(Path path) Wraps an existing Path as a TempPath.

Methods inherited from class java.lang.Object

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

Method Detail

createDirectory

public static TempPath createDirectory()
                                throws IOException

Creates a new temporary directory in the default temporary file location.

Throws:

IOException - if an I/O error occurs while creating the directory

createDirectory

public static TempPath createDirectory(Path dir)
                                throws IOException

Creates a new temporary directory in the specified directory.

Throws:

IOException - if an I/O error occurs while creating the directory

createFile

public static TempPath createFile()
                           throws IOException

Creates a new temporary file in the default temporary file location.

Throws:

IOException - if an I/O error occurs while creating the file

createFile

public static TempPath createFile(Path dir)
                           throws IOException

Creates a new temporary file in the specified directory.

Throws:

IOException - if an I/O error occurs while creating the file

wrap

public static TempPath wrap(Path path)

Wraps an existing Path as a TempPath. To allow reasoning about deletion, all access to the delegate path should use the returned wrapper.

Parameters:

path - the path to wrap

path

public Path path()

Returns the Path to the temporary file or directory.

Clients must take care to avoid leaking the returned reference outside the scope of a surrounding try-with-resources block, as the path is deleted when this object is closed.

Throws:

IllegalStateException - if this path is closed

close

public void close()
           throws IOException

Closes this path, deleting the file or directory if it exists. If this path is already closed, this method has no effect.

Specified by:

close in interface AutoCloseable

Throws:

IOException - if an I/O error occurs while deleting this path

toString

public String toString()

Overrides:

toString in class Object