net.covers1624.quack.io

Class IOUtils

java.lang.Object

net.covers1624.quack.io.IOUtils

public class IOUtils
extends java.lang.Object

Various utilities for IO interaction with bytes, streams, files, etc.

Created by covers1624 on 14/1/21.

Constructor Summary

Constructors

Constructor and Description
IOUtils()

Method Summary

Modifier and Type	Method and Description
static void	copy(java.io.InputStream is, java.io.OutputStream os) Copies the content of an InputStream to an OutputStream.
static byte[]	getCachedBuffer() Returns a static per-thread cached 32k buffer for IO operations.
static java.nio.file.FileSystem	getFileSystem(java.net.URI uri) Attempts to get an already existing FileSystem.
static java.nio.file.FileSystem	getFileSystem(java.net.URI uri, java.util.Map<java.lang.String,?> env) Attempts to get or create a FileSystem for the given uri, with additional arguments for FS creation.
static java.nio.file.FileSystem	getJarFileSystem(java.nio.file.Path path, boolean create) Creates a new FileSystem for the given jar path.
static java.nio.file.FileSystem	getJarFileSystem(java.net.URI path, boolean create) Creates a new FileSystem for the given uri path.
static java.nio.file.Path	makeParents(java.nio.file.Path path) Creates the parent directories of the given path if they don't exist.
static java.util.Set<java.nio.file.attribute.PosixFilePermission>	parseMode(int mode) Converts a Posix 'file mode' into a set of PosixFilePermissions.
static java.nio.file.FileSystem	protectClose(java.nio.file.FileSystem fs) wraps the given FileSystem protecting it against FileSystem.close() operations.
static java.io.InputStream	protectClose(java.io.InputStream is) wraps the given InputStream protecting it against InputStream.close() operations.
static java.io.OutputStream	protectClose(java.io.OutputStream os) wraps the given OutputStream protecting it against OutputStream.close() operations.
static java.util.List<java.lang.String>	readAll(byte[] bytes) Reads the provided array of bytes into a List of UTF-8 Strings.
static java.util.List<java.lang.String>	readAll(byte[] bytes, java.nio.charset.Charset charset) Reads the provided array of bytes into a List of Strings in the given Charset.
static java.lang.String	readAll(java.nio.file.Path path) Read the entire content of the provided Path into a UTF-8 String.
static java.lang.String	readAll(java.nio.file.Path path, java.nio.charset.Charset charset) Read the entire content of the provided Path into a String with the given charset.
static void	stripJar(java.nio.file.Path input, java.nio.file.Path output, java.util.function.Predicate<java.nio.file.Path> predicate) Copes every element in a Jar file from the input to the Jar file output, where every element must match the provided Predicate.
static byte[]	toBytes(java.io.InputStream is) Reads an InputStream to a byte array.
static int	writeMode(java.util.Set<java.nio.file.attribute.PosixFilePermission> perms) Writes a set of PosixFilePermissions to a Posix 'file mode' integer.

Methods inherited from class java.lang.Object

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

Constructor Detail

IOUtils

public IOUtils()

Method Detail

getCachedBuffer

public static byte[] getCachedBuffer()

Returns a static per-thread cached 32k buffer for IO operations.

Returns:

The buffer.

copy

public static void copy(@WillNotClose
                        java.io.InputStream is,
                        @WillNotClose
                        java.io.OutputStream os)
                 throws java.io.IOException

Copies the content of an InputStream to an OutputStream.

Parameters:

is - The InputStream.

os - The OutputStream.

Throws:

java.io.IOException - If something is bork.

toBytes

public static byte[] toBytes(@WillNotClose
                             java.io.InputStream is)
                      throws java.io.IOException

Reads an InputStream to a byte array.

Parameters:

is - The InputStream.

Returns:

The bytes.

Throws:

java.io.IOException - If something is bork.

readAll

public static java.util.List<java.lang.String> readAll(byte[] bytes)
                                                throws java.io.IOException

Reads the provided array of bytes into a List of UTF-8 Strings.

Parameters:

bytes - The bytes of the strings.

Returns:

The lines.

Throws:

java.io.IOException - Any exception thrown reading the bytes.

readAll

public static java.util.List<java.lang.String> readAll(byte[] bytes,
                                                       java.nio.charset.Charset charset)
                                                throws java.io.IOException

Reads the provided array of bytes into a List of Strings in the given Charset.

Parameters:

bytes - The bytes of the strings.

Returns:

The lines.

Throws:

java.io.IOException - Any exception thrown reading the bytes.

readAll

public static java.lang.String readAll(java.nio.file.Path path)
                                throws java.io.IOException

Read the entire content of the provided Path into a UTF-8 String.

Parameters:

path - The path to read.

Returns:

The String.

Throws:

