com.fren_gor.ultimateAdvancementAPI.database.DatabaseManager

public final class DatabaseManager extends Object

The database manager. It handles the connection to the database and caches the requested values to improve performances.

The caching system caches teams using TeamProgressions and keeps a link between each online player and the associated TeamProgression. Two players who are part of the same team will always be associated to the same TeamProgression object. More formally, the object returned by getTeamProgression(Player) is the same if and only the players are members of the same team:

 TeamProgression teamP1 = getProgression(playerOne);
 TeamProgression teamP2 = getProgression(playerTwo);
 if (teamP1.contains(p2)) { // Players are members of the same team
    assert teamP1 == teamP2;
 } else { // Players are in two separate teams
    assert teamP1 != teamP2;
 }

By default, players are kept in cache until they quit. However, this behavior can be overridden through the loadOfflinePlayer(UUID, CacheFreeingOption) method, which forces a player to stay in cache even if they quit. If the player is not online, they'll be loaded.

There is, however, a limit on the maximum amount of requests a plugin can do. For more information, see getLoadingRequestsAmount(Plugin, UUID, CacheFreeingOption.Option).

This class is thread safe.

Field Summary

Fields

Modifier and Type

Field

Description

static final int

MAX_SIMULTANEOUS_LOADING_REQUESTS

Max possible loading requests a plugin can make simultaneously per offline player.
Constructor Summary

Constructors

Constructor

Description

DatabaseManager(@NotNull AdvancementMain main)

Creates a new DatabaseManager which uses an in-memory database.

DatabaseManager(@NotNull AdvancementMain main, @NotNull File dbFile)

Creates a new DatabaseManager which uses a SQLite database.

DatabaseManager(@NotNull AdvancementMain main, @NotNull String username, @NotNull String password, @NotNull String databaseName, @NotNull String host, @Range(from=1, to=Integer.MAX_VALUE) int port, @Range(from=1, to=Integer.MAX_VALUE) int poolSize, @Range(from=250L, to=Long.MAX_VALUE) long connectionTimeout)

Creates a new DatabaseManager which uses a MySQL database.
Method Summary

Modifier and Type

Method

Description

@Range(from=0, to=65535) int

getLoadingRequestsAmount(@NotNull Plugin plugin, @NotNull UUID uuid, CacheFreeingOption.Option type)

Returns the number of currently active loading requests done by a plugin for the specified player with the provided CacheFreeingOption.Option.

@NotNull CompletableFuture<ObjectResult<@NotNull String>>

getStoredPlayerName(@NotNull UUID uuid)

Gets the in-database stored name of the provided player.

@NotNull TeamProgression

getTeamProgression(@NotNull UUID uuid)

Returns the TeamProgression of the team of the provided player.

@NotNull TeamProgression

getTeamProgression(@NotNull Player player)

Returns the TeamProgression of the team of the provided player.

boolean

isLoaded(UUID uuid)

Returns whether the provided player is loaded into the cache.

boolean

isLoaded(@NotNull OfflinePlayer player)

Returns whether the provided offline player is loaded into the cache.

boolean

isLoaded(@NotNull Player player)

Returns whether the provided player is loaded into the cache.

boolean

isLoadedAndOnline(UUID uuid)

Returns whether the provided player is online and loaded into the cache.

boolean

isLoadedAndOnline(@NotNull Player player)

Returns whether the provided player is online and loaded into the cache.

boolean

isOfflinePlayerLoaded(UUID uuid)

Returns whether at least one loading request is currently active for the specified player.

boolean

isOfflinePlayerLoaded(UUID uuid, Plugin requester)

Returns whether at least one loading request, done by the provided plugin, is currently active for the specified player.

@NotNull CompletableFuture<ObjectResult<@NotNull Boolean>>

isUnredeemed(@NotNull AdvancementKey key, @NotNull TeamProgression pro)

Returns whether the provided advancement is unredeemed for the specified team.

@NotNull CompletableFuture<ObjectResult<@NotNull Boolean>>

isUnredeemed(@NotNull AdvancementKey key, @NotNull UUID uuid)

Returns whether the provided advancement is unredeemed for the specified player.

@NotNull CompletableFuture<ObjectResult<@NotNull TeamProgression>>

loadOfflinePlayer(@NotNull UUID uuid, @NotNull CacheFreeingOption option)

Loads the provided player from the database into the caching system.

