Class DatabaseManager

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.api.restartable.Restartable

nl.pim16aap2.animatedarchitecture.core.managers.DatabaseManager

All Implemented Interfaces:

IDebuggable, IRestartable

@Singleton
public final class DatabaseManager
extends Restartable
implements IDebuggable

Manages all database interactions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DatabaseManager.ActionResult	Represents the result of an action requested from the database.
static final class	DatabaseManager.FriendKey
static final record	DatabaseManager.StructureIdentifier	Represents the identifier of a structure.
static final record	DatabaseManager.StructureInsertResult	Contains the result of an attempt to insert a structure into the database.

Constructor Summary

Constructors

Constructor	Description
DatabaseManager(IExecutor executor, RestartableHolder restartableHolder, IStorage storage, StructureDeletionManager structureDeletionManager, dagger.Lazy<PowerBlockManager> powerBlockManager, IAnimatedArchitectureEventFactory animatedArchitectureEventFactory, IAnimatedArchitectureEventCaller animatedArchitectureEventCaller, DebuggableRegistry debuggableRegistry)	Constructs a new DatabaseManager.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<DatabaseManager.ActionResult>	addOwner(Structure structure, IPlayer player, PermissionLevel permission)	Adds a player as owner to a Structure at a given level of ownership and assumes that the structure was NOT deleted by an IPlayer.
CompletableFuture<DatabaseManager.ActionResult>	addOwner(Structure structure, IPlayer player, PermissionLevel permission, @Nullable IPlayer responsible)	Adds a player as owner to a Structure at a given level of ownership.
CompletableFuture<DatabaseManager.StructureInsertResult>	addStructure(Structure structure)	Inserts a Structure into the database and assumes that the structure was NOT created by an IPlayer.
CompletableFuture<DatabaseManager.StructureInsertResult>	addStructure(Structure structure, @Nullable IPlayer responsible)	Inserts a Structure into the database.
CompletableFuture<Integer>	countStructuresByName(String structureName)	The number of Structures in the database with a specific name.
CompletableFuture<Integer>	countStructuresOwnedByPlayer(UUID playerUUID)	Gets the number of Structures owned by a player.
CompletableFuture<Integer>	countStructuresOwnedByPlayer(UUID playerUUID, String structureName)	Counts the number of Structures with a specific name owned by a player.
CompletableFuture<DatabaseManager.ActionResult>	deleteStructure(Structure structure)	Removes a Structure from the database and assumes that the structure was NOT deleted by an IPlayer.
CompletableFuture<DatabaseManager.ActionResult>	deleteStructure(Structure structure, @Nullable IPlayer responsible)	Removes a Structure from the database.
IStorage.DatabaseState	getDatabaseState()	Obtains IStorage.DatabaseState the database is in.
String	getDebugInformation()	Gets the debug information for this object.
CompletableFuture<List<DatabaseManager.StructureIdentifier>>	getIdentifiersFromPartial(String input, @Nullable IPlayer player, PermissionLevel maxPermission, Collection<Property<?>> properties)	Retrieves all DatabaseManager.StructureIdentifiers that start with the provided input.
CompletableFuture<List<PlayerData>>	getPlayerData(String playerName)	Tries to get all the players with a given name.
CompletableFuture<Optional<PlayerData>>	getPlayerData(UUID uuid)	Tries to find the PlayerData for a player with the given UUID.
CompletableFuture<Optional<Structure>>	getStructure(long structureUID)	Gets the Structure with a specific UID.
CompletableFuture<Optional<Structure>>	getStructure(UUID uuid, long structureUID)	Gets the Structure with the given UID owned by the player.
CompletableFuture<Optional<Structure>>	getStructure(IPlayer player, long structureUID)	Gets the Structure with the given UID owned by the player.
CompletableFuture<List<Structure>>	getStructures(String name)	Gets all Structures with a specific name, regardless over ownership.
CompletableFuture<List<Structure>>	getStructures(UUID playerUUID)	Gets all Structure owned by a player.
CompletableFuture<List<Structure>>	getStructures(UUID playerUUID, String structureID)	Gets all Structure owned by a player.
CompletableFuture<List<Structure>>	getStructures(IPlayer player)	See getStructures(UUID).
CompletableFuture<List<Structure>>	getStructures(IPlayer player, String name)	See getStructures(UUID, String).
CompletableFuture<List<Structure>>	getStructures(IPlayer player, String name, PermissionLevel maxPermission)	Gets all Structure owned by a player with a specific name.
CompletableFuture<List<Structure>>	getStructuresInChunk(int chunkX, int chunkZ)	Gets a list of structure UIDs that have their rotation point in a given chunk.
CompletableFuture<List<Structure>>	getStructuresOfType(String typeName)	Obtains all structures of a given type.
CompletableFuture<List<Structure>>	getStructuresOfType(String typeName, int version)	Obtains all structures of a specific version of a given type.
void	initialize()	Handles the initialization.
CompletableFuture<DatabaseManager.ActionResult>	removeOwner(Structure structure, UUID playerUUID)	Remove a IPlayer as owner of a Structure and assumes that the structure was NOT deleted by an IPlayer.
CompletableFuture<DatabaseManager.ActionResult>	removeOwner(Structure structure, UUID playerUUID, @Nullable IPlayer responsible)	Remove a IPlayer as owner of a Structure.
CompletableFuture<DatabaseManager.ActionResult>	removeOwner(Structure structure, IPlayer player)	Remove a IPlayer as owner of a Structure.
CompletableFuture<DatabaseManager.ActionResult>	removeOwner(Structure structure, IPlayer player, @Nullable IPlayer responsible)	Remove a IPlayer as owner of a Structure.
void	shutDown()	Handles a shutdown.
CompletableFuture<DatabaseManager.ActionResult>	syncStructureData(StructureSnapshot snapshot)	Updates the all data of an Structure.
CompletableFuture<Boolean>	updatePlayer(IPlayer player)	Updates the name of a player in the database, to make sure the player's name and UUID don't go out of sync.

