Module ushiosan.jvm.utilities

Package ushiosan.jvm.filesystem

Class UResource

java.lang.Object

ushiosan.jvm.internal.validators.UResourceValidator

ushiosan.jvm.internal.filesystem.UResourceImpl

ushiosan.jvm.filesystem.UResource

public final class UResource
extends UResourceImpl

Field Summary

Fields inherited from class ushiosan.jvm.internal.validators.UResourceValidator

FS_DEFAULT_ALGORITHM, FS_EMPTY_EXTENSIONS, FS_EXTENSION_IDENTIFIER, FS_RESOURCE_BUFFER_SIZE_STANDARD, FS_STANDARD_FILE_SEPARATOR

Method Summary

Modifier and Type	Method	Description
static String @NotNull []	allExtensions(@NotNull File file)	Gets all existing extensions in a resource location.
static String @NotNull []	allExtensions(@NotNull Path path)	Gets all existing extensions in a resource location.
static String @NotNull []	allExtensions(@NotNull ZipEntry entry)	Gets all existing extensions in a resource location.
static @NotNull String	basename(@NotNull File file)	Gets the resource basename, without any extension.
static @NotNull String	basename(@NotNull File file, boolean partial)	Gets the resource basename, without any extension.
static @NotNull String	basename(@NotNull Path path)	Gets the resource basename, without any extension.
static @NotNull String	basename(@NotNull Path path, boolean partial)	Gets the resource basename, without any extension.
static @NotNull String	basename(@NotNull ZipEntry entry)	Gets the resource basename, without any extension.
static @NotNull String	basename(@NotNull ZipEntry entry, boolean partial)	Gets the resource basename, without any extension.
static void	disposeFilesystems()	Releases connections to all virtual file systems created by the pathOf(URI) method for jar or jrt files.
static void	disposeFilesystemsIf(@NotNull Function<FileSystem,Boolean> filter)	Releases connections to all virtual file systems created by the pathOf(URI) method for jar or jrt files.
static @NotNull Optional<String>	extension(@NotNull File file)	Gets the resource extension.
static @NotNull Optional<String>	extension(@NotNull Path path)	Gets the resource extension.
static @NotNull Optional<String>	extension(@NotNull ZipEntry entry)	Gets the resource extension.
static @NotNull FileSystem	fileSystem(@NotNull URI uri)	Gets a valid file system depending on the scheme of the given url
static @NotNull FileSystem	fileSystem(@NotNull URL url)	Returns a valid file system depending on the scheme of the given url
static @NotNull Path	pathOf(@NotNull URI uri)	Gets the path of an uri in the file system (if the scheme is supported).
static @NotNull Path	pathOf(@NotNull URL url)	Gets the path of an url in the file system (if the scheme is supported).
static byte[]	resourceHash(@NotNull File file)	Get the hash of the given resource
static byte[]	resourceHash(@NotNull File file, @NotNull String algorithm)	Get the hash of the given resource
static byte[]	resourceHash(@NotNull InputStream stream)	Get the hash of the given stream
static byte[]	resourceHash(@NotNull InputStream stream, @NotNull String algorithm)	Get the hash of the given stream
static byte[]	resourceHash(@NotNull Path path)	Get the hash of the given resource
static byte[]	resourceHash(@NotNull Path path, @NotNull String algorithm)	Get the hash of the given resource
static byte[]	resourceHash(@NotNull ZipFile file, @NotNull ZipEntry entry)	Get the hash of the given resource
static byte[]	resourceHash(@NotNull ZipFile file, @NotNull ZipEntry entry, @NotNull String algorithm)	Get the hash of the given resource
static @NotNull String	resourceHashStr(byte[] hash)	Get the hash of the given resource This method returns the hash as hexadecimal string.
static @NotNull String	resourceHashStr(@NotNull InputStream stream)	Get the hash of the given resource This method returns the hash as hexadecimal string.
static @NotNull String	resourceHashStr(@NotNull InputStream stream, @NotNull String algorithm)	Get the hash of the given resource This method returns the hash as hexadecimal string.
static @NotNull String	resourceName(@NotNull File file)	Gets the resource name without the slashes and the absolute path
static @NotNull String	resourceName(@NotNull Path path)	Gets the resource name without the slashes and the absolute path
static @NotNull String	resourceName(@NotNull ZipEntry entry)	Gets the resource name without the slashes and the absolute path
static @NotNull Stream<Path>	resourceWalk(@NotNull Path path, boolean recursive, Predicate<Path> @NotNull ... predicates)	Generates a stream where it recursively iterates through all the directories within the given destination.
static @NotNull Path	userDirectory(String @NotNull ... items)	Gets a specific path within the user's folder.