CompletableFuture<ObjectResult<@NotNull TeamProgression>>

movePlayerInNewTeam(@NotNull UUID uuid)

Moves the provided player into a new team.

CompletableFuture<ObjectResult<@NotNull TeamProgression>>

movePlayerInNewTeam(@NotNull Player player)

Moves the provided player into a new team.

@NotNull CompletableFuture<Result>

setUnredeemed(@NotNull AdvancementKey key, boolean giveRewards, @NotNull TeamProgression pro)

Sets an advancement unredeemed for the specified team.

@NotNull CompletableFuture<Result>

setUnredeemed(@NotNull AdvancementKey key, boolean giveRewards, @NotNull UUID uuid)

Sets an advancement unredeemed for the specified player.

void

unloadOfflinePlayer(@NotNull UUID uuid, @NotNull Plugin requester)

Unloads the provided player from the caching system.

void

unregister()

Closes the connection to the database and frees the cache.

CompletableFuture<Result>

unregisterOfflinePlayer(@NotNull UUID uuid)

Unregisters the provided player.

CompletableFuture<Result>

unregisterOfflinePlayer(@NotNull OfflinePlayer player)

Unregisters the provided player.

@NotNull CompletableFuture<Result>

unsetUnredeemed(@NotNull AdvancementKey key, @NotNull TeamProgression pro)

Redeem the specified advancement for the provided team.

@NotNull CompletableFuture<Result>

unsetUnredeemed(@NotNull AdvancementKey key, @NotNull UUID uuid)

Redeem the specified advancement for the provided player.

@NotNull CompletableFuture<Result>

updatePlayerName(@NotNull Player player)

Updates the name of the specified player in the database.

@NotNull CompletableFuture<Result>

updatePlayerTeam(@NotNull UUID playerToMove, @NotNull UUID otherTeamMember)

Moves the provided player from their team to the second player's one.

@NotNull CompletableFuture<Result>

updatePlayerTeam(@NotNull Player playerToMove, @NotNull TeamProgression otherTeamProgression)

Moves the provided player from their team to the specified one.

@NotNull CompletableFuture<Result>

updatePlayerTeam(@NotNull Player playerToMove, @NotNull Player otherTeamMember)

Moves the provided player from their team to the second player's one.

int

updateProgression(@NotNull AdvancementKey key, @NotNull TeamProgression progression, @Range(from=0, to=Integer.MAX_VALUE) int newProgression)

Updates the progression of the specified advancement.

int

updateProgression(@NotNull AdvancementKey key, @NotNull UUID uuid, @Range(from=0, to=Integer.MAX_VALUE) int newProgression)

Updates the progression of the specified advancement.

int

updateProgression(@NotNull AdvancementKey key, @NotNull Player player, @Range(from=0, to=Integer.MAX_VALUE) int newProgression)

Updates the progression of the specified advancement.

@NotNull Map.Entry<Integer,CompletableFuture<Result>>

updateProgressionWithCompletable(@NotNull AdvancementKey key, @NotNull TeamProgression progression, @Range(from=0, to=Integer.MAX_VALUE) int newProgression)

Updates the progression of the specified advancement.

@NotNull Map.Entry<Integer,CompletableFuture<Result>>

updateProgressionWithCompletable(@NotNull AdvancementKey key, @NotNull UUID uuid, @Range(from=0, to=Integer.MAX_VALUE) int newProgression)

Updates the progression of the specified advancement.

@NotNull Map.Entry<Integer,CompletableFuture<Result>>

updateProgressionWithCompletable(@NotNull AdvancementKey key, @NotNull Player player, @Range(from=0, to=Integer.MAX_VALUE) int newProgression)

Updates the progression of the specified advancement.

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

Field Details
- MAX_SIMULTANEOUS_LOADING_REQUESTS
  
  public static final int MAX_SIMULTANEOUS_LOADING_REQUESTS
  
  Max possible loading requests a plugin can make simultaneously per offline player.
  Limit is applied to automatic and manual requests separately and doesn't apply to requests which don't cache.
  See Also:
  
  Constant Field Values
Constructor Details
- DatabaseManager
  
  public DatabaseManager(@NotNull @NotNull AdvancementMain main) throws Exception
  
  Creates a new DatabaseManager which uses an in-memory database.
  
  Parameters:
  
  main - The AdvancementMain.
  
  Throws:
  
  Exception - If anything goes wrong.
