Package org.cactoos.io

Class TempFile

java.lang.Object

org.cactoos.io.TempFile

All Implemented Interfaces:

Closeable, AutoCloseable, Scalar<Path>

public final class TempFile
extends Object
implements Scalar<Path>, Closeable

A temporary file.

These are ephemeral files to be used in small scopes. Typical use looks like this:

    try (final TempFile file = new TempFile()) {
       //write to the file
    }
 

The physical file is deleted from the filesystem when the temp file is closed.

Since:

1.0

Constructor Summary

Constructors

Constructor	Description
TempFile()	Ctor.
TempFile(String prefix, String suffix)	Ctor.
TempFile(Scalar<Path> dir, String prefix, String suffix)	Ctor.
TempFile(Scalar<Path> dir, Text prefix, Text suffix)	Ctor.
TempFile(Text prefix, Text suffix)	Ctor.

Method Summary

Modifier and Type	Method	Description
void	close()	Deletes the file from the filesystem.
Path	value()	Convert it to the value.

Methods inherited from class java.lang.Object

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

Constructor Detail

TempFile

public TempFile()

Ctor.

Specifies empty strings for suffix and prefix, and creates the file in the filesystem's temporary directory denoted by the system property java.io.tmpdir.

Since:

1.0

TempFile

public TempFile(String prefix,
                String suffix)

Ctor.

The temporary file will be created inside the filesystem's temporary folder (system property: java.io.tmpdir).

Parameters:

prefix - The temp filename's prefix

suffix - The temp filename's suffix

Since:

1.0

TempFile

public TempFile(Text prefix,
                Text suffix)

Ctor.

The temporary file will be created inside the filesystem's temporary folder (system property: java.io.tmpdir).

Parameters:

prefix - The temp filename's prefix

suffix - The temp filename's suffix

Since:

1.0

TempFile

public TempFile(Scalar<Path> dir,
                String prefix,
                String suffix)

Ctor.

Parameters:

dir - The directory in which to create the temp file

prefix - The temp filename's prefix

suffix - The temp filename's suffix

Since:

1.0

TempFile

public TempFile(Scalar<Path> dir,
                Text prefix,
                Text suffix)

Ctor.

Parameters:

dir - The directory in which to create the temp file

prefix - The temp filename's prefix

suffix - The temp filename's suffix

Since:

1.0

Method Detail

value

public Path value()
           throws Exception

Description copied from interface: Scalar

Convert it to the value.

Specified by:

value in interface Scalar<Path>

Returns:

The value

Throws:

Exception - If fails

close

public void close()
           throws IOException

Deletes the file from the filesystem.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException