Apache POI - Common 5.3.0 · org.apache.poi.util.TempFile

Field Summary

Modifier and Type	Field and Description
public static final String	JAVA_IO_TMPDIR Define a constant for this property as it is sometimes mistypes as "tempdir" otherwise
private static TempFileCreationStrategy	strategy The strategy used by `createTempFile(String, String)` to create the temporary files.

Access	Constructor and Description
private	TempFile()

Method Summary

Modifier and Type	Method and Description
public static File	createTempDirectory(String name)
public static File	Returns: The path to the newly created and empty temporary file. createTempFile(String The prefix to be used to generate the name of the temporary file. prefix, String The suffix to be used to generate the name of the temporary file. suffix) Creates a new and empty temporary file.
public static void	setTempFileCreationStrategy(TempFileCreationStrategy The new strategy to be used to create the temporary files. strategy) Configures the strategy used by `createTempFile(String, String)` to create the temporary files.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

JAVA_IO_TMPDIR	back to summary
public static final String JAVA_IO_TMPDIR Define a constant for this property as it is sometimes mistypes as "tempdir" otherwise

strategy	back to summary
private static TempFileCreationStrategy strategy The strategy used by `createTempFile(String, String)` to create the temporary files.

Constructor Detail

TempFile	back to summary
private TempFile()

Method Detail

createTempDirectory	back to summary
public static File createTempDirectory(String name) throws IOException

createTempFile back to summary

createTempFile	back to summary
public static File createTempFile(String prefix, String suffix) throws IOException Creates a new and empty temporary file. By default, files are collected into one directory and are not deleted on exit from the VM, although they can be deleted by defining the system property `poi.delete.tmp.files.on.exit` (see `DefaultTempFileCreationStrategy`), which may cause `OutOfMemoryError` problem due to the frequent usage of `File#deleteOnExit()` Don't forget to close all files or it might not be possible to delete them. Parameters prefix:String The prefix to be used to generate the name of the temporary file. suffix:String The suffix to be used to generate the name of the temporary file. Returns:File The path to the newly created and empty temporary file. Exceptions IOException: If no temporary file could be created.

public static File createTempFile(String prefix, String suffix) throws IOException

Creates a new and empty temporary file. By default, files are collected into one directory and are not deleted on exit from the VM, although they can be deleted by defining the system property poi.delete.tmp.files.on.exit (see DefaultTempFileCreationStrategy), which may cause OutOfMemoryError problem due to the frequent usage of File#deleteOnExit()

Don't forget to close all files or it might not be possible to delete them.

Parameters

prefix:String: The prefix to be used to generate the name of the temporary file.
suffix:String: The suffix to be used to generate the name of the temporary file.

Returns:File

The path to the newly created and empty temporary file.

Exceptions

IOException:: If no temporary file could be created.

setTempFileCreationStrategy back to summary

setTempFileCreationStrategy	back to summary
public static void setTempFileCreationStrategy(TempFileCreationStrategy strategy) Configures the strategy used by `createTempFile(String, String)` to create the temporary files. Parameters strategy:TempFileCreationStrategy The new strategy to be used to create the temporary files. Exceptions IllegalArgumentException: When the given strategy is `null`.

public static void setTempFileCreationStrategy(TempFileCreationStrategy strategy)

Configures the strategy used by createTempFile(String, String) to create the temporary files.