- DatabaseManager
  
  public DatabaseManager(@NotNull @NotNull AdvancementMain main, @NotNull @NotNull File dbFile) throws Exception
  
  Creates a new DatabaseManager which uses a SQLite database.
  
  Parameters:
  
  main - The AdvancementMain.
  
  dbFile - The SQLite database file.
  
  Throws:
  
  Exception - If anything goes wrong.
- DatabaseManager
  
  public DatabaseManager(@NotNull @NotNull AdvancementMain main, @NotNull @NotNull String username, @NotNull @NotNull String password, @NotNull @NotNull String databaseName, @NotNull @NotNull String host, @Range(from=1, to=Integer.MAX_VALUE) int port, @Range(from=1, to=Integer.MAX_VALUE) int poolSize, @Range(from=250L, to=Long.MAX_VALUE) long connectionTimeout) throws Exception
  
  Creates a new DatabaseManager which uses a MySQL database.
  
  Parameters:
  
  main - The AdvancementMain.
  
  username - The username.
  
  password - The password.
  
  databaseName - The name of the database.
  
  host - The MySQL host.
  
  port - The MySQL port. Must be greater than zero.
  
  poolSize - The pool size. Must be greater than zero.
  
  connectionTimeout - The connection timeout. Must be greater or equal to 250.
  
  Throws:
  
  Exception - If anything goes wrong.
Method Details
- unregister
  
  public void unregister()
  
  Closes the connection to the database and frees the cache.
  This method does not call Events.
- updatePlayerName
  
  @NotNull public @NotNull CompletableFuture<Result> updatePlayerName(@NotNull @NotNull Player player)
  
  Updates the name of the specified player in the database.
  Parameters:
  
  player - The player to update.
  
  Returns:
  
  A CompletableFuture which provides the Result of the operation.
  
  See Also:
  
  UltimateAdvancementAPI.updatePlayerName(Player)
- updatePlayerTeam
  
  @NotNull public @NotNull CompletableFuture<Result> updatePlayerTeam(@NotNull @NotNull Player playerToMove, @NotNull @NotNull Player otherTeamMember) throws UserNotLoadedException
  
  Moves the provided player from their team to the second player's one.
  Parameters:
  
  playerToMove - The player to move.
  
  otherTeamMember - A player of the destination team.
  
  Returns:
  
  A CompletableFuture which provides the Result of the operation.
  
  Throws:
  
  UserNotLoadedException - If the player was not loaded into the cache.
  
  See Also:
  
  UltimateAdvancementAPI.updatePlayerTeam(Player, Player, Consumer)
- updatePlayerTeam
  
  @NotNull public @NotNull CompletableFuture<Result> updatePlayerTeam(@NotNull @NotNull UUID playerToMove, @NotNull @NotNull UUID otherTeamMember) throws UserNotLoadedException
  
  Moves the provided player from their team to the second player's one.
  Parameters:
  
  playerToMove - The UUID of the player to move.
  
  otherTeamMember - The UUID of a player of the destination team.
  
  Returns:
  
  A CompletableFuture which provides the Result of the operation.
  
  Throws:
  
  UserNotLoadedException - If the player was not loaded into the cache.
  
  See Also:
  
  UltimateAdvancementAPI.updatePlayerTeam(UUID, UUID, Consumer)
- updatePlayerTeam
  
  @NotNull public @NotNull CompletableFuture<Result> updatePlayerTeam(@NotNull @NotNull Player playerToMove, @NotNull @NotNull TeamProgression otherTeamProgression) throws UserNotLoadedException
  
  Moves the provided player from their team to the specified one.
  
  Parameters:
  
  playerToMove - The player to move.
  
  otherTeamProgression - The TeamProgression of the target team.
  
  Returns:
  
  A CompletableFuture which provides the Result of the operation.
  
  Throws:
  
  UserNotLoadedException - If the player was not loaded into the cache.
- movePlayerInNewTeam
  
  public CompletableFuture<ObjectResult<@NotNull TeamProgression>> movePlayerInNewTeam(@NotNull @NotNull Player player) throws UserNotLoadedException
  
  Moves the provided player into a new team.
  Parameters:
  
  player - The player.
  
  Returns:
  
  A CompletableFuture<ObjectResult> which provides the new player team's TeamProgression.
  
  Throws:
  
  UserNotLoadedException - If the player was not loaded into the cache.
  
  See Also:
  
  UltimateAdvancementAPI.movePlayerInNewTeam(Player)
