Package velox.api.layer1.common.temporaryfiles

Class TemporaryFileDirectory

java.lang.Object

velox.api.layer1.common.temporaryfiles.TemporaryFileDirectory

public class TemporaryFileDirectory
extends Object

Manages a directory reserved for temporary resources. Required, because all temp resources need an associated lock.

Reasons:

• Temp directories are pruned at Bookmap startup and shutdown.
• There might be multiple instances of Bookmap running simultaneously over the same settings dir (dev environment only).
• On user machines, there might be background threads that still use the resources at the time of shutdown. Unexpected deletion of those resources can lead to permanent corruption.
• Lock ensures that only unused resources will be pruned.

Typical usage pattern:

 TempPath tempPath = TemporaryFileDirectory.DEFAULT.newTempPath(...);
 Path path = tempPath.get(); // or tempPath.createDirectory()
 // use the path
 tempPath.dispose();
 

TempPath can also be used with try-with-resources.

Field Summary

Fields

Modifier and Type	Field	Description
static final TemporaryFileDirectory	DEFAULT

Constructor Summary

Constructors

Constructor	Description
TemporaryFileDirectory(Path root)

Method Summary

Modifier and Type	Method	Description
Path	getRoot()
TempPath	newTempPath(String pathName)	Creates a TempPath with given name.
TempPath	newTempPath(String prefix, String suffix)	Creates a TempPath with its name generated using the given prefix and suffix.
void	removeUnlockedFiles(boolean gcHackForMemoryMappedFiles)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final TemporaryFileDirectory DEFAULT

Constructor Details

TemporaryFileDirectory

public TemporaryFileDirectory(Path root)

Method Details

getRoot

public Path getRoot()

removeUnlockedFiles

public void removeUnlockedFiles(boolean gcHackForMemoryMappedFiles)

Parameters:

gcHackForMemoryMappedFiles - When true, increases the chance of memory mapped files to be deleted.

See Also:

• JDK-4715154

newTempPath

public TempPath newTempPath(@Nullable
 String prefix,
 @Nullable
 String suffix)
                     throws IOException

Creates a TempPath with its name generated using the given prefix and suffix. Uses standard Java temp file generation.

Throws:

IOException

See Also:

• Files.createTempFile(String, String, FileAttribute[])

newTempPath

public TempPath newTempPath(@Nonnull
 String pathName)
                     throws IOException

Creates a TempPath with given name. Where possible, version newTempPath(String, String) is preferred.

Throws:

IOException