Module com.github.ushiosan.jvm

Package com.github.ushiosan23.jvm.io

Class IOUtils

java.lang.Object

com.github.ushiosan23.jvm.io.IOUtils

public final class IOUtils
extends Object

Method Summary

Modifier and Type	Method	Description
static @NotNull Stream<Path>	directoryWalk(@NotNull Path location, boolean recursive, Predicate<Path> @NotNull ... filters)	Generates a stream where it recursively iterates through all the directories within the given destination.
static Path @NotNull []	directoryWalkArr(@NotNull Path location, boolean recursive, Predicate<Path> @NotNull ... filters)	Generates a stream where it recursively iterates through all the directories within the given destination.
static @NotNull String	getAllExtensions(@NotNull Path path)	Returns a text string with all the extensions of a file.
static @NotNull String	getBaseName(@NotNull Path path)	Returns the base name of the route.
static @NotNull String	getExtension(@NotNull Path path)	Returns the extension of a given file.
static @NotNull Path	getUserPath()	Depending on the operating system, it returns the path of the current user.
static @NotNull FileSystem	getValidFileSystem(@NotNull URI location)	Try to return a valid file system.
static @NotNull FileSystem	getValidFileSystem(@NotNull URL location)	Try to return a valid file system.
static @NotNull Path	jarToPath(@NotNull URI location)	Returns a jar file as a virtual directory.
static @NotNull Path	jarToPath(@NotNull URL location)	Returns a jar file as a virtual directory.
static @NotNull Path	jarToPath(@NotNull Path location)	Returns a jar file as a virtual directory.
static @NotNull Path	resolveUserPath(String @NotNull ... location)	Returns a specific path within the user's folder.

Methods inherited from class java.lang.Object

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

Method Details

getAllExtensions

@NotNull
public static @NotNull String getAllExtensions(@NotNull
 @NotNull Path path)

Returns a text string with all the extensions of a file.

Example:

 Path exampleFile = Path.of("build.gradle.kts");
 String extensions = IOUtils.getAllExtensions(exampleFile);

 System.out.println(extensions); // Result: ".gradle.kts"
 

Parameters:

path - Route to evaluate

Returns:

Return all extensions of a given file

Throws:

IllegalArgumentException - Error if path is not a valid file

getExtension

@NotNull
public static @NotNull String getExtension(@NotNull
 @NotNull Path path)

Returns the extension of a given file. If the path is a directory it generates an error.

Parameters:

path - Route to evaluate

Returns:

Returns the extension of a given file.

Throws:

IllegalArgumentException - Error if path is not a valid file

getBaseName

@NotNull
public static @NotNull String getBaseName(@NotNull
 @NotNull Path path)

Returns the base name of the route. For directories, it will only return the name and for files the name without the extensions.

Parameters:

path - Route to evaluate

Returns:

Returns the base name

getUserPath

@NotNull
public static @NotNull Path getUserPath()

Depending on the operating system, it returns the path of the current user.

Returns:

Returns the path to the current user's folder.

See Also:

• Path.of(String, String...)

resolveUserPath

@NotNull
public static @NotNull Path resolveUserPath(String @NotNull ... location)

Returns a specific path within the user's folder.

Parameters:

location - Path to search

Returns:

Returns the resolved path

See Also:

• Path.of(String, String...)

directoryWalk

@SafeVarargs
@NotNull
public static @NotNull Stream<Path> directoryWalk(@NotNull
 @NotNull Path location,
 boolean recursive,
 Predicate<Path> @NotNull ... filters)
                                           throws IOException

Generates a stream where it recursively iterates through all the directories within the given destination.

Parameters:

location - Base directory

recursive - Determines if the stream is required to be recursive or just the first directory.

filters - Filters applied to the stream.

Returns:

Returns a stream with all the given settings

Throws:

IOException - Error if directory not exists

See Also:

• Files
• Files.isRegularFile(Path, LinkOption...)
• Files.isDirectory(Path, LinkOption...)
• Files.isExecutable(Path)

directoryWalkArr

@SafeVarargs
public static Path @NotNull [] directoryWalkArr(@NotNull
 @NotNull Path location,
 boolean recursive,
 Predicate<Path> @NotNull ... filters)
                                         throws IOException

Generates a stream where it recursively iterates through all the directories within the given destination.

Parameters:

location - Base directory

recursive - Determines if the stream is required to be recursive or just the first directory.

filters - Filters applied to the stream.

Returns:

Returns an array with all the given settings

Throws:

IOException - Error if directory not exists

See Also:

• Files
• Files.isRegularFile(Path, LinkOption...)
• Files.isDirectory(Path, LinkOption...)
• Files.isExecutable(Path)

getValidFileSystem

@NotNull
public static @NotNull FileSystem getValidFileSystem(@NotNull
 @NotNull URL location)
                                              throws IOException,
URISyntaxException

Try to return a valid file system. This only works with local connections where it is possible to get files from a jar file inside a classloader.

Parameters:

location - The file to check

Returns:

Returns a valid file system instance

Throws:

IOException - If an I/O error occurs

URISyntaxException - If the url is not set correctly.

getValidFileSystem

@NotNull
public static @NotNull FileSystem getValidFileSystem(@NotNull
 @NotNull URI location)
                                              throws IOException

Try to return a valid file system. This only works with local connections where it is possible to get files from a jar file inside a classloader.

Parameters:

location - The file to check

Returns:

Returns a valid file system instance

Throws:

IOException - If an I/O error occurs

jarToPath

@NotNull
public static @NotNull Path jarToPath(@NotNull
 @NotNull URL location)
                               throws IOException,
URISyntaxException

Returns a jar file as a virtual directory. If the file is not a valid jar it will throw an error.

Parameters:

location - The jar file location

Returns:

Returns a virtual jar directory

Throws:

IOException - If an I/O error occurs

URISyntaxException - If the url is not set correctly.

jarToPath

@NotNull
public static @NotNull Path jarToPath(@NotNull
 @NotNull URI location)
                               throws IOException

Returns a jar file as a virtual directory. If the file is not a valid jar it will throw an error.

Parameters:

location - The jar file location

Returns:

Returns a virtual jar directory

Throws:

IOException - If an I/O error occurs

jarToPath

@NotNull
public static @NotNull Path jarToPath(@NotNull
 @NotNull Path location)
                               throws IOException

Returns a jar file as a virtual directory. If the file is not a valid jar it will throw an error.

Parameters:

location - The jar file location

Returns:

Returns a virtual jar directory

Throws:

IOException - If an I/O error occurs