ome.smuggler.core.io

Class FileOps

java.lang.Object

ome.smuggler.core.io.FileOps

public class FileOps
extends java.lang.Object

Utility methods for file operations.

Constructor Summary

Constructors

Constructor and Description
FileOps()

Method Summary

Modifier and Type	Method and Description
static Nat	byteLength(java.nio.file.Path file) Queries the size of the given file.
static void	copy(java.nio.file.Path source, java.nio.file.Path destination) Copies the source file to the destination path, overriding it if it exists already.
static void	delete(java.nio.file.Path file) Deletes the specified file if it exists; does nothing otherwise.
static void	ensureDirectory(java.nio.file.Path p) Calls Files.createDirectories() re-throwing any exception without wrapping.
static void	filter(java.nio.file.Path from, java.nio.file.Path to, StreamFilter f) Uses a filter to read data from a source file and write a new destination file.
static java.util.stream.Stream<java.nio.file.Path>	listChildFiles(java.nio.file.Path dir) Collects all the regular files directly under the specified directory.
static void	rewrite(java.nio.file.Path target, StreamFilter f) Uses a filter to rewrite the content of the specified file.
static long	transfer(java.nio.file.Path from, Nat howManyBytes, java.io.OutputStream to) Efficiently copies an initial segment of a file into a target stream.
static void	writeNew(java.nio.file.Path file, util.lambda.ConsumerE<java.io.OutputStream> writer) Creates a new file and has the given consumer write its contents.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileOps

public FileOps()

Method Detail

delete

public static void delete(java.nio.file.Path file)

Deletes the specified file if it exists; does nothing otherwise.

Parameters:

file - path to the file to delete.

Throws:

java.lang.NullPointerException - if the argument is null.

The following checked exceptions are rethrown as unchecked (i.e. the exception is masked as a runtime exception and thrown as is without wrapping it in a RuntimeException):
IOException if an I/O error occurs.

copy

public static void copy(java.nio.file.Path source,
                        java.nio.file.Path destination)

Copies the source file to the destination path, overriding it if it exists already. If the source file does not exist, this method does nothing.

Parameters:

source - path to the file to copy.

destination - path to the copied file.

Throws:

java.lang.NullPointerException - if any argument is null.

The following checked exceptions are rethrown as unchecked (i.e. the exception is masked as a runtime exception and thrown as is without wrapping it in a RuntimeException):
IOException if an I/O error occurs.

transfer

public static long transfer(java.nio.file.Path from,
                            Nat howManyBytes,
                            java.io.OutputStream to)
                     throws java.io.IOException

Efficiently copies an initial segment of a file into a target stream.

Parameters:

from - path to the file from which to get the data.

howManyBytes - number of bytes to take, starting at the beginning of the file.

to - where to copy the data.

Returns:

the number of bytes actually copied.

Throws:

java.lang.NullPointerException - if any argument is null.

java.io.IOException - if an I/O error occurs.

byteLength

public static Nat byteLength(java.nio.file.Path file)

Queries the size of the given file.

Parameters:

file - the file to query.

Returns:

the number of bytes in the specified file.

Throws:

java.lang.NullPointerException - if the argument is null.

The following checked exceptions are rethrown as unchecked (i.e. the exception is masked as a runtime exception and thrown as is without wrapping it in a RuntimeException):
IOException if an I/O error occurs.

listChildFiles

public static java.util.stream.Stream<java.nio.file.Path> listChildFiles(java.nio.file.Path dir)

Collects all the regular files directly under the specified directory. Sub-directories are not recursed.

Parameters:

dir - the target directory.

Returns:

a list of the files found in the directory.

Throws:

java.lang.NullPointerException - if the argument is null.

The following checked exceptions are rethrown as unchecked (i.e. the exception is masked as a runtime exception and thrown as is without wrapping it in a RuntimeException):
IOException if an I/O error occurs.

ensureDirectory

public static void ensureDirectory(java.nio.file.Path p)

Calls Files.createDirectories() re-throwing any exception without wrapping.

Parameters:

p - the path containing the directories to create.

Throws:

java.lang.NullPointerException - if the argument is null.

writeNew

public static void writeNew(java.nio.file.Path file,
                            util.lambda.ConsumerE<java.io.OutputStream> writer)

Creates a new file and has the given consumer write its contents. If the file already exists, it will be overwritten.

Parameters:

file - path to the file to create and write.

writer - writes the file contents.

Throws:

java.lang.NullPointerException - if any argument is null.

The following checked exceptions are rethrown as unchecked (i.e. the exception is masked as a runtime exception and thrown as is without wrapping it in a RuntimeException):
IOException if an I/O error occurs.

rewrite

public static void rewrite(java.nio.file.Path target,
                           StreamFilter f)

Uses a filter to rewrite the content of the specified file.

Parameters:

target - the file to rewrite.

f - the filter to use.

Throws:

java.lang.NullPointerException - if any argument is null.

The following checked exceptions are rethrown as unchecked (i.e. the exception is masked as a runtime exception and thrown as is without wrapping it in a RuntimeException):
Exception if an I/O or any other kind of error occurs.

filter

public static void filter(java.nio.file.Path from,
                          java.nio.file.Path to,
                          StreamFilter f)

Uses a filter to read data from a source file and write a new destination file. If the destination file exists, it will be overwritten with the filter's output.

Parameters:

from - the source file.

to - the destination file.

f - the filter to use.

Throws:

java.lang.NullPointerException - if any argument is null.

The following checked exceptions are rethrown as unchecked (i.e. the exception is masked as a runtime exception and thrown as is without wrapping it in a RuntimeException):
Exception if an I/O or any other kind of error occurs.