Package wtf.choco.veinminer.data

Class PersistentDataStorageJSON

java.lang.Object

wtf.choco.veinminer.data.PersistentDataStorageJSON

All Implemented Interfaces:

PersistentDataStorage

public final class PersistentDataStorageJSON
extends Object
implements PersistentDataStorage

An implementation of PersistentDataStorage for JSON files in a directory.

Nested Class Summary

Nested classes/interfaces inherited from interface wtf.choco.veinminer.data.PersistentDataStorage

PersistentDataStorage.Type

Constructor Summary

Constructors

Constructor	Description
PersistentDataStorageJSON(@NotNull VeinMinerServer veinMiner, @NotNull File directory)	Construct a new PersistentDataStorageJSON.

Method Summary

Modifier and Type	Method	Description
@NotNull PersistentDataStorage.Type	getType()	Get the PersistentDataStorage.Type of persistent storage.
@NotNull CompletableFuture<Void>	init()	Initialize this persistent storage.
@NotNull CompletableFuture<List<VeinMinerPlayer>>	load(@NotNull Collection<? extends VeinMinerPlayer> players)	Load the data of the given list of VeinMinerPlayers from disk.
@NotNull CompletableFuture<VeinMinerPlayer>	load(@NotNull VeinMinerPlayer player)	Load the data of the given VeinMinerPlayer from disk.
@NotNull CompletableFuture<List<VeinMinerPlayer>>	save(@NotNull Collection<? extends VeinMinerPlayer> players)	Save the data of the given list of VeinMinerPlayers to disk.
@NotNull CompletableFuture<VeinMinerPlayer>	save(@NotNull VeinMinerPlayer player)	Save the data of the given VeinMinerPlayer to disk.

Methods inherited from class java.lang.Object

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

Constructor Details

PersistentDataStorageJSON

public PersistentDataStorageJSON(@NotNull
 @NotNull VeinMinerServer veinMiner,
 @NotNull
 @NotNull File directory)

Construct a new PersistentDataStorageJSON.

Parameters:

veinMiner - the vein miner server instance

directory - the directory where all JSON files are held

Method Details

getType

@NotNull
public @NotNull PersistentDataStorage.Type getType()

Description copied from interface: PersistentDataStorage

Get the PersistentDataStorage.Type of persistent storage.

Specified by:

getType in interface PersistentDataStorage

Returns:

the type

init

@NotNull
public @NotNull CompletableFuture<Void> init()

Description copied from interface: PersistentDataStorage

Initialize this persistent storage.

Specified by:

init in interface PersistentDataStorage

Returns:

a CompletableFuture completed when the initialization has finished

save

@NotNull
public @NotNull CompletableFuture<VeinMinerPlayer> save(@NotNull
 @NotNull VeinMinerPlayer player)

Description copied from interface: PersistentDataStorage

Save the data of the given VeinMinerPlayer to disk.

If the VeinMinerPlayer is not dirty (according to VeinMinerPlayer.isDirty()), this method will complete immediately and not perform a save.

Specified by:

save in interface PersistentDataStorage

Parameters:

player - the player to save

Returns:

a CompletableFuture completed when saving has finished

save

@NotNull
public @NotNull CompletableFuture<List<VeinMinerPlayer>> save(@NotNull
 @NotNull Collection<? extends VeinMinerPlayer> players)

Description copied from interface: PersistentDataStorage

Save the data of the given list of VeinMinerPlayers to disk.

Specified by:

save in interface PersistentDataStorage

Parameters:

players - the players to save

Returns:

a CompletableFuture completed when saving has finished

load

@NotNull
public @NotNull CompletableFuture<VeinMinerPlayer> load(@NotNull
 @NotNull VeinMinerPlayer player)

Description copied from interface: PersistentDataStorage

Load the data of the given VeinMinerPlayer from disk.

Specified by:

load in interface PersistentDataStorage

Parameters:

player - the player whose data to load

Returns:

a CompletableFuture completed when loading has finished

load

@NotNull
public @NotNull CompletableFuture<List<VeinMinerPlayer>> load(@NotNull
 @NotNull Collection<? extends VeinMinerPlayer> players)

Description copied from interface: PersistentDataStorage

Load the data of the given list of VeinMinerPlayers from disk.

Specified by:

load in interface PersistentDataStorage

Parameters:

players - the players whose data to load

Returns:

a CompletableFuture completed when loading has finished