de.carne.io

Class IOHelper

java.lang.Object

de.carne.io.IOHelper

public final class IOHelper
extends java.lang.Object

Utility class providing I/O related functions.

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.nio.file.Path>	collectDirectoryFiles(java.nio.file.Path start, java.nio.file.FileVisitOption... options) Collect all files in a directory.
static java.util.List<java.nio.file.Path>	collectDirectoryFiles(java.nio.file.Path start, java.util.function.Predicate<java.nio.file.Path> filter, java.nio.file.FileVisitOption... options) Collect all files in a directory.
static long	copyStream(java.io.InputStream in, java.io.OutputStream out) Copy all data from an InputStream to an OutputStream.
static java.nio.file.Path	createTempDirFromZIPResource(java.net.URL resource, java.nio.file.Path dir, java.lang.String prefix, java.nio.file.attribute.FileAttribute<?>... attrs) Create a temporary directory and initialize it by copying a ZIP resource's content.
static java.nio.file.Path	createTempDirFromZIPResource(java.net.URL resource, java.lang.String prefix, java.nio.file.attribute.FileAttribute<?>... attrs) Create a temporary directory and initialize it by copying a ZIP resource's content.
static java.nio.file.Path	createTempFileFromResource(java.net.URL resource, java.nio.file.Path dir, java.lang.String prefix, java.lang.String suffix, java.nio.file.attribute.FileAttribute<?>... attrs) Create a temporary file and initialize it by copying a resource's content.
static java.nio.file.Path	createTempFileFromResource(java.net.URL resource, java.lang.String prefix, java.lang.String suffix, java.nio.file.attribute.FileAttribute<?>... attrs) Create a temporary file and initialize it by copying a resource's content.
static void	deleteDirectoryTree(java.io.File directory) Delete a directory and all it's included sub-directories/files.
static void	deleteDirectoryTree(java.nio.file.Path directory) Delete a directory and all it's included sub-directories/files.
static void	deleteDirectoryTree(java.lang.String directory) Delete a directory and all it's included sub-directories/files.
static byte[]	readBytes(java.io.InputStream in) Read all bytes from an InputStream.
static byte[]	readBytes(java.io.InputStream in, int limit) Read up to a maximum number of bytes from an InputStream.

Methods inherited from class java.lang.Object

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

Method Detail

readBytes

public static byte[] readBytes(java.io.InputStream in)
                        throws java.io.IOException

Read all bytes from an InputStream.

Parameters:

in - The input stream to read from.

Returns:

The read bytes.

Throws:

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

readBytes

public static byte[] readBytes(java.io.InputStream in,
                               int limit)
                        throws java.io.IOException

Read up to a maximum number of bytes from an InputStream.

Parameters:

in - The input stream to read from.

limit - The maximum number of bytes to read.

Returns:

The read bytes.

Throws:

java.io.InterruptedIOException - if the read limit has been reached.

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

copyStream

public static long copyStream(java.io.InputStream in,
                              java.io.OutputStream out)
                       throws java.io.IOException

Copy all data from an InputStream to an OutputStream.

Parameters:

in - The input stream to read from.

out - The output stream to write to.

Returns:

The number of copied bytes.

Throws:

java.io.IOException - if an I/O error occurs while reading or writing data.

collectDirectoryFiles

public static java.util.List<java.nio.file.Path> collectDirectoryFiles(java.nio.file.Path start,
                                                                       java.nio.file.FileVisitOption... options)
                                                                throws java.io.IOException

Collect all files in a directory.

Parameters:

start - The directory path to scan.

options - The scan options.

Returns:

The collected file paths.

Throws:

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

collectDirectoryFiles

public static java.util.List<java.nio.file.Path> collectDirectoryFiles(java.nio.file.Path start,
                                                                       java.util.function.Predicate<java.nio.file.Path> filter,
                                                                       java.nio.file.FileVisitOption... options)
                                                                throws java.io.IOException

Collect all files in a directory.

Parameters:

