Class ResourceResolver

java.lang.Object

com.thecsdev.common.resource.ResourceResolver

public final class ResourceResolver
extends Object

A utility class for resolving and fetching resources from various URIs.

This class provides methods to fetch resources asynchronously based on their URIs. Different protocols can be handled by their corresponding ProtocolHandlers.

See Also:

• ResourceResponse
• ProtocolHandler

Method Summary

Modifier and Type	Method	Description
static final void	bootstrap()	Internal method for bootstrapping the ResourceResolver and registers default protocol handlers.
static final @NotNull CompletableFuture<ResourceResponse>	fetchAsync(@NotNull ResourceRequest request)	Fetches a resource based on the provided ResourceRequest asynchronously.
static final @NotNull CompletableFuture<ResourceResponse>	fetchAsync(@NotNull URI uri)	Fetches a resource from the specified URI asynchronously.
static final void	registerProtocolHandler(@NotNull String scheme, @NotNull ProtocolHandler handler)	Registers a ProtocolHandler for a specific protocol scheme.

Methods inherited from class Object

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

Method Details

registerProtocolHandler

public static final void registerProtocolHandler(@NotNull
 @NotNull String scheme,
 @NotNull
 @NotNull ProtocolHandler handler)
                                          throws NullPointerException

Registers a ProtocolHandler for a specific protocol scheme.

Parameters:

scheme - The protocol scheme (e.g., "http", "https", "file").

handler - The ProtocolHandler responsible for handling the specified scheme.

Throws:

NullPointerException - If an argument is null.

fetchAsync

@NotNull
public static final @NotNull CompletableFuture<ResourceResponse> fetchAsync(@NotNull
 @NotNull URI uri)
                                                                     throws NullPointerException

Fetches a resource from the specified URI asynchronously.

Parameters:

uri - The URI of the resource to fetch.

Returns:

A CompletableFuture that will complete with a ResourceResponse containing the fetched resource data.

Throws:

NullPointerException - If the argument is null.

fetchAsync

@NotNull
public static final @NotNull CompletableFuture<ResourceResponse> fetchAsync(@NotNull
 @NotNull ResourceRequest request)
                                                                     throws NullPointerException

Fetches a resource based on the provided ResourceRequest asynchronously.

Parameters:

request - The ResourceRequest containing details about the resource to fetch.

Returns:

A CompletableFuture that will complete with a ResourceResponse containing the fetched resource data.

Throws:

NullPointerException - If the argument is null.

bootstrap

@Internal
public static final void bootstrap()

Internal method for bootstrapping the ResourceResolver and registers default protocol handlers.

API Note:

Called automatically. Do not call this yourself.