Methods inherited from class ushiosan.jvm.internal.filesystem.UResourceImpl

extensionsEntryOf, extensionsFileOf, extensionsPathOf, jrtFileAccess, jrtModuleName, namedEntryOf, namedFileOf, namedPathOf, regexEntryOf, regexEntryOf, regexEntryOf, regexFileOf, regexFileOf, regexFileOf, regexPathOf, regexPathOf, regexPathOf

Methods inherited from class ushiosan.jvm.internal.validators.UResourceValidator

allExtensionsImpl, basenameImpl, createByteBuffer, extensionImpl, nameWithoutSlashesImpl, resourceHashImpl

Methods inherited from class java.lang.Object

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

Method Details

userDirectory

@NotNull
public static @NotNull Path userDirectory(String @NotNull ... items)

Gets a specific path within the user's folder.

Parameters:

items - the relative user's folder location

Returns:

the resolved user relative path

resourceWalk

@SafeVarargs
@NotNull
public static @NotNull Stream<Path> resourceWalk(@NotNull
 @NotNull Path path,
 boolean recursive,
 Predicate<Path> @NotNull ... predicates)
                                          throws IOException

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

Parameters:

path - base directory

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

predicates - filters applied to the stream

Returns:

a stream with all the given settings

Throws:

IOException - error if directory not exists or location is not a valid directory

See Also:

• Predicate

resourceName

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

Gets the resource name without the slashes and the absolute path

Parameters:

path - the resource location to analyze

Returns:

the resource without the slashes

resourceName

@NotNull
public static @NotNull String resourceName(@NotNull
 @NotNull File file)

Gets the resource name without the slashes and the absolute path

Parameters:

file - the resource location to analyze

Returns:

the resource without the slashes

resourceName

@NotNull
public static @NotNull String resourceName(@NotNull
 @NotNull ZipEntry entry)

Gets the resource name without the slashes and the absolute path

Parameters:

entry - the resource location to analyze

Returns:

the resource without the slashes

basename

@NotNull
public static @NotNull String basename(@NotNull
 @NotNull Path path,
 boolean partial)

Gets the resource basename, without any extension.

Parameters:

path - the resource location to analyze

partial - returns the full or partial name

Returns:

the resource basename

basename

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

Gets the resource basename, without any extension.

Parameters:

path - the resource location to analyze

Returns:

the resource basename

basename

@NotNull
public static @NotNull String basename(@NotNull
 @NotNull File file,
 boolean partial)

Gets the resource basename, without any extension.

Parameters:

file - the resource location to analyze

partial - returns the full or partial name

Returns:

the resource basename

basename

@NotNull
public static @NotNull String basename(@NotNull
 @NotNull File file)

Gets the resource basename, without any extension.

Parameters:

file - the resource location to analyze

Returns:

the resource basename

basename

@NotNull
public static @NotNull String basename(@NotNull
 @NotNull ZipEntry entry,
 boolean partial)

Gets the resource basename, without any extension.

Parameters:

entry - the resource location to analyze

partial - returns the full or partial name

Returns:

the resource basename

basename

@NotNull
public static @NotNull String basename(@NotNull
 @NotNull ZipEntry entry)

Gets the resource basename, without any extension.

Parameters:

entry - the resource location to analyze

Returns:

the resource basename

allExtensions

public static String @NotNull [] allExtensions(@NotNull
 @NotNull Path path)

Gets all existing extensions in a resource location.

Parameters:

path - the resource location to analyze

Returns:

all resource extensions

Throws:

IllegalArgumentException - error if resource is an invalid regular file

See Also:

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

allExtensions

