Package io.github.thecsdev.tcdcommons.api.util.io.cache

Class CachedResource<R>

java.lang.Object

io.github.thecsdev.tcdcommons.api.util.io.cache.CachedResource<R>

public final class CachedResource<R>
extends Object

Provides information about a resource that has successfully been fetched via IResourceFetchTask.fetchResourceSync().

Constructor Summary

Constructors

Constructor	Description
CachedResource(R resource, long resourceSizeB, Instant expirationDate)	Creates an instance of CachedResource.

Method Summary

Modifier and Type	Method	Description
final Instant	getExpirationDate()	Returns the time at which this CachedResource will be considered as "expired".
final R	getResource()	Returns the fetched resource itself.
final long	getResourceSizeB()	Returns the "size" of the resource, aka the amount of RAM memory the resource takes up.
final Class<R>	getResourceType()	Returns the Class instance representing the type of the CachedResource.
static final CachedResource<byte[]>	ofBytes(byte[] bytes, Instant expirationDate)	Creates a CachedResource instance for Byte arrays.
static final CachedResource<String>	ofString(String text, Instant expirationDate)	Creates a CachedResource instance for Strings.

Methods inherited from class java.lang.Object

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

Constructor Details

CachedResource

public CachedResource(R resource,
 long resourceSizeB,
 Instant expirationDate)
               throws NullPointerException

Creates an instance of CachedResource.

Parameters:

resource - The resource that is being cached.

resourceSizeB - The amount of space the resource takes up in RAM, in bytes.

expirationDate - The time in the future, at which the resource will expire.

Throws:

NullPointerException - If an argument is null.

Method Details

getResourceType

public final Class<R> getResourceType()

Returns the Class instance representing the type of the CachedResource.

getResource

public final R getResource()

Returns the fetched resource itself.

getResourceSizeB

public final long getResourceSizeB()

Returns the "size" of the resource, aka the amount of RAM memory the resource takes up. Measured in bytes.

getExpirationDate

public final Instant getExpirationDate()

Returns the time at which this CachedResource will be considered as "expired".

ofString

public static final CachedResource<String> ofString(String text,
 Instant expirationDate)
                                             throws NullPointerException

Creates a CachedResource instance for Strings.

Parameters:

text - The String representing the resource.

Throws:

NullPointerException - If the argument is null.

ofBytes

public static final CachedResource<byte[]> ofBytes(byte[] bytes,
 Instant expirationDate)
                                            throws NullPointerException

Creates a CachedResource instance for Byte arrays.

Parameters:

bytes - The Byte array representing the resource.

Throws:

NullPointerException - If the argument is null.