start - The directory path to scan.

filter - The filter to apply to the scan result.

options - The scan options.

Returns:

The collected file paths.

Throws:

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

deleteDirectoryTree

public static void deleteDirectoryTree(java.lang.String directory)
                                throws java.io.IOException

Delete a directory and all it's included sub-directories/files.

Parameters:

directory - The directory to delete.

Throws:

java.io.IOException - if an I/O error occurs while deleting the directory tree.

deleteDirectoryTree

public static void deleteDirectoryTree(java.io.File directory)
                                throws java.io.IOException

Delete a directory and all it's included sub-directories/files.

Parameters:

directory - The directory to delete.

Throws:

java.io.IOException - if an I/O error occurs while deleting the directory tree.

deleteDirectoryTree

public static void deleteDirectoryTree(java.nio.file.Path directory)
                                throws java.io.IOException

Delete a directory and all it's included sub-directories/files.

Parameters:

directory - The directory to delete.

Throws:

java.io.IOException - if an I/O error occurs while deleting the directory tree.

createTempFileFromResource

public static java.nio.file.Path createTempFileFromResource(java.net.URL resource,
                                                            @Nullable
                                                            java.lang.String prefix,
                                                            @Nullable
                                                            java.lang.String suffix,
                                                            java.nio.file.attribute.FileAttribute<?>... attrs)
                                                     throws java.io.IOException

Create a temporary file and initialize it by copying a resource's content.

Parameters:

resource - The resource to use for file initialization.

prefix - The prefix to use for temp file creation (may be null).

suffix - The suffix to use for temp file creation (may be null).

attrs - The file attributes to use for temp file creation.

Returns:

The created and initialized file.

Throws:

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

See Also:

Files.createTempFile(String, String, FileAttribute...)

createTempFileFromResource

public static java.nio.file.Path createTempFileFromResource(java.net.URL resource,
                                                            java.nio.file.Path dir,
                                                            @Nullable
                                                            java.lang.String prefix,
                                                            @Nullable
                                                            java.lang.String suffix,
                                                            java.nio.file.attribute.FileAttribute<?>... attrs)
                                                     throws java.io.IOException

Create a temporary file and initialize it by copying a resource's content.

Parameters:

resource - The resource to use for file initialization.

dir - The directory to use for temp file creation.

prefix - The prefix to use for temp file creation (may be null).

suffix - The suffix to use for temp file creation (may be null).

attrs - The file attributes to use for temp file creation.

Returns:

The created and initialized file.

Throws:

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

See Also:

Files.createTempFile(Path, String, String, FileAttribute...)

createTempDirFromZIPResource

public static java.nio.file.Path createTempDirFromZIPResource(java.net.URL resource,
                                                              @Nullable
                                                              java.lang.String prefix,
                                                              java.nio.file.attribute.FileAttribute<?>... attrs)
                                                       throws java.io.IOException

Create a temporary directory and initialize it by copying a ZIP resource's content.

Parameters:

resource - The resource to use for directory initialization.

prefix - The prefix to use for temp dir creation (may be null).

attrs - The file attributes to use for temp dir creation.

Returns:

The created and initialized directory.

Throws:

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

See Also:

Files.createTempDirectory(String, FileAttribute...)

createTempDirFromZIPResource

public static java.nio.file.Path createTempDirFromZIPResource(java.net.URL resource,
                                                              java.nio.file.Path dir,
                                                              @Nullable
                                                              java.lang.String prefix,
                                                              java.nio.file.attribute.FileAttribute<?>... attrs)
                                                       throws java.io.IOException

Create a temporary directory and initialize it by copying a ZIP resource's content.

Parameters:

resource - The resource to use for directory initialization.

dir - The directory to use for temp dir creation.

prefix - The prefix to use for temp dir creation (may be null).

attrs - The file attributes to use for temp dir creation.

Returns:

The created and initialized directory.

Throws:

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

See Also:

Files.createTempDirectory(Path, String, FileAttribute...)