Package com.github.siroshun09.configapi.core.util

Class ResourceUtils

java.lang.Object

com.github.siroshun09.configapi.core.util.ResourceUtils

public final class ResourceUtils
extends Object

A utility class that provides methods to copy files contained in a jar.

Method Summary

Modifier and Type	Method	Description
static void	copyFromClassLoader(@NotNull ClassLoader loader, @NotNull String name, @NotNull Path target)	Copies a file from classloader.
static void	copyFromClassLoaderIfNotExists(@NotNull ClassLoader loader, @NotNull String name, @NotNull Path target)	Copies a file from classloader if the target not exists.
static void	copyFromJar(@NotNull Path jarPath, @NotNull String name, @NotNull Path target)	Copies a file from jar.
static void	copyFromJar(@NotNull JarFile jar, @NotNull String name, @NotNull Path target)	Copies a file from jar.
static void	copyFromJarIfNotExists(@NotNull Path jarPath, @NotNull String name, @NotNull Path target)	Copies a file from jar if the target not exists.
static void	copyFromJarIfNotExists(@NotNull JarFile jar, @NotNull String name, @NotNull Path target)	Copies a file from jar if the target not exists.
static @NotNull InputStream	getInputStreamFromClassLoader(@NotNull ClassLoader classLoader, @NotNull String name)	Gets an InputStream from the ClassLoader.
static @NotNull InputStream	getInputStreamFromJar(@NotNull JarFile jar, @NotNull String name)	Gets an InputStream from the JarFile.

Methods inherited from class java.lang.Object

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

Method Details

copyFromClassLoader

public static void copyFromClassLoader(@NotNull
 @NotNull ClassLoader loader,
 @NotNull
 @NotNull String name,
 @NotNull
 @NotNull Path target)
                                throws IOException

Copies a file from classloader.

Parameters:

loader - the classloader

name - the filename

target - the filepath to save

Throws:

IOException - if an I/O error occurs

NullPointerException - if null is specified as an argument.

copyFromClassLoaderIfNotExists

public static void copyFromClassLoaderIfNotExists(@NotNull
 @NotNull ClassLoader loader,
 @NotNull
 @NotNull String name,
 @NotNull
 @NotNull Path target)
                                           throws IOException

Copies a file from classloader if the target not exists.

Parameters:

loader - the classloader

name - the filename

target - the filepath to save

Throws:

IOException - if an I/O error occurs

NullPointerException - if null is specified as an argument.

See Also:

• copyFromClassLoader(ClassLoader, String, Path)

copyFromJar

public static void copyFromJar(@NotNull
 @NotNull JarFile jar,
 @NotNull
 @NotNull String name,
 @NotNull
 @NotNull Path target)
                        throws IOException

Copies a file from jar.

Parameters:

jar - the jar file

name - the filename

target - the filepath to save

Throws:

IOException - if an I/O error occurs

NullPointerException - if null is specified as an argument.

copyFromJarIfNotExists

public static void copyFromJarIfNotExists(@NotNull
 @NotNull JarFile jar,
 @NotNull
 @NotNull String name,
 @NotNull
 @NotNull Path target)
                                   throws IOException

Copies a file from jar if the target not exists.

Parameters:

jar - the jar file

name - the filename

target - the filepath to save

Throws:

IOException - if an I/O error occurs

NullPointerException - if null is specified as an argument.

copyFromJar

public static void copyFromJar(@NotNull
 @NotNull Path jarPath,
 @NotNull
 @NotNull String name,
 @NotNull
 @NotNull Path target)
                        throws IOException

Copies a file from jar.

Parameters:

jarPath - the jar filepath

name - the filename

target - the filepath to save

Throws:

IOException - if an I/O error occurs

NullPointerException - if null is specified as an argument.

copyFromJarIfNotExists

public static void copyFromJarIfNotExists(@NotNull
 @NotNull Path jarPath,
 @NotNull
 @NotNull String name,
 @NotNull
 @NotNull Path target)
                                   throws IOException

Copies a file from jar if the target not exists.

Parameters:

jarPath - the jar filepath

name - the filename

target - the filepath to save

Throws:

IOException - if an I/O error occurs

NullPointerException - if null is specified as an argument.

getInputStreamFromClassLoader

@NotNull
public static @NotNull InputStream getInputStreamFromClassLoader(@NotNull
 @NotNull ClassLoader classLoader,
 @NotNull
 @NotNull String name)

Gets an InputStream from the ClassLoader.

Parameters:

classLoader - the ClassLoader to get an InputStream

name - the resource name

Returns:

ClassLoader.getResourceAsStream(String)

Throws:

IllegalStateException - if the resource was not found

NullPointerException - if null is specified as an argument.

getInputStreamFromJar

@NotNull
public static @NotNull InputStream getInputStreamFromJar(@NotNull
 @NotNull JarFile jar,
 @NotNull
 @NotNull String name)
                                                  throws IOException

Gets an InputStream from the JarFile.

Parameters:

jar - the JarFile to get an InputStream

name - the resource name

Returns:

the InputStream from JarFile.getInputStream(ZipEntry)

Throws:

IOException - if an I/O error occurs

IllegalStateException - if the resource was not found

NullPointerException - if null is specified as an argument.