Package com.plotsquared.core.backup

Class PlayerBackupProfile

java.lang.Object

com.plotsquared.core.backup.PlayerBackupProfile

All Implemented Interfaces:

BackupProfile

public class PlayerBackupProfile
extends Object
implements BackupProfile

A profile associated with a player (normally a plot owner) and a plot, which is used to store and retrieve plot backups

Constructor Summary

Constructors

Constructor	Description
PlayerBackupProfile(@NonNull UUID owner, @NonNull Plot plot, @NonNull BackupManager backupManager, @NonNull SchematicHandler schematicHandler)

Method Summary

Modifier and Type	Method	Description
@NonNull CompletableFuture<Backup>	createBackup()	Create a backup of the plot.
void	destroy()	Remove all backups stored for this profile
@NonNull Path	getBackupDirectory()	Get the directory containing the backups for this profile.
@NonNull CompletableFuture<List<Backup>>	listBackups()	Asynchronously populate a list of available backups under this profile
@NonNull CompletableFuture<Void>	restoreBackup(@NonNull Backup backup, @Nullable PlotPlayer<?> player)	Restore a backup

Methods inherited from class java.lang.Object

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

Constructor Details

PlayerBackupProfile

@Inject
public PlayerBackupProfile(@NonNull UUID owner,
 @NonNull Plot plot,
 @NonNull BackupManager backupManager,
 @NonNull SchematicHandler schematicHandler)

Method Details

listBackups

public @NonNull CompletableFuture<List<Backup>> listBackups()

Description copied from interface: BackupProfile

Asynchronously populate a list of available backups under this profile

Specified by:

listBackups in interface BackupProfile

Returns:

Future that will be completed with available backups

destroy

public void destroy()

Description copied from interface: BackupProfile

Remove all backups stored for this profile

Specified by:

destroy in interface BackupProfile

getBackupDirectory

public @NonNull Path getBackupDirectory()

Description copied from interface: BackupProfile

Get the directory containing the backups for this profile. This directory may not actually exist.

Specified by:

getBackupDirectory in interface BackupProfile

Returns:

Folder that contains the backups for this profile

createBackup

public @NonNull CompletableFuture<Backup> createBackup()

Description copied from interface: BackupProfile

Create a backup of the plot. If the profile is at the maximum backup capacity, the oldest backup will be deleted.

Specified by:

createBackup in interface BackupProfile

Returns:

Future that completes with the created backup.

restoreBackup

public @NonNull CompletableFuture<Void> restoreBackup(@NonNull Backup backup,
 @Nullable PlotPlayer<?> player)

Description copied from interface: BackupProfile

Restore a backup

Specified by:

restoreBackup in interface BackupProfile

Parameters:

backup - Backup to restore

player - The player restoring the backup

Returns:

Future that completes when the backup has finished