org.embulk.spi

Class TempFileSpace

java.lang.Object

org.embulk.spi.TempFileSpace

public abstract class TempFileSpace
extends Object

Manages a space for temporary files.

Plugins are expected to get this through Exec.getTempFileSpace().

Since:

0.6.16

Constructor Summary

Constructors

Constructor and Description
TempFileSpace(File dir) Deprecated. The constructor is no longer available. Use Exec.getTempFileSpace() instead.

Method Summary

Modifier and Type	Method and Description
abstract void	cleanup() Cleans up the temporary file space, and everything in the space.
abstract File	createTempFile() Creates a temporary file in the space, with the default file name prefix, and the default file extension suffix.
abstract File	createTempFile(String fileExt) Creates a temporary file in the space, with the default file name prefix, and the specified file extension suffix.
abstract File	createTempFile(String prefix, String fileExt) Creates a temporary file in the space, with the specified file name prefix, and the specified file extension suffix.
static TempFileSpace	with(Path baseDir, String prefix) Deprecated. The static creator method is no longer available. Use Exec.getTempFileSpace() instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

TempFileSpace

@Deprecated
public TempFileSpace(File dir)

Deprecated. The constructor is no longer available. Use Exec.getTempFileSpace() instead.

Since:

0.6.16

Method Detail

with

@Deprecated
public static TempFileSpace with(Path baseDir,
                                             String prefix)
                                      throws IOException

Deprecated. The static creator method is no longer available. Use Exec.getTempFileSpace() instead.

Throws:

IOException

Since:

0.9.20

createTempFile

public abstract File createTempFile()

Creates a temporary file in the space, with the default file name prefix, and the default file extension suffix.

Returns:

a temporary File created

Since:

0.6.16

createTempFile

public abstract File createTempFile(String fileExt)

Creates a temporary file in the space, with the default file name prefix, and the specified file extension suffix.

Parameters:

fileExt - the file extension suffix without a leading dot ('.')

Returns:

a temporary File created

Since:

0.6.16

createTempFile

public abstract File createTempFile(String prefix,
                                    String fileExt)

Creates a temporary file in the space, with the specified file name prefix, and the specified file extension suffix.

Parameters:

prefix - the file name prefix

fileExt - the file extension suffix without a leading dot ('.')

Returns:

a temporary File created

Since:

0.6.16

cleanup

public abstract void cleanup()

Cleans up the temporary file space, and everything in the space.

It is to be called along with Embulk's cleanup process. Plugins should not call this directly.

Since:

0.6.16