java.io.IOException - If there was an error reading the file.

readAll

public static java.lang.String readAll(java.nio.file.Path path,
                                       java.nio.charset.Charset charset)
                                throws java.io.IOException

Read the entire content of the provided Path into a String with the given charset.

Parameters:

path - The path to read.

charset - The Charset.

Returns:

The String.

Throws:

java.io.IOException - If there was an error reading the file.

makeParents

public static java.nio.file.Path makeParents(java.nio.file.Path path)
                                      throws java.io.IOException

Creates the parent directories of the given path if they don't exist.

Parameters:

path - The path.

Returns:

The same path.

Throws:

java.io.IOException - If an error occurs creating the directories.

getJarFileSystem

public static java.nio.file.FileSystem getJarFileSystem(java.nio.file.Path path,
                                                        boolean create)
                                                 throws java.io.IOException

Creates a new FileSystem for the given jar path.

If a FS was not created by this method due to it already existing, this method will guard the returned FileSystem from being closed via FileSystem.close(). This means it's safe to use try-with-resources when you don't explicitly own the FileSystem.

Parameters:

path - The file to open the jar for.

create - If the file system should attempt to be created if it does not exist.

Returns:

The FileSystem.

Throws:

java.io.IOException - If the FileSystem could not be created.

getJarFileSystem

public static java.nio.file.FileSystem getJarFileSystem(java.net.URI path,
                                                        boolean create)
                                                 throws java.io.IOException

Creates a new FileSystem for the given uri path.

If a FS was not created by this method due to it already existing, this method will guard the returned FileSystem from being closed via FileSystem.close(). This means it's safe to use try-with-resources when you don't explicitly own the FileSystem.

Parameters:

path - The uri to open the jar for.

create - If the file system should attempt to be created if it does not exist.

Returns:

The FileSystem.

Throws:

java.io.IOException - If the FileSystem could not be created.

getFileSystem

public static java.nio.file.FileSystem getFileSystem(java.net.URI uri)
                                              throws java.io.IOException

Attempts to get an already existing FileSystem.

This method will guard the returned FileSystem from being closed via FileSystem.close(). This means it's safe to use try-with-resources when you don't explicitly own the FileSystem.

Parameters:

uri - The uri to open the jar for.

Returns:

The FileSystem.

Throws:

java.io.IOException - If the FileSystem could not be created.

getFileSystem

public static java.nio.file.FileSystem getFileSystem(java.net.URI uri,
                                                     java.util.Map<java.lang.String,?> env)
                                              throws java.io.IOException

Attempts to get or create a FileSystem for the given uri, with additional arguments for FS creation.

If a FS was not created by this method due to it already existing, this method will guard the returned FileSystem from being closed via FileSystem.close(). This means it's safe to use try-with-resources when you don't explicitly own the FileSystem.

Parameters:

uri - The uri to open the jar for.

env - Any additional arguments to provide when creating the FileSystem.

Returns:

The FileSystem.

Throws:

java.io.IOException - If the FileSystem could not be created.

protectClose

public static java.nio.file.FileSystem protectClose(java.nio.file.FileSystem fs)

wraps the given FileSystem protecting it against FileSystem.close() operations.

Parameters:

fs - The FileSystem to wrap.

Returns:

The wrapped FileSystem.

protectClose

public static java.io.InputStream protectClose(java.io.InputStream is)

wraps the given InputStream protecting it against InputStream.close() operations.

Parameters:

is - The InputStream to wrap.

Returns:

The wrapped InputStream.

protectClose

public static java.io.OutputStream protectClose(java.io.OutputStream os)

wraps the given OutputStream protecting it against OutputStream.close() operations.

Parameters:

os - The OutputStream to wrap.

Returns:

The wrapped OutputStream.

stripJar

public static void stripJar(java.nio.file.Path input,
                            java.nio.file.Path output,
                            java.util.function.Predicate<java.nio.file.Path> predicate)
                     throws java.io.IOException

Copes every element in a Jar file from the input to the Jar file output, where every element must match the provided Predicate.

Parameters:

input - The Input Path. This should exist.

output - The Output Path. This should not exists.

predicate - The Predicate that each Entry must match.

Throws:

java.io.IOException - If something went wrong during execution.

parseMode

public static java.util.Set<java.nio.file.attribute.PosixFilePermission> parseMode(int mode)

Converts a Posix 'file mode' into a set of PosixFilePermissions.

Thanks: https://stackoverflow.com/a/54422530/11313544

Parameters:

mode - The file mode.

Returns:

The parsed permissions.

writeMode

public static int writeMode(java.util.Set<java.nio.file.attribute.PosixFilePermission> perms)

Writes a set of PosixFilePermissions to a Posix 'file mode' integer.

Parameters:

perms - The permissions.

Returns:

The 'file mode'.