java.lang.Object

com.fren_gor.ultimateAdvancementAPI.database.impl.MySQL

All Implemented Interfaces:: IDatabase

public class MySQL extends Object implements IDatabase

Class used to establish a connection to a MySQL database.

Constructor Summary

Constructors

Constructor

Description

MySQL(@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, @NotNull Logger logger, @NotNull net.byteflux.libby.LibraryManager manager)

Creates the MySQL connection.
Method Summary

Modifier and Type

Method

Description

void

clearUpTeams()

Clears the unused team ids in the database.

void

close()

Closes the connection to the database.

String

getPlayerName(@NotNull UUID uuid)

Gets the stored name for the specified player.

List<UUID>

getPlayersByName(@NotNull String name)

Gets a list of the players with the specified name (in the database).

Map<AdvancementKey,Integer>

getTeamAdvancements(int teamId)

Gets the team advancements mapped with their respective progressions.

int

getTeamId(@NotNull UUID uuid)

Gets the team id of the provided player.

List<UUID>

getTeamMembers(int teamId)

Gets the team members.

List<Map.Entry<AdvancementKey,Boolean>>

getUnredeemed(int teamId)

Get the list of the unredeemed advancements of the provided team.

boolean

isUnredeemed(@NotNull AdvancementKey key, int teamId)

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

Map.Entry<TeamProgression,Boolean>

loadOrRegisterPlayer(@NotNull UUID uuid, @NotNull String name)

Loads the provided player or registers they if they are new.

TeamProgression

loadUUID(@NotNull UUID uuid)

Loads the provided player from the database.

void

movePlayer(@NotNull UUID uuid, int newTeamId)

Moves the provided player to the specified team.

TeamProgression

movePlayerInNewTeam(@NotNull UUID uuid)

Moves a player in a new team and returns the TeamProgression of the new team.

Connection

openConnection()

Opens or gets a connection to the database.

void

setUnredeemed(@NotNull AdvancementKey key, boolean giveRewards, int teamId)

Sets the provided advancement unredeemed for the specified team.

void

setUp()

Sets up the database, like creating the tables.

void

unregisterPlayer(@NotNull UUID uuid)

Deletes the provided player from the database.

void

unsetUnredeemed(@NotNull AdvancementKey key, int teamId)

Sets the provided advancement redeemed for the specified team if it is unredeemed.

void

unsetUnredeemed(@NotNull List<Map.Entry<AdvancementKey,Boolean>> keyList, int teamId)

Sets the provided advancements redeemed for the specified team.

void

updateAdvancement(@NotNull AdvancementKey key, int teamId, @Range(from=0, to=Integer.MAX_VALUE) int progression)

Updates the progression for the provided advancement and the specified team.

void

updatePlayerName(@NotNull UUID uuid, @NotNull String name)

Updates the player name in the database.

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

Methods inherited from interface com.fren_gor.ultimateAdvancementAPI.database.IDatabase
getPlayerByName, getTeamId, movePlayer, movePlayerInNewTeam, unregisterPlayer

Constructor Details
- MySQL
  
  public MySQL(@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, @NotNull @NotNull Logger logger, @NotNull @NotNull net.byteflux.libby.LibraryManager manager) throws Exception
  
  Creates the MySQL connection.
  
  Parameters:
  
  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.
  
  logger - The plugin Logger.
  
  manager - The LibraryManager.
  
  Throws:
  
  Exception - If anything goes wrong.
Method Details
- setUp
  
  public void setUp() throws SQLException
  
  Sets up the database, like creating the tables.
  
  Specified by:
  
  setUp in interface IDatabase
  
  Throws:
  
  SQLException - If an SQL exception occurs.
- openConnection
  
  public Connection openConnection() throws SQLException
  
  Opens or gets a connection to the database.
  
  Specified by:
  
  openConnection in interface IDatabase
  
  Returns:
  
  The opened connection.
  
  Throws:
  
  SQLException - If an SQL exception occurs.
- close
  
  public void close() throws SQLException
  
  Closes the connection to the database.
  
  Specified by:
  
  close in interface IDatabase
  
  Throws:
  
  SQLException - If an SQL exception occurs.
- getTeamId
  
  public int getTeamId(@NotNull @NotNull UUID uuid) throws SQLException, UserNotRegisteredException
  
  Gets the team id of the provided player.
  
  Specified by:
  
  getTeamId in interface IDatabase
  
  Parameters:
  
  uuid - The player UUID.
  
  Returns:
  
  The team id.
  
  Throws:
  
  SQLException - If an SQL exception occurs.
  
  UserNotRegisteredException - If the provided player could not be found in the database.