- movePlayerInNewTeam
  
  public CompletableFuture<ObjectResult<@NotNull TeamProgression>> movePlayerInNewTeam(@NotNull @NotNull UUID uuid) throws UserNotLoadedException
  
  Moves the provided player into a new team.
  Parameters:
  
  uuid - The UUID of the player.
  
  Returns:
  
  A CompletableFuture<ObjectResult> which provides the new player team's TeamProgression.
  
  Throws:
  
  UserNotLoadedException - If the player was not loaded into the cache.
  
  See Also:
  
  UltimateAdvancementAPI.movePlayerInNewTeam(UUID)
- unregisterOfflinePlayer
  
  public CompletableFuture<Result> unregisterOfflinePlayer(@NotNull @NotNull OfflinePlayer player) throws IllegalStateException
  
  Unregisters the provided player. The player must be offline and not loaded into the cache.
  Parameters:
  
  player - The player to unregister.
  
  Returns:
  
  A CompletableFuture which provides the Result of the operation.
  
  Throws:
  
  IllegalStateException - If the player is online or loaded into the cache.
  
  See Also:
  
  UltimateAdvancementAPI.unregisterOfflinePlayer(OfflinePlayer)
- unregisterOfflinePlayer
  
  public CompletableFuture<Result> unregisterOfflinePlayer(@NotNull @NotNull UUID uuid) throws IllegalStateException
  
  Unregisters the provided player. The player must be offline and not loaded into the cache.
  Parameters:
  
  uuid - The UUID of the player to unregister.
  
  Returns:
  
  A CompletableFuture which provides the Result of the operation.
  
  Throws:
  
  IllegalStateException - If the player is online or loaded into the cache.
  
  See Also:
  
  UltimateAdvancementAPI.unregisterOfflinePlayer(UUID)
- updateProgression
  
  public int updateProgression(@NotNull @NotNull AdvancementKey key, @NotNull @NotNull Player player, @Range(from=0, to=Integer.MAX_VALUE) int newProgression) throws UserNotLoadedException
  
  Updates the progression of the specified advancement.
  
  Parameters:
  
  key - The advancement key.
  
  player - The player who made the advancement.
  
  newProgression - The new progression.
  
  Returns:
  
  The old progression.
  
  Throws:
  
  UserNotLoadedException - If the player was not loaded into the cache.
- updateProgression
  
  public int updateProgression(@NotNull @NotNull AdvancementKey key, @NotNull @NotNull UUID uuid, @Range(from=0, to=Integer.MAX_VALUE) int newProgression) throws UserNotLoadedException
  
  Updates the progression of the specified advancement.
  
  Parameters:
  
  key - The advancement key.
  
  uuid - The UUID of the player who made the advancement.
  
  newProgression - The new progression.
  
  Returns:
  
  The old progression.
  
  Throws:
  
  UserNotLoadedException - If the player was not loaded into the cache.
- updateProgression
  
  public int updateProgression(@NotNull @NotNull AdvancementKey key, @NotNull @NotNull TeamProgression progression, @Range(from=0, to=Integer.MAX_VALUE) int newProgression)
  
  Updates the progression of the specified advancement.
  
  Parameters:
  
  key - The advancement key.
  
  progression - The TeamProgression of the team which made the advancement.
  
  newProgression - The new progression.
  
  Returns:
  
  The old progression.
- updateProgressionWithCompletable
  
  @NotNull public @NotNull Map.Entry<Integer,CompletableFuture<Result>> updateProgressionWithCompletable(@NotNull @NotNull AdvancementKey key, @NotNull @NotNull Player player, @Range(from=0, to=Integer.MAX_VALUE) int newProgression) throws UserNotLoadedException
  
  Updates the progression of the specified advancement.
  
  Parameters:
  
  key - The advancement key.
  
  player - The player who made the advancement.
  
  newProgression - The new progression.
  
  Returns:
  
  A pair containing the old progression and a CompletableFuture which provides the Result of the operation.
  
  Throws:
  
  UserNotLoadedException - If the player was not loaded into the cache.
