com.plotsquared.core.backup.BackupProfile Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of PlotSquared-Core Show documentation

PlotSquared, a land and world management plugin for Minecraft.

There is a newer version: 6.11.2

/*
 *       _____  _       _    _____                                _
 *      |  __ \| |     | |  / ____|                              | |
 *      | |__) | | ___ | |_| (___   __ _ _   _  __ _ _ __ ___  __| |
 *      |  ___/| |/ _ \| __|\___ \ / _` | | | |/ _` | '__/ _ \/ _` |
 *      | |    | | (_) | |_ ____) | (_| | |_| | (_| | | |  __/ (_| |
 *      |_|    |_|\___/ \__|_____/ \__, |\__,_|\__,_|_|  \___|\__,_|
 *                                    | |
 *                                    |_|
 *            PlotSquared plot management system for Minecraft
 *               Copyright (C) 2014 - 2022 IntellectualSites
 *
 *     This program is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 *
 *     This program is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU General Public License for more details.
 *
 *     You should have received a copy of the GNU General Public License
 *     along with this program.  If not, see .
 */
package com.plotsquared.core.backup;

import com.plotsquared.core.player.PlotPlayer;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;

import java.nio.file.Path;
import java.util.List;
import java.util.concurrent.CompletableFuture;

public interface BackupProfile {

    /**
     * Asynchronously populate a list of available backups under this profile
     *
     * @return Future that will be completed with available backups
     */
    @NonNull CompletableFuture> listBackups();

    /**
     * Remove all backups stored for this profile
     */
    void destroy();

    /**
     * Get the directory containing the backups for this profile.
     * This directory may not actually exist.
     *
     * @return Folder that contains the backups for this profile
     */
    @NonNull Path getBackupDirectory();

    /**
     * Create a backup of the plot. If the profile is at the
     * maximum backup capacity, the oldest backup will be deleted.
     *
     * @return Future that completes with the created backup.
     */
    @NonNull CompletableFuture createBackup();

    /**
     * Restore a backup
     *
     * @param backup Backup to restore
     * @param player The player restoring the backup
     * @return Future that completes when the backup has finished
     */
    @NonNull CompletableFuture restoreBackup(final @NonNull Backup backup, @Nullable PlotPlayer player);

}