Class TimedCacheableProfileable

java.lang.Object

com.cryptomorin.xseries.profiles.objects.cache.CacheableProfileable

com.cryptomorin.xseries.profiles.objects.cache.TimedCacheableProfileable

All Implemented Interfaces:

Profileable

Direct Known Subclasses:

Profileable.DynamicGameProfileProfileable, Profileable.PlayerProfileable, Profileable.PlayerProfileProfileable, Profileable.StringProfileable, Profileable.UsernameProfileable, Profileable.UUIDProfileable

@Internal
public abstract class TimedCacheableProfileable
extends CacheableProfileable

Any Profileable that can have its results cached temporarily. This class should not be used directly.

Nested Class Summary

Nested classes/interfaces inherited from interface Profileable

Profileable.DynamicGameProfileProfileable, Profileable.PlayerProfileable, Profileable.PlayerProfileProfileable, Profileable.RawGameProfileProfileable, Profileable.StringProfileable, Profileable.UsernameProfileable, Profileable.UUIDProfileable

Field Summary

Fields inherited from class CacheableProfileable

cache, lastError

Constructor Summary

Constructors

Constructor	Description
TimedCacheableProfileable()

Method Summary

Modifier and Type	Method	Description
protected @NotNull Duration	expiresAfter()	The amount of time the cached results of this profile can be used until it's re-evaluated.
final boolean	hasExpired(boolean renew)

Methods inherited from class CacheableProfileable

cacheProfile, getProfile, hasExpired, isReady, toString

Methods inherited from class Object

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

Methods inherited from interface Profileable

getDisposableProfile, getProfileValue, prepare, test, transform

Constructor Details

TimedCacheableProfileable

public TimedCacheableProfileable()

Method Details

expiresAfter

@NotNull
protected @NotNull Duration expiresAfter()

The amount of time the cached results of this profile can be used until it's re-evaluated. By default, it uses the internal cache's expiration date (6 hours). Negative durations should not be used. Duration.ZERO means that the cache never expires.

hasExpired

public final boolean hasExpired(boolean renew)

Overrides:

hasExpired in class CacheableProfileable

Parameters:

renew - if this profile is expired, should we mark it as renewed?

Returns:

true if this profile hasn't been cached yet or the cache is expired.