- updateProgressionWithCompletable
  
  @NotNull public @NotNull Map.Entry<Integer,CompletableFuture<Result>> updateProgressionWithCompletable(@NotNull @NotNull AdvancementKey key, @NotNull @NotNull UUID uuid, @Range(from=0, to=Integer.MAX_VALUE) int newProgression) throws UserNotLoadedException
  
  Updates the progression of the specified advancement.
  
  Parameters:
  
  key - The advancement key.
  
  uuid - The UUID of the player who made the advancement.
  
  newProgression - The new progression.
  
  Returns:
  
  A pair containing the old progression and a CompletableFuture which provides the Result of the operation.
  
  Throws:
  
  UserNotLoadedException - If the player was not loaded into the cache.
- updateProgressionWithCompletable
  
  @NotNull public @NotNull Map.Entry<Integer,CompletableFuture<Result>> updateProgressionWithCompletable(@NotNull @NotNull AdvancementKey key, @NotNull @NotNull TeamProgression progression, @Range(from=0, to=Integer.MAX_VALUE) int newProgression)
  
  Updates the progression of the specified advancement.
  
  Parameters:
  
  key - The advancement key.
  
  progression - The TeamProgression of the team which made the advancement.
  
  newProgression - The new progression.
  
  Returns:
  
  A pair containing the old progression and a CompletableFuture which provides the Result of the operation.
- getTeamProgression
  
  @NotNull public @NotNull TeamProgression getTeamProgression(@NotNull @NotNull Player player) throws UserNotLoadedException
  
  Returns the TeamProgression of the team of the provided player.
  Parameters:
  
  player - The player.
  
  Returns:
  
  The TeamProgression of the player's team.
  
  Throws:
  
  UserNotLoadedException - If the player was not loaded into the cache.
  
  See Also:
  
  UltimateAdvancementAPI.getTeamProgression(Player)
- getTeamProgression
  
  @NotNull public @NotNull TeamProgression getTeamProgression(@NotNull @NotNull UUID uuid) throws UserNotLoadedException
  
  Returns the TeamProgression of the team of the provided player.
  Parameters:
  
  uuid - The UUID of the player.
  
  Returns:
  
  The TeamProgression of the player's team.
  
  Throws:
  
  UserNotLoadedException - If the player was not loaded into the cache.
  
  See Also:
  
  UltimateAdvancementAPI.getTeamProgression(UUID)
- isLoaded
  
  @Contract(pure=true) public boolean isLoaded(@NotNull @NotNull Player player)
  
  Returns whether the provided player is loaded into the cache.
  Parameters:
  
  player - The player.
  
  Returns:
  
  Whether the provided player is loaded into the cache.
  
  See Also:
  
  UltimateAdvancementAPI.isLoaded(Player)
- isLoaded
  
  @Contract(pure=true) public boolean isLoaded(@NotNull @NotNull OfflinePlayer player)
  
  Returns whether the provided offline player is loaded into the cache.
  Parameters:
  
  player - The player.
  
  Returns:
  
  Whether the provided offline player is loaded into the cache.
  
  See Also:
  
  UltimateAdvancementAPI.isLoaded(OfflinePlayer)
- isLoaded
  
  @Contract(pure=true, value="null -> false") public boolean isLoaded(UUID uuid)
  
  Returns whether the provided player is loaded into the cache.
  Parameters:
  
  uuid - The UUID of the player.
  
  Returns:
  
  Whether the provided player is loaded into the cache.
  
  See Also:
  
  UltimateAdvancementAPI.isLoaded(UUID)
- isLoadedAndOnline
  
  @Contract(pure=true) public boolean isLoadedAndOnline(@NotNull @NotNull Player player)
  
  Returns whether the provided player is online and loaded into the cache.
  
  Parameters:
  
  player - The player.
  
  Returns:
  
  Whether the provided player is online and loaded into the cache.
- isLoadedAndOnline
  
  @Contract(pure=true, value="null -> false") public boolean isLoadedAndOnline(UUID uuid)
  
  Returns whether the provided player is online and loaded into the cache.
  
  Parameters:
  
  uuid - The UUID of the player.
  
  Returns:
  
  Whether the provided player is online and loaded into the cache.