- getTeamMembers
  
  public List<UUID> getTeamMembers(int teamId) throws SQLException
  
  Gets the team members.
  
  Specified by:
  
  getTeamMembers in interface IDatabase
  
  Parameters:
  
  teamId - The team id.
  
  Returns:
  
  The team members.
  
  Throws:
  
  SQLException - If an SQL exception occurs.
- getTeamAdvancements
  
  public Map<AdvancementKey,Integer> getTeamAdvancements(int teamId) throws SQLException
  
  Gets the team advancements mapped with their respective progressions.
  The resulting map can contain keys of not-existent advancements that might exist in the database.
  
  Specified by:
  
  getTeamAdvancements in interface IDatabase
  
  Parameters:
  
  teamId - The team id.
  
  Returns:
  
  The team advancements mapped with their respective progressions.
  
  Throws:
  
  SQLException - If an SQL exception occurs.
- loadOrRegisterPlayer
  
  public Map.Entry<TeamProgression,Boolean> loadOrRegisterPlayer(@NotNull @NotNull UUID uuid, @NotNull @NotNull String name) throws SQLException
  
  Loads the provided player or registers they if they are new.
  
  Specified by:
  
  loadOrRegisterPlayer in interface IDatabase
  
  Parameters:
  
  uuid - The player UUID.
  
  name - The player name.
  
  Returns:
  
  A pair containing a (always new) TeamProgression with the player team information and whether the player has been registered (so it was not found in the database).
  
  Throws:
  
  SQLException - If an SQL exception occurs.
- loadUUID
  
  public TeamProgression loadUUID(@NotNull @NotNull UUID uuid) throws SQLException, UserNotRegisteredException
  
  Loads the provided player from the database. If the player is not registered an UserNotRegisteredException is thrown.
  Specified by:
  
  loadUUID in interface IDatabase
  
  Parameters:
  
  uuid - The player UUID.
  
  Returns:
  
  The player team's TeamProgression.
  
  Throws:
  
  SQLException - If an SQL exception occurs.
  
  UserNotRegisteredException - If the provided player could not be found in the database.
  
  See Also:
  
  IDatabase.loadOrRegisterPlayer(UUID, String)
- updateAdvancement
  
  public void updateAdvancement(@NotNull @NotNull AdvancementKey key, int teamId, @Range(from=0, to=Integer.MAX_VALUE) int progression) throws SQLException
  
  Updates the progression for the provided advancement and the specified team.
  
  Specified by:
  
  updateAdvancement in interface IDatabase
  
  Parameters:
  
  key - The advancement key.
  
  teamId - The team id.
  
  progression - The new progression.
  
  Throws:
  
  SQLException - If an SQL exception occurs.
- getUnredeemed
  
  public List<Map.Entry<AdvancementKey,Boolean>> getUnredeemed(int teamId) throws SQLException
  
  Get the list of the unredeemed advancements of the provided team.
  
  Specified by:
  
  getUnredeemed in interface IDatabase
  
  Parameters:
  
  teamId - The team id.
  
  Returns:
  
  A list of pairs containing the key of the unredeemed advancement and whether to give rewards for it (see IDatabase.setUnredeemed(AdvancementKey, boolean, int)).
  
  Throws:
  
  SQLException - If an SQL exception occurs.
- setUnredeemed
  
  public void setUnredeemed(@NotNull @NotNull AdvancementKey key, boolean giveRewards, int teamId) throws SQLException
  
  Sets the provided advancement unredeemed for the specified team.
  
  Specified by:
  
  setUnredeemed in interface IDatabase
  
  Parameters:
  
  key - The advancement key.
  
  giveRewards - Whether to give rewards on redeem.
  
  teamId - The team id.
  
  Throws:
  
  SQLException - If an SQL exception occurs.
- isUnredeemed
  
  public boolean isUnredeemed(@NotNull @NotNull AdvancementKey key, int teamId) throws SQLException
  
  Returns whether the provided advancement is unredeemed for the specified team.
  
  Specified by:
  
  isUnredeemed in interface IDatabase
  
  Parameters:
  
  key - The advancement key.
  
  teamId - The team id.
  
  Returns:
  
  Whether the provided advancement is unredeemed for the specified team.
  
  Throws:
  
  SQLException - If an SQL exception occurs.
