Package net.minestom.server.storage

Class StorageManager

java.lang.Object

net.minestom.server.storage.StorageManager

public final class StorageManager
extends java.lang.Object

Manager used to retrieve StorageLocation with getLocation(String, StorageOptions, StorageSystem) and define the default StorageSystem with defineDefaultStorageSystem(Supplier).

Constructor Summary

Constructors

Constructor	Description
StorageManager()

Method Summary

Modifier and Type	Method	Description
void	defineDefaultStorageSystem(java.util.function.Supplier<StorageSystem> storageSystemSupplier)	Defines the default StorageSystem used for StorageLocation.
java.util.Collection<StorageLocation>	getLoadedLocations()	Gets all the StorageLocation which have been loaded by getLocation(String) or getLocation(String, StorageOptions, StorageSystem).
StorageLocation	getLocation(java.lang.String location)	Used to get an access to the specified location.
StorageLocation	getLocation(java.lang.String location, StorageOptions storageOptions)	Used to get an access to the specified location.
StorageLocation	getLocation(java.lang.String location, StorageOptions storageOptions, StorageSystem storageSystem)	Used to get an access to the specified location.
boolean	isDefaultStorageSystemDefined()	Gets if the default StorageSystem is set.
boolean	locationExists(java.lang.String location)	Calls locationExists(String, StorageSystem) with the default StorageSystem.
boolean	locationExists(java.lang.String location, StorageSystem storageSystem)	Used to know if the specified location already exist or not.

Methods inherited from class java.lang.Object

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

Constructor Details

StorageManager

public StorageManager()

Method Details

getLocation

public StorageLocation getLocation(@NotNull java.lang.String location, @NotNull StorageOptions storageOptions, @NotNull StorageSystem storageSystem)

Used to get an access to the specified location. WARNING: a StorageLocation needs to be created with an unique StorageSystem linked you cannot open the save location with two or more different StorageSystem implementation.

Parameters:

location - the location

storageOptions - the StorageOptions

storageSystem - the StorageSystem used in the specified location

Returns:

the specified StorageLocation

getLocation

public StorageLocation getLocation(@NotNull java.lang.String location, @NotNull StorageOptions storageOptions)

Used to get an access to the specified location. The default StorageSystem provider will be used.

Parameters:

location - the location

storageOptions - the StorageOptions

Returns:

the StorageLocation at location with the default StorageSystem

Throws:

java.lang.NullPointerException - if no default StorageSystem is defined with defineDefaultStorageSystem(Supplier)

getLocation

@Nullable public StorageLocation getLocation(@NotNull java.lang.String location)

Used to get an access to the specified location. The default StorageSystem provider will be used.

Parameters:

location - the location

Returns:

the StorageLocation at location with the default StorageSystem

Throws:

java.lang.NullPointerException - if no default StorageSystem is defined defineDefaultStorageSystem(Supplier)

locationExists

public boolean locationExists(@NotNull java.lang.String location, @NotNull StorageSystem storageSystem)

Used to know if the specified location already exist or not.

Parameters:

location - the location

storageSystem - the StorageSystem to use

Returns:

true if the location exists, false otherwise

locationExists

public boolean locationExists(@NotNull java.lang.String location)

Calls locationExists(String, StorageSystem) with the default StorageSystem.

Parameters:

location - the location

Returns:

true if the location exists

getLoadedLocations

@NotNull public java.util.Collection<StorageLocation> getLoadedLocations()

Gets all the StorageLocation which have been loaded by getLocation(String) or getLocation(String, StorageOptions, StorageSystem).

Returns:

an unmodifiable list of all the loaded StorageLocation

defineDefaultStorageSystem

public void defineDefaultStorageSystem(@NotNull java.util.function.Supplier<StorageSystem> storageSystemSupplier)

Defines the default StorageSystem used for StorageLocation.

Parameters:

storageSystemSupplier - the supplier called to get the default StorageSystem

isDefaultStorageSystemDefined

public boolean isDefaultStorageSystemDefined()

Gets if the default StorageSystem is set.

Returns:

true if a default StorageSystem is set