org.pepsoft.worldpainter.util

Class BackupUtils

java.lang.Object

org.pepsoft.worldpainter.util.BackupUtils

public final class BackupUtils
extends java.lang.Object

Utility class for creating and managing backups. Created by pepijn on 27-4-15.

Method Summary

Modifier and Type	Method and Description
static boolean	cleanUpBackups(java.io.File exportDir, java.awt.Window parent) Deletes backups, oldest first, until there is at least Configuration.minimumFreeSpaceForMaps GB free, and only if enabled and/or the user gives permission.
static java.io.File	getBackupFile(java.io.File file, int backup) Create a backup file by appending a number to the name part of the filename.

Methods inherited from class java.lang.Object

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

Method Detail

getBackupFile

public static java.io.File getBackupFile(java.io.File file,
                                         int backup)

Create a backup file by appending a number to the name part of the filename.

Parameters:

file - The file for which to create a backup file.

backup - The backup number to append.

Returns:

The file to use for backing up the specified file.

cleanUpBackups

public static boolean cleanUpBackups(java.io.File exportDir,
                                     java.awt.Window parent)
                              throws java.io.IOException

Deletes backups, oldest first, until there is at least Configuration.minimumFreeSpaceForMaps GB free, and only if enabled and/or the user gives permission. Because of that, even if this method returns true it is not guaranteed that there is at least minimumFreeSpaceForMaps GB free.

If an exportDir is specified, this is assumed to be an automatic cleanup. Only the file store on which the worldDir is located will be cleaned, and dialogs will only be shown to the user if a cleanup was actually necessary.

If an {code exportDir} is not specified, this is assumed to be a manual request. The method will try to find all backup directories on all file stores and clean them if necessary, and will always give feedback to the user through dialogs, even if nothing was done.

Parameters:

exportDir - The directory to which the world is being exported. May be null.

parent - The parent window for notifications. May be null.

Returns:

false if the user indicated the operation should be cancelled, true otherwise.

Throws:

java.io.IOException