- unsetUnredeemed
  
  public void unsetUnredeemed(@NotNull @NotNull AdvancementKey key, int teamId) throws SQLException
  
  Sets the provided advancement redeemed for the specified team if it is unredeemed.
  
  Specified by:
  
  unsetUnredeemed in interface IDatabase
  
  Parameters:
  
  key - The advancement key.
  
  teamId - The team id.
  
  Throws:
  
  SQLException - If an SQL exception occurs.
- unsetUnredeemed
  
  public void unsetUnredeemed(@NotNull @NotNull List<Map.Entry<AdvancementKey,Boolean>> keyList, int teamId) throws SQLException
  
  Sets the provided advancements redeemed for the specified team.
  
  Specified by:
  
  unsetUnredeemed in interface IDatabase
  
  Parameters:
  
  keyList - The list of advancements to set redeemed.
  
  teamId - The team id.
  
  Throws:
  
  SQLException - If an SQL exception occurs.
- unregisterPlayer
  
  public void unregisterPlayer(@NotNull @NotNull UUID uuid) throws SQLException
  
  Deletes the provided player from the database.
  
  Specified by:
  
  unregisterPlayer in interface IDatabase
  
  Parameters:
  
  uuid - The UUID of the player to be unregistered.
  
  Throws:
  
  SQLException - If an SQL exception occurs.
- movePlayer
  
  public void movePlayer(@NotNull @NotNull UUID uuid, int newTeamId) throws SQLException
  
  Moves the provided player to the specified team.
  
  Specified by:
  
  movePlayer in interface IDatabase
  
  Parameters:
  
  uuid - The UUID of the player to be moved.
  
  newTeamId - The team id.
  
  Throws:
  
  SQLException - If an SQL exception occurs.
- movePlayerInNewTeam
  
  public TeamProgression movePlayerInNewTeam(@NotNull @NotNull UUID uuid) throws SQLException
  
  Moves a player in a new team and returns the TeamProgression of the new team.
  
  Specified by:
  
  movePlayerInNewTeam in interface IDatabase
  
  Parameters:
  
  uuid - The UUID of the player to be moved apart from their team.
  
  Returns:
  
  The TeamProgression of the new team.
  
  Throws:
  
  SQLException - If an SQL exception occurs.
- getPlayersByName
  
  public List<UUID> getPlayersByName(@NotNull @NotNull String name) throws SQLException
  
  Gets a list of the players with the specified name (in the database).
  Since more than one player could have the same name in the database (for example, if the old owner changes name without updating it in the database and another player with that name joins the server), this method could return a list with more than one UUID.
  
  Specified by:
  
  getPlayersByName in interface IDatabase
  
  Parameters:
  
  name - The player name.
  
  Returns:
  
  A list of the UUIDs of the players with the specified name.
  
  Throws:
  
  SQLException - If an SQL exception occurs.
- getPlayerName
  
  public String getPlayerName(@NotNull @NotNull UUID uuid) throws SQLException, UserNotRegisteredException
  
  Gets the stored name for the specified player.
  
  Specified by:
  
  getPlayerName in interface IDatabase
  
  Parameters:
  
  uuid - The player UUID.
  
  Returns:
  
  The stored name.
  
  Throws:
  
  SQLException - If an SQL exception occurs.
  
  UserNotRegisteredException - If the provided player could not be found in the database.
- updatePlayerName
  
  public void updatePlayerName(@NotNull @NotNull UUID uuid, @NotNull @NotNull String name) throws SQLException
  
  Updates the player name in the database.
  
  Specified by:
  
  updatePlayerName in interface IDatabase
  
  Parameters:
  
  uuid - The UUID of the player to be updated.
  
  name - The new player name.
  
  Throws:
  
  SQLException - If an SQL exception occurs.
- clearUpTeams
  
  public void clearUpTeams() throws SQLException
  
  Clears the unused team ids in the database.
  
  Specified by:
  
  clearUpTeams in interface IDatabase
  
  Throws:
  
  SQLException - If an SQL exception occurs.

Class MySQL

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.fren_gor.ultimateAdvancementAPI.database.IDatabase

Constructor Details

MySQL

Method Details

setUp

openConnection

close

getTeamId

getTeamMembers

getTeamAdvancements

loadOrRegisterPlayer

loadUUID

updateAdvancement

getUnredeemed

setUnredeemed

isUnredeemed

unsetUnredeemed

unsetUnredeemed

unregisterPlayer

movePlayer

movePlayerInNewTeam

getPlayersByName

getPlayerName

updatePlayerName

clearUpTeams