public static String @NotNull [] allExtensions(@NotNull
 @NotNull File file)

Gets all existing extensions in a resource location.

Parameters:

file - the resource location to analyze

Returns:

all resource extensions

Throws:

IllegalArgumentException - error if resource is an invalid regular file

See Also:

• File.isDirectory()

allExtensions

public static String @NotNull [] allExtensions(@NotNull
 @NotNull ZipEntry entry)

Gets all existing extensions in a resource location.

Parameters:

entry - the resource location to analyze

Returns:

all resource extensions

Throws:

IllegalArgumentException - error if resource is an invalid regular file

See Also:

• ZipEntry.isDirectory()

extension

@NotNull
public static @NotNull Optional<String> extension(@NotNull
 @NotNull Path path)

Gets the resource extension.

Parameters:

path - the resource location to analyze

Returns:

returns the resource extension or Optional.empty() if the extension not exists

Throws:

IllegalArgumentException - error if resource is an invalid regular file

See Also:

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

extension

@NotNull
public static @NotNull Optional<String> extension(@NotNull
 @NotNull File file)

Gets the resource extension.

Parameters:

file - the resource location to analyze

Returns:

returns the resource extension or Optional.empty() if the extension not exists

Throws:

IllegalArgumentException - error if resource is an invalid regular file

See Also:

• File.isDirectory()

extension

@NotNull
public static @NotNull Optional<String> extension(@NotNull
 @NotNull ZipEntry entry)

Gets the resource extension.

Parameters:

entry - the resource location to analyze

Returns:

returns the resource extension or Optional.empty() if the extension not exists

Throws:

IllegalArgumentException - error if resource is an invalid regular file

See Also:

• ZipEntry.isDirectory()

resourceHash

public static byte[] resourceHash(@NotNull
 @NotNull InputStream stream,
 @NotNull
 @NotNull String algorithm)
                           throws IOException,
NoSuchAlgorithmException

Get the hash of the given stream

Parameters:

stream - the content stream

algorithm - hash algorithm

Returns:

the stream hash

Throws:

NoSuchAlgorithmException - error if algorithm not exists

IOException - error to read stream content

resourceHash

public static byte[] resourceHash(@NotNull
 @NotNull InputStream stream)
                           throws IOException,
NoSuchAlgorithmException

Get the hash of the given stream

Parameters:

stream - the content stream

Returns:

the stream hash

Throws:

NoSuchAlgorithmException - error if algorithm not exists

IOException - error to read stream content

resourceHash

public static byte[] resourceHash(@NotNull
 @NotNull Path path,
 @NotNull
 @NotNull String algorithm)
                           throws IOException,
NoSuchAlgorithmException

Get the hash of the given resource

Parameters:

path - the resource location

algorithm - hash algorithm

Returns:

the resource hash

Throws:

NoSuchAlgorithmException - error if algorithm not exists

IOException - error to read stream content

resourceHash

public static byte[] resourceHash(@NotNull
 @NotNull Path path)
                           throws IOException,
NoSuchAlgorithmException

Get the hash of the given resource

Parameters:

path - the resource location

Returns:

the resource hash

Throws:

NoSuchAlgorithmException - error if algorithm not exists

IOException - error to read stream content

resourceHash

public static byte[] resourceHash(@NotNull
 @NotNull File file,
 @NotNull
 @NotNull String algorithm)
                           throws IOException,
NoSuchAlgorithmException

Get the hash of the given resource

Parameters:

file - the resource location

algorithm - hash algorithm

Returns:

the resource hash

Throws:

NoSuchAlgorithmException - error if algorithm not exists

IOException - error to read stream content

resourceHash

public static byte[] resourceHash(@NotNull
 @NotNull File file)
                           throws IOException,
NoSuchAlgorithmException

Get the hash of the given resource

Parameters:

file - the resource location

Returns:

the resource hash

Throws:

NoSuchAlgorithmException - error if algorithm not exists

IOException - error to read stream content

resourceHash

public static byte[] resourceHash(@NotNull
 @NotNull ZipFile file,
 @NotNull
 @NotNull ZipEntry entry,
 @NotNull
 @NotNull String algorithm)
                           throws IOException,
