程序包 committee.nova.mods.avaritia.api.util.io

类 IOUtil

java.lang.Object

committee.nova.mods.avaritia.api.util.io.IOUtil

public class IOUtil
extends Object

IOUtil

构造器概要

构造器

构造器	说明
IOUtil()

方法概要

修饰符和类型	方法	说明
static void	copy(InputStream is, OutputStream os)	Copies the content of an InputStream to an OutputStream.
static void	copy(ReadableByteChannel rc, WritableByteChannel wc)	Copies the content of an ReadableByteChannel into an WritableByteChannel.
static void	fill(ReadableByteChannel channel, ByteBuffer buffer)	Reads buffer.remaining() bytes from the channel into the buffer.
static byte[]	getCachedBuffer()	Returns a static per-thread cached 32k buffer for IO operations.
static FileSystem	getFileSystem(URI uri)	Attempts to get an already existing FileSystem.
static FileSystem	getFileSystem(URI uri, Map<String,?> env)	Attempts to get or create a FileSystem for the given uri, with additional arguments for FS creation.
static FileSystem	getJarFileSystem(URI path, boolean create)	Creates a new FileSystem for the given uri path.
static FileSystem	getJarFileSystem(Path path, boolean create)	Creates a new FileSystem for the given jar path.
static Path	makeParents(Path path)	Creates the parent directories of the given path if they don't exist.
static Set<PosixFilePermission>	parseMode(int mode)	Converts a Posix 'file mode' into a set of PosixFilePermissions.
static InputStream	protectClose(InputStream is)	wraps the given InputStream protecting it against InputStream.close() operations.
static OutputStream	protectClose(OutputStream os)	wraps the given OutputStream protecting it against OutputStream.close() operations.
static FileSystem	protectClose(FileSystem fs)	wraps the given FileSystem protecting it against FileSystem.close() operations.
static List<String>	readAll(byte[] bytes)	Reads the provided array of bytes into a List of UTF-8 Strings.
static List<String>	readAll(byte[] bytes, Charset charset)	Reads the provided array of bytes into a List of Strings in the given Charset.
static String	readAll(Path path)	Read the entire content of the provided Path into a UTF-8 String.
static String	readAll(Path path, Charset charset)	Read the entire content of the provided Path into a String with the given charset.
static void	stripJar(Path input, Path output, Predicate<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(InputStream is)	Reads an InputStream to a byte array.
static int	writeMode(Set<PosixFilePermission> perms)	Writes a set of PosixFilePermissions to a Posix 'file mode' integer.

从类继承的方法 java.lang.Object

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

构造器详细资料

IOUtil

public IOUtil()

方法详细资料

getCachedBuffer

public static byte[] getCachedBuffer()

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

返回:

The buffer.

copy

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

Copies the content of an InputStream to an OutputStream.

参数:

is - The InputStream.

os - The OutputStream.

抛出:

IOException - If something is bork.

copy

public static void copy(@WillNotClose
 ReadableByteChannel rc,
 @WillNotClose
 WritableByteChannel wc)
                 throws IOException

Copies the content of an ReadableByteChannel into an WritableByteChannel.

This method makes use of direct ByteBuffer instances.

参数:

rc - The ReadableByteChannel to copy from.

wc - The WritableByteChannel to copy to.

抛出:

IOException - If an IO Error occurred whilst copying.

fill

public static void fill(@WillNotClose
 ReadableByteChannel channel,
 ByteBuffer buffer)
                 throws IOException

Reads buffer.remaining() bytes from the channel into the buffer.

This method blocks until the requested bytes are read.

If the stream ends prior to the requested number of bytes an EOFException is thrown.

参数:

channel - The channel to read from.

buffer - The buffer to fill.

抛出:

IOException

toBytes

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

Reads an InputStream to a byte array.

参数:

is - The InputStream.

返回:

The bytes.

抛出:

IOException - If something is bork.

readAll

public static List<String> readAll(byte[] bytes)
                            throws IOException

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

参数:

bytes - The bytes of the strings.

返回:

The lines.

抛出:

IOException - Any exception thrown reading the bytes.

readAll

public static List<String> readAll(byte[] bytes,
 Charset charset)
                            throws IOException

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

参数:

bytes - The bytes of the strings.

返回:

The lines.

抛出:

IOException - Any exception thrown reading the bytes.

readAll

public static String readAll(Path path)
                      throws IOException

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

参数:

path - The path to read.

返回:

The String.

抛出:

IOException - If there was an error reading the file.

readAll

public static String readAll(Path path,
 Charset charset)
                      throws IOException

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

参数:

path - The path to read.

charset - The Charset.

返回:

The String.

抛出:

IOException - If there was an error reading the file.

makeParents

public static Path makeParents(Path path)
                        throws IOException

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

参数:

path - The path.

返回:

The same path.

抛出:

IOException - If an error occurs creating the directories.

getJarFileSystem

public static FileSystem getJarFileSystem(Path path,
 boolean create)
                                   throws 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.

参数:

path - The file to open the jar for.

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

返回:

The FileSystem.

抛出:

IOException - If the FileSystem could not be created.

getJarFileSystem

public static FileSystem getJarFileSystem(URI path,
 boolean create)
                                   throws 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.

参数:

path - The uri to open the jar for.

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

返回:

The FileSystem.

抛出:

IOException - If the FileSystem could not be created.

getFileSystem

public static FileSystem getFileSystem(URI uri)
                                throws 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.

参数:

uri - The uri to open the jar for.

返回:

The FileSystem.

抛出:

IOException - If the FileSystem could not be created.

getFileSystem

public static FileSystem getFileSystem(URI uri,
 Map<String,?> env)
                                throws 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.

参数:

uri - The uri to open the jar for.

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

返回:

The FileSystem.

抛出:

IOException - If the FileSystem could not be created.

protectClose

public static FileSystem protectClose(FileSystem fs)

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

参数:

fs - The FileSystem to wrap.

返回:

The wrapped FileSystem.

protectClose

public static InputStream protectClose(InputStream is)

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

参数:

is - The InputStream to wrap.

返回:

The wrapped InputStream.

protectClose

public static OutputStream protectClose(OutputStream os)

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

参数:

os - The OutputStream to wrap.

返回:

The wrapped OutputStream.

stripJar

public static void stripJar(Path input,
 Path output,
 Predicate<Path> predicate)
                     throws IOException

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

参数:

input - The Input Path. This should exist.

output - The Output Path. This should not exists.

predicate - The Predicate that each Entry must match.

抛出:

IOException - If something went wrong during execution.

parseMode

public static Set<PosixFilePermission> parseMode(int mode)

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

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

参数:

mode - The file mode.

返回:

The parsed permissions.

writeMode

public static int writeMode(Set<PosixFilePermission> perms)

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

参数:

perms - The permissions.

返回:

The 'file mode'.