Class HttpProfileCache.CacheBucket

java.lang.Object

com.thecsdev.common.resource.http.HttpProfileCache.CacheBucket

Enclosing class:

HttpProfileCache

@Experimental
public static final class HttpProfileCache.CacheBucket
extends Object

Represents a directory where cache data for a given URI is stored.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object obj)
final CompletableFuture<@Nullable ResourceResponse>	fetchAsync(@NotNull ResourceRequest request)	Fetches the cached ResourceResponse for the given ResourceRequest, if it exists and is valid.
final @NotNull Path	getDirname()	Returns the Path to the directory where cache data for this HttpProfileCache.CacheBucket is stored.
final int	hashCode()
static final @NotNull HttpProfileCache.CacheBucket	of(@NotNull HttpProfileCache cache, @NotNull ResourceRequest request)	Creates a new HttpProfileCache.CacheBucket instance for the given ResourceRequest, using the given HttpProfileCache to determine the base directory.
static final @NotNull HttpProfileCache.CacheBucket	of(@NotNull HttpProfileCache cache, @NotNull String httpMethod, @NotNull URI uri)	Creates a new HttpProfileCache.CacheBucket instance for the given URI and HTTP method, using the given HttpProfileCache to determine the base directory.
final CompletableFuture<@Nullable Void>	storeAsync(@NotNull ResourceRequest request, @NotNull ResourceResponse response)	Stores the given ResourceResponse in the cache for this HttpProfileCache.CacheBucket.

Methods inherited from class Object

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

Method Details

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

getDirname

@NotNull
public final @NotNull Path getDirname()

Returns the Path to the directory where cache data for this HttpProfileCache.CacheBucket is stored.

fetchAsync

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

Fetches the cached ResourceResponse for the given ResourceRequest, if it exists and is valid. Returns a CompletableFuture that completes with the cached response, or null the cache is a "miss".

Parameters:

request - The ResourceRequest for which to fetch the cached response.

Throws:

NullPointerException - If the argument is null.

storeAsync

public final CompletableFuture<@Nullable Void> storeAsync(@NotNull
 @NotNull ResourceRequest request,
 @NotNull
 @NotNull ResourceResponse response)
                                                   throws NullPointerException

Stores the given ResourceResponse in the cache for this HttpProfileCache.CacheBucket. Returns a CompletableFuture that completes when the response has been stored.

Parameters:

response - The ResourceResponse to store in the cache.

Throws:

NullPointerException - If the argument is null.

of

@NotNull
public static final @NotNull HttpProfileCache.CacheBucket of(@NotNull
 @NotNull HttpProfileCache cache,
 @NotNull
 @NotNull ResourceRequest request)
                                                      throws NullPointerException

Creates a new HttpProfileCache.CacheBucket instance for the given ResourceRequest, using the given HttpProfileCache to determine the base directory.

Parameters:

cache - The HttpProfileCache to use as the base directory for this cache entry.

request - The ResourceRequest for which to create the cache entry.

Throws:

NullPointerException - If an argument is null.

of

@NotNull
public static final @NotNull HttpProfileCache.CacheBucket of(@NotNull
 @NotNull HttpProfileCache cache,
 @NotNull
 @NotNull String httpMethod,
 @NotNull
 @NotNull URI uri)
                                                      throws NullPointerException

Creates a new HttpProfileCache.CacheBucket instance for the given URI and HTTP method, using the given HttpProfileCache to determine the base directory.

Parameters:

cache - The HttpProfileCache to use as the base directory for this cache entry.

httpMethod - The HTTP method (e.g., "GET", "HEAD") associated with this cache entry.

uri - The URI associated with this cache entry.

Throws:

NullPointerException - If an argument is null.