NoSuchAlgorithmException

Get the hash of the given resource

Parameters:

file - the root zip file

entry - the resource location

algorithm - hash algorithm

Returns:

the resource hash

Throws:

NoSuchAlgorithmException - error if algorithm not exists

IOException - error to read stream content

resourceHash

public static byte[] resourceHash(@NotNull
 @NotNull ZipFile file,
 @NotNull
 @NotNull ZipEntry entry)
                           throws IOException,
NoSuchAlgorithmException

Get the hash of the given resource

Parameters:

file - the root zip file

entry - the resource location

Returns:

the resource hash

Throws:

NoSuchAlgorithmException - error if algorithm not exists

IOException - error to read stream content

resourceHashStr

@NotNull
public static @NotNull String resourceHashStr(byte[] hash)

Get the hash of the given resource This method returns the hash as hexadecimal string.

Parameters:

hash - resource hash

Returns:

hash as hexadecimal string

resourceHashStr

@NotNull
public static @NotNull String resourceHashStr(@NotNull
 @NotNull InputStream stream,
 @NotNull
 @NotNull String algorithm)
                                       throws IOException,
NoSuchAlgorithmException

Get the hash of the given resource This method returns the hash as hexadecimal string.

Parameters:

stream - the content stream

algorithm - hash algorithm

Returns:

hash as hexadecimal string

Throws:

NoSuchAlgorithmException - error if algorithm not exists

IOException - error to read stream content

resourceHashStr

@NotNull
public static @NotNull String resourceHashStr(@NotNull
 @NotNull InputStream stream)
                                       throws IOException,
NoSuchAlgorithmException

Get the hash of the given resource This method returns the hash as hexadecimal string.

Parameters:

stream - the content stream

Returns:

hash as hexadecimal string

Throws:

NoSuchAlgorithmException - error if algorithm not exists

IOException - error to read stream content

fileSystem

@NotNull
public static @NotNull FileSystem fileSystem(@NotNull
 @NotNull URL url)
                                      throws IOException

Returns a valid file system depending on the scheme of the given url

Parameters:

url - the url to inspect

Returns:

valid filesystem

Throws:

IOException - error if url schema is not supported

fileSystem

@NotNull
public static @NotNull FileSystem fileSystem(@NotNull
 @NotNull URI uri)
                                      throws IOException

Gets a valid file system depending on the scheme of the given url

Parameters:

uri - the url to inspect

Returns:

valid filesystem

Throws:

IOException - error if url schema is not supported

disposeFilesystems

public static void disposeFilesystems()

Releases connections to all virtual file systems created by the pathOf(URI) method for jar or jrt files.

If you do not want to free all file systems then use the disposeFilesystemsIf(Function) method.

disposeFilesystemsIf

public static void disposeFilesystemsIf(@NotNull
 @NotNull Function<FileSystem,Boolean> filter)

Releases connections to all virtual file systems created by the pathOf(URI) method for jar or jrt files.

Parameters:

filter - The action responsible for filtering the elements that must be deleted.

pathOf

@NotNull
public static @NotNull Path pathOf(@NotNull
 @NotNull URL url)
                            throws IOException

Gets the path of an url in the file system (if the scheme is supported).

If the schema is a jar file, the virtual representation of the file as a directory will be returned.

Parameters:

url - the url to inspect

Returns:

a valid file path

Throws:

IOException - error if given url is not supported

pathOf

@NotNull
public static @NotNull Path pathOf(@NotNull
 @NotNull URI uri)
                            throws IOException

Gets the path of an uri in the file system (if the scheme is supported).

If the schema is a jar file, the virtual representation of the file as a directory will be returned.

Important

For files within a "jrt" file system it is necessary to recreate the URI object for it to work correctly. If it is accessed from the URI object itself, the path structure would be as follows:

/jrt:/<module-name>/<file-path>

which is incorrect and the correct way would be the following:

/modules/<module-name>/<file-path>

I still don't know why the Path class does this, but the most reliable thing for now is to recreate the URI with the correct information. When I find a more efficient way, I'll include it in future updates.

Parameters:

uri - the url to inspect

Returns:

a valid file path

Throws:

IOException - error if given url is not supported