CacheFreeingOption (UltimateAdvancementAPI-Common 2.3.1 API)

java.lang.Object

com.fren_gor.ultimateAdvancementAPI.database.CacheFreeingOption

public final class CacheFreeingOption extends Object

The CacheFreeingOption class represents the caching strategy that will be used by the caching system (see DatabaseManager).

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static enum

CacheFreeingOption.Option

Available caching options.
Method Summary

Modifier and Type

Method

Description

static CacheFreeingOption

AUTOMATIC(@NotNull Plugin requester, @Range(from=0L, to=Long.MAX_VALUE) long ticks)

Gets a CacheFreeingOption instance with caching strategy CacheFreeingOption.Option#AUTOMATIC.

static CacheFreeingOption

DONT_CACHE()

Gets a CacheFreeingOption instance with caching strategy CacheFreeingOption.Option#DONT_CACHE.

static CacheFreeingOption

MANUAL(@NotNull Plugin requester)

Gets a CacheFreeingOption instance with caching strategy CacheFreeingOption.Option#MANUAL.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- DONT_CACHE
  
  public static CacheFreeingOption DONT_CACHE()
  
  Gets a CacheFreeingOption instance with caching strategy CacheFreeingOption.Option#DONT_CACHE.
  
  Returns:
  
  A CacheFreeingOption instance with caching strategy CacheFreeingOption.Option#DONT_CACHE.
- AUTOMATIC
  
  public static CacheFreeingOption AUTOMATIC(@NotNull @NotNull Plugin requester, @Range(from=0L, to=Long.MAX_VALUE) long ticks)
  
  Gets a CacheFreeingOption instance with caching strategy CacheFreeingOption.Option#AUTOMATIC.
  
  Parameters:
  
  requester - The Plugin that will make the request.
  
  ticks - The amount of ticks the requested player will remain in the cache.
  
  Returns:
  
  A CacheFreeingOption instance with caching strategy CacheFreeingOption.Option#AUTOMATIC.
- MANUAL
  
  public static CacheFreeingOption MANUAL(@NotNull @NotNull Plugin requester)
  
  Gets a CacheFreeingOption instance with caching strategy CacheFreeingOption.Option#MANUAL.
  
  Parameters:
  
  requester - The Plugin that will make the request.
  
  Returns:
  
  A CacheFreeingOption instance with caching strategy CacheFreeingOption.Option#MANUAL.