Methods inherited from class Object

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

Constructor Details

DatabaseManager

@Inject
public DatabaseManager(IExecutor executor,
 RestartableHolder restartableHolder,
 IStorage storage,
 StructureDeletionManager structureDeletionManager,
 dagger.Lazy<PowerBlockManager> powerBlockManager,
 IAnimatedArchitectureEventFactory animatedArchitectureEventFactory,
 IAnimatedArchitectureEventCaller animatedArchitectureEventCaller,
 DebuggableRegistry debuggableRegistry)

Constructs a new DatabaseManager.

Parameters:

restartableHolder - The object managing restarts for this object.

storage - The IStorage to use for all database calls.

Method Details

getDatabaseState

public IStorage.DatabaseState getDatabaseState()

Obtains IStorage.DatabaseState the database is in.

Returns:

The IStorage.DatabaseState the database is in.

initialize

public void initialize()

Description copied from interface: IRestartable

Handles the initialization.

Specified by:

initialize in interface IRestartable

shutDown

public void shutDown()

Description copied from interface: IRestartable

Handles a shutdown.

Specified by:

shutDown in interface IRestartable

addStructure

public CompletableFuture<DatabaseManager.StructureInsertResult> addStructure(Structure structure)

Inserts a Structure into the database and assumes that the structure was NOT created by an IPlayer. See addStructure(Structure, IPlayer).

Parameters:

structure - The new Structure.

Returns:

The future result of the operation. If the operation was successful this will be true.

addStructure

public CompletableFuture<DatabaseManager.StructureInsertResult> addStructure(Structure structure,
 @Nullable IPlayer responsible)

Inserts a Structure into the database.

Parameters:

structure - The new Structure.

responsible - The IPlayer responsible for creating the structure. This is used for the IStructurePrepareCreateEvent and the IStructureCreatedEvent. This may be null.

Returns:

The future result of the operation.

deleteStructure

public CompletableFuture<DatabaseManager.ActionResult> deleteStructure(Structure structure)

Removes a Structure from the database and assumes that the structure was NOT deleted by an IPlayer. See deleteStructure(Structure, IPlayer).

Parameters:

structure - The structure that will be deleted.

Returns:

The future result of the operation.

deleteStructure

public CompletableFuture<DatabaseManager.ActionResult> deleteStructure(Structure structure,
 @Nullable IPlayer responsible)

Removes a Structure from the database.

Parameters:

structure - The structure that will be deleted.

responsible - The IPlayer responsible for creating the structure. This is used for the IStructurePrepareDeleteEvent. This may be null.

Returns:

The future result of the operation.

getStructuresInChunk