- getLoadingRequestsAmount
  
  @Contract(pure=true) public @Range(from=0, to=65535) int getLoadingRequestsAmount(@NotNull @NotNull Plugin plugin, @NotNull @NotNull UUID uuid, @NotNull CacheFreeingOption.Option type)
  
  Returns the number of currently active loading requests done by a plugin for the specified player with the provided CacheFreeingOption.Option.
  There is a maximum per-plugin amount of requests that can be done for each player, which is MAX_SIMULTANEOUS_LOADING_REQUESTS.
  This limit is applied to CacheFreeingOption.Option#AUTOMATIC and CacheFreeingOption.Option#MANUAL separately (so a plugin can do maximum MAX_SIMULTANEOUS_LOADING_REQUESTS automatic requests and MAX_SIMULTANEOUS_LOADING_REQUESTS manual requests simultaneously). Since CacheFreeingOption.Option#DONT_CACHE doesn't cache, no limit is applied to it.
  Parameters:
  
  plugin - The plugin.
  
  uuid - The UUID of the player.
  
  type - The CacheFreeingOption.Option.
  
  Returns:
  
  The number of the currently active player loading requests.
  
  See Also:
  
  UltimateAdvancementAPI.getLoadingRequestsAmount(UUID, CacheFreeingOption.Option)
- isUnredeemed
  
  @NotNull public @NotNull CompletableFuture<ObjectResult<@NotNull Boolean>> isUnredeemed(@NotNull @NotNull AdvancementKey key, @NotNull @NotNull UUID uuid) throws UserNotLoadedException
  
  Returns whether the provided advancement is unredeemed for the specified player.
  Parameters:
  
  key - The advancement key.
  
  uuid - The UUID of the player.
  
  Returns:
  
  A CompletableFuture<ObjectResult> which provides a boolean value that is true if the provided advancement is unredeemed for the specified player, false otherwise.
  
  Throws:
  
  UserNotLoadedException - If the player was not loaded into the cache.
  
  See Also:
  
  UltimateAdvancementAPI.isUnredeemed(Advancement, UUID, Consumer)
- isUnredeemed
  
  @NotNull public @NotNull CompletableFuture<ObjectResult<@NotNull Boolean>> isUnredeemed(@NotNull @NotNull AdvancementKey key, @NotNull @NotNull TeamProgression pro)
  
  Returns whether the provided advancement is unredeemed for the specified team.
  
  Parameters:
  
  key - The advancement key.
  
  pro - The TeamProgression of the team.
  
  Returns:
  
  A CompletableFuture<ObjectResult> which provides a boolean value that is true if the provided advancement is unredeemed for the specified player, false otherwise.
- setUnredeemed
  
  @NotNull public @NotNull CompletableFuture<Result> setUnredeemed(@NotNull @NotNull AdvancementKey key, boolean giveRewards, @NotNull @NotNull UUID uuid) throws UserNotLoadedException
  
  Sets an advancement unredeemed for the specified player.
  Parameters:
  
  key - The advancement key.
  
  giveRewards - Whether advancement rewards will be given on redeem.
  
  uuid - The UUID of the player.
  
  Returns:
  
  A CompletableFuture which provides the Result of the operation.
  
  Throws:
  
  UserNotLoadedException - If the player was not loaded into the cache.
  
  See Also:
  
  UltimateAdvancementAPI.setUnredeemed(Advancement, UUID, boolean, Consumer)
- setUnredeemed
  
  @NotNull public @NotNull CompletableFuture<Result> setUnredeemed(@NotNull @NotNull AdvancementKey key, boolean giveRewards, @NotNull @NotNull TeamProgression pro)
  
  Sets an advancement unredeemed for the specified team.
  
  Parameters:
  
  key - The advancement key.
  
  giveRewards - Whether advancement rewards will be given on redeem.
  
  pro - The TeamProgression of the team.
  
  Returns:
  
  A CompletableFuture which provides the Result of the operation.
- unsetUnredeemed
  
  @NotNull public @NotNull CompletableFuture<Result> unsetUnredeemed(@NotNull @NotNull AdvancementKey key, @NotNull @NotNull UUID uuid) throws UserNotLoadedException
  
  Redeem the specified advancement for the provided player.
  Parameters:
  
  key - The advancement key.
  
  uuid - The UUID of the player.
  
  Returns:
  
  A CompletableFuture which provides the Result of the operation.
  
  Throws:
  
  UserNotLoadedException - If the player was not loaded into the cache.
  
  See Also:
  
  UltimateAdvancementAPI.unsetUnredeemed(Advancement, UUID, Consumer)
