com.google.cloud.tools.jib.filesystem

Class FileOperations

java.lang.Object

com.google.cloud.tools.jib.filesystem.FileOperations

public class FileOperations
extends Object

Static methods for operating on the filesystem.

Method Summary

Modifier and Type	Method and Description
static void	copy(com.google.common.collect.ImmutableList<Path> sourceFiles, Path destDir) Copies sourceFiles to the destDir directory.
static void	deleteRecursiveOnExit(Path path) Sets up a shutdown hook that tries to delete a file or directory.
static OutputStream	newLockingOutputStream(Path file) Acquires an exclusive FileLock on the file and opens an OutputStream to write to it.

Methods inherited from class java.lang.Object

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

Method Detail

copy

public static void copy(com.google.common.collect.ImmutableList<Path> sourceFiles,
                        Path destDir)
                 throws IOException

Copies sourceFiles to the destDir directory.

Parameters:

sourceFiles - the list of source files.

destDir - the directory to copy the files to.

Throws:

IOException - if the copy fails.

newLockingOutputStream

public static OutputStream newLockingOutputStream(Path file)
                                           throws IOException

Acquires an exclusive FileLock on the file and opens an OutputStream to write to it. The file will be created if it does not exist, or truncated to length 0 if it does exist. The OutputStream must be closed to release the lock.

The locking mechanism should not be used as a concurrency management feature. Rather, this should be used as a way to prevent concurrent writes to file. Concurrent attempts to lock file will result in OverlappingFileLockExceptions.

Parameters:

file - the file to write to

Returns:

an OutputStream that writes to the file

Throws:

IOException - if an I/O exception occurs

deleteRecursiveOnExit

public static void deleteRecursiveOnExit(Path path)

Sets up a shutdown hook that tries to delete a file or directory.

Parameters:

path - the path to the file or directory