public CompletableFuture<List<Structure>> getStructuresInChunk(int chunkX,
 int chunkZ)

Gets a list of structure UIDs that have their rotation point in a given chunk.

Parameters:

chunkX - The x-coordinate of the chunk (in chunk space).

chunkZ - The z-coordinate of the chunk (in chunk space).

Returns:

A list of structure UIDs that have their rotation point in a given chunk.

getStructuresOfType

public CompletableFuture<List<Structure>> getStructuresOfType(String typeName)

Obtains all structures of a given type.

Parameters:

typeName - The name of the type. See StructureType.getKey().

Returns:

All structures of the given type.

getStructuresOfType

public CompletableFuture<List<Structure>> getStructuresOfType(String typeName,
 int version)

Obtains all structures of a specific version of a given type.

Parameters:

typeName - The name of the type. See StructureType.getKey().

version - The version of the type.

Returns:

All structures of the given type and version.

getStructures

public CompletableFuture<List<Structure>> getStructures(UUID playerUUID,
 String structureID)

Gets all Structure owned by a player. Only searches for Structure with a given name if one was provided.

Parameters:

playerUUID - The UUID of the payer.

structureID - The name or the UID of the Structure to search for. Can be null.

Returns:

All Structure owned by a player with a specific name.

getStructures

public CompletableFuture<List<Structure>> getStructures(IPlayer player,
 String name)

See getStructures(UUID, String).

getStructures

public CompletableFuture<List<Structure>> getStructures(UUID playerUUID)

Gets all Structure owned by a player.

Parameters:

playerUUID - The UUID of the player.

Returns:

All Structure owned by a player.

getStructures

public CompletableFuture<List<Structure>> getStructures(IPlayer player)

See getStructures(UUID).

getStructures

public CompletableFuture<List<Structure>> getStructures(IPlayer player,
 String name,
 PermissionLevel maxPermission)

Gets all Structure owned by a player with a specific name.

Parameters:

player - The player whose structures to retrieve.

name - The name of the Structure to search for.

maxPermission - The maximum level of ownership (inclusive) this player has over the Structures.

Returns:

All Structure owned by a player with a specific name.

getStructures

public CompletableFuture<List<Structure>> getStructures(String name)

Gets all Structures with a specific name, regardless over ownership.

Parameters:

name - The name of the Structures.

Returns:

All Structures with a specific name.

updatePlayer

public CompletableFuture<Boolean> updatePlayer(IPlayer player)

Updates the name of a player in the database, to make sure the player's name and UUID don't go out of sync.

Parameters:

player - The Player.

Returns:

The future result of the operation. If the operation was successful this will be true.

getPlayerData

public CompletableFuture<Optional<PlayerData>> getPlayerData(UUID uuid)

Tries to find the PlayerData for a player with the given UUID.

Parameters:

uuid - The UUID of a player.

Returns:

The PlayerData that represents the player.

getPlayerData

public CompletableFuture<List<PlayerData>> getPlayerData(String playerName)

Tries to get all the players with a given name. Because names are not unique, this may result in any number of matches.

If you know the player's UUID, it is recommended to use getPlayerData(UUID) instead.

Parameters:

playerName - The name of the player(s).

Returns:

All the players with the given name.

getStructure

public CompletableFuture<Optional<Structure>> getStructure(long structureUID)

Gets the Structure with a specific UID.

Parameters:

structureUID - The UID of the Structure.

Returns:

The Structure if it exists.

getStructure

public CompletableFuture<Optional<Structure>> getStructure(IPlayer player,
 long structureUID)

Gets the Structure with the given UID owned by the player. If the given player does not own the provided structure, no structure will be returned.

Parameters:

player - The IPlayer.

structureUID - The UID of the Structure.

Returns:

The Structure with the given UID if it exists and the provided player owns it.

getStructure

public CompletableFuture<Optional<Structure>> getStructure(UUID uuid,
 long structureUID)

Gets the Structure with the given UID owned by the player. If the given player does not own the * provided structure, no structure will be returned.

Parameters:

uuid - The UUID of the player.

structureUID - The UID of the Structure.

Returns:

The Structure with the given UID if it exists and the provided player owns it.

countStructuresOwnedByPlayer

public CompletableFuture<Integer> countStructuresOwnedByPlayer(UUID playerUUID)

Gets the number of Structures owned by a player.

Parameters:

playerUUID - The UUID of the player.

Returns:

The number of Structures this player owns.

countStructuresOwnedByPlayer

public CompletableFuture<Integer> countStructuresOwnedByPlayer(UUID playerUUID,
 String structureName)

Counts the number of Structures with a specific name owned by a player.

Parameters:

playerUUID - The UUID of the player.

structureName - The name of the structure.

Returns:

The number of Structures with a specific name owned by a player.

countStructuresByName

public CompletableFuture<Integer> countStructuresByName(String structureName)

The number of Structures in the database with a specific name.

Parameters:

structureName - The name of the Structure.

Returns:

The number of Structures with a specific name.

addOwner

public CompletableFuture<DatabaseManager.ActionResult> addOwner(Structure structure,
 IPlayer player,
 PermissionLevel permission)

Adds a player as owner to a Structure at a given level of ownership and assumes that the structure was NOT deleted by an IPlayer. See addOwner(Structure, IPlayer, PermissionLevel, IPlayer).

Parameters:

structure - The Structure.

player - The IPlayer.

permission - The level of ownership.

Returns:

The future result of the operation.

addOwner

public CompletableFuture<DatabaseManager.ActionResult> addOwner(Structure structure,
 IPlayer player,
 PermissionLevel permission,
 @Nullable IPlayer responsible)

Adds a player as owner to a Structure at a given level of ownership.

Parameters:

structure - The Structure.

player - The IPlayer.

permission - The level of ownership.

Returns:

The future result of the operation.

removeOwner

public CompletableFuture<DatabaseManager.ActionResult> removeOwner(Structure structure,
 IPlayer player)

Remove a IPlayer as owner of a Structure.

Parameters:

structure - The Structure.

player - The IPlayer.

Returns:

True if owner removal was successful.

removeOwner

public CompletableFuture<DatabaseManager.ActionResult> removeOwner(Structure structure,
 IPlayer player,
 @Nullable IPlayer responsible)

Remove a IPlayer as owner of a Structure.

Parameters:

structure - The Structure.

player - The IPlayer.

responsible - The IPlayer responsible for creating the structure. This is used for the IStructurePrepareDeleteEvent. This may be null.

Returns:

The future result of the operation.

removeOwner

public CompletableFuture<DatabaseManager.ActionResult> removeOwner(Structure structure,
 UUID playerUUID)

Remove a IPlayer as owner of a Structure and assumes that the structure was NOT deleted by an IPlayer. See removeOwner(Structure, UUID, IPlayer).

Parameters:

structure - The Structure.

playerUUID - The UUID of the IPlayer.

Returns:

The future result of the operation.

removeOwner

public CompletableFuture<DatabaseManager.ActionResult> removeOwner(Structure structure,
 UUID playerUUID,
 @Nullable IPlayer responsible)

Remove a IPlayer as owner of a Structure.

Parameters:

structure - The Structure.

playerUUID - The UUID of the IPlayer.

responsible - The IPlayer responsible for creating the structure. This is used for the IStructurePrepareDeleteEvent. This may be null.

Returns:

The future result of the operation.

syncStructureData

public CompletableFuture<DatabaseManager.ActionResult> syncStructureData(StructureSnapshot snapshot)

Updates the all data of an Structure. This includes both the base data and the type-specific data.

Parameters:

snapshot - The Structure that describes the base data of structure.

Returns:

The result of the operation.

getIdentifiersFromPartial

public CompletableFuture<List<DatabaseManager.StructureIdentifier>> getIdentifiersFromPartial(String input,
 @Nullable IPlayer player,
 PermissionLevel maxPermission,
 Collection<Property<?>> properties)

Retrieves all DatabaseManager.StructureIdentifiers that start with the provided input.

For example, this method can retrieve the identifiers "1", "10", "11", "100", etc from an input of "1" or "MyDoor", "MyPortcullis", "MyOtherStructure", etc. from an input of "My".

Parameters:

input - The partial identifier to look for.

player - The player that should own the structures. May be null to disregard ownership.

properties - The properties that the structures must have. When specified, only structures that have all of these properties will be returned.

Returns:

All DatabaseManager.StructureIdentifiers that start with the provided input.

getDebugInformation

public String getDebugInformation()

Description copied from interface: IDebuggable

Gets the debug information for this object.

Specified by:

getDebugInformation in interface IDebuggable

Returns:

The debug information or null if there's nothing to log at this time.