- unsetUnredeemed
  
  @NotNull public @NotNull CompletableFuture<Result> unsetUnredeemed(@NotNull @NotNull AdvancementKey key, @NotNull @NotNull TeamProgression pro)
  
  Redeem the specified advancement for the provided team.
  
  Parameters:
  
  key - The advancement key.
  
  pro - The TeamProgression of the team.
  
  Returns:
  
  A CompletableFuture which provides the Result of the operation.
- getStoredPlayerName
  
  @NotNull public @NotNull CompletableFuture<ObjectResult<@NotNull String>> getStoredPlayerName(@NotNull @NotNull UUID uuid)
  
  Gets the in-database stored name of the provided player.
  Parameters:
  
  uuid - The UUID of the player.
  
  Returns:
  
  A CompletableFuture<ObjectResult> which provides the stored name of the player.
  
  See Also:
  
  UltimateAdvancementAPI.getStoredPlayerName(UUID, Consumer)
- loadOfflinePlayer
  
  @NotNull public @NotNull CompletableFuture<ObjectResult<@NotNull TeamProgression>> loadOfflinePlayer(@NotNull @NotNull UUID uuid, @NotNull @NotNull CacheFreeingOption option)
  Loads the provided player from the database into the caching system.
  Different things happens based on the specified CacheFreeingOption:
  
  CacheFreeingOption.DONT_CACHE(): the player isn't loaded in the caching system, but loads and returns only the player team's TeamProgression;
  
  CacheFreeingOption.AUTOMATIC(Plugin, long): the player is loaded for a certain amount of ticks;
  
  CacheFreeingOption.MANUAL(Plugin): the player is loaded and kept until unloadOfflinePlayer(UUID, Plugin) is called.
  Parameters:
  
  uuid - The UUID of the player to load.
  
  option - The chosen CacheFreeingOption.
  
  Returns:
  
  A CompletableFuture<ObjectResult> which provides the player team's TeamProgression.
  
  See Also:
  
  UltimateAdvancementAPI.loadOfflinePlayer(UUID, CacheFreeingOption, Consumer)
- isOfflinePlayerLoaded
  
  @Contract(pure=true, value="null -> false") public boolean isOfflinePlayerLoaded(UUID uuid)
  
  Returns whether at least one loading request is currently active for the specified player.
  
  Parameters:
  
  uuid - The UUID of the player.
  
  Returns:
  
  Whether at least one loading request for the specified player is currently active.
- isOfflinePlayerLoaded
  
  @Contract(pure=true, value="null, null -> false; null, !null -> false; !null, null -> false") public boolean isOfflinePlayerLoaded(UUID uuid, Plugin requester)
  
  Returns whether at least one loading request, done by the provided plugin, is currently active for the specified player.
  Parameters:
  
  uuid - The UUID of the player.
  
  requester - The plugin which requested the loading.
  
  Returns:
  
  Whether at least one loading request, done by the provided plugin, for the specified player is currently active.
  
  See Also:
  
  UltimateAdvancementAPI.isOfflinePlayerLoaded(UUID)
- unloadOfflinePlayer
  
  public void unloadOfflinePlayer(@NotNull @NotNull UUID uuid, @NotNull @NotNull Plugin requester)
  
  Unloads the provided player from the caching system.
  Note that this method will only unload players loaded with CacheFreeingOption.MANUAL(Plugin).
  Parameters:
  
  uuid - The UUID of the player to unload.
  
  requester - The plugin which requested the loading.
  
  See Also:
  
  UltimateAdvancementAPI.unloadOfflinePlayer(UUID)

Class DatabaseManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

MAX_SIMULTANEOUS_LOADING_REQUESTS

Constructor Details

DatabaseManager

DatabaseManager

DatabaseManager

Method Details

unregister

updatePlayerName

updatePlayerTeam

updatePlayerTeam

updatePlayerTeam

movePlayerInNewTeam

movePlayerInNewTeam

unregisterOfflinePlayer

unregisterOfflinePlayer

updateProgression

updateProgression

updateProgression

updateProgressionWithCompletable

updateProgressionWithCompletable

updateProgressionWithCompletable

getTeamProgression

getTeamProgression

isLoaded

isLoaded

isLoaded

isLoadedAndOnline

isLoadedAndOnline

getLoadingRequestsAmount

isUnredeemed

isUnredeemed

setUnredeemed

setUnredeemed

unsetUnredeemed

unsetUnredeemed

getStoredPlayerName

loadOfflinePlayer

isOfflinePlayerLoaded

isOfflinePlayerLoaded

unloadOfflinePlayer