backups

Class BareBackups

java.lang.Object

backups.BareBackups

All Implemented Interfaces:

java.io.Serializable

public class BareBackups
extends java.lang.Object
implements java.io.Serializable

This class provides backup functionality (compressing, auto backup, etc.). It also manages underlying functionality of the GUI element.

Version:

1.0

Author:

Jonathan Droogh (aka RJ)

See Also:

TODO Implement auto backup. TODO Add boot at OS start. TODO Add About window (containing author, website, license, etc.). TODO Add progress bar running on seperate task., Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private int	autoBackupCopies
private int	autoBackupID
private int	autoBackupInterval
private java.lang.String	autoBackupIntervalTime
private FXMLController	controller
private java.lang.String	inputDirectory
private java.util.ArrayList<java.lang.String>	inputFiles
private java.lang.String	outputDirectory
private double	progressComplete
private java.lang.String	saveName
private static long	serialVersionUID
private boolean	shouldAutoBackup
private boolean	shouldForceUnchangedBackups

Constructor Summary

Constructors

Constructor and Description
BareBackups()
BareBackups(FXMLController controller) Initial constructor.

Method Summary

Modifier and Type	Method and Description
void	addInputFile(java.lang.String backupFile) Adds a path+file to the 'backupFile' ArrayList.
java.lang.Boolean	addInputFiles(java.io.File directory) Adds all files/folders under 'directory' to the 'inputFiles' ArrayList.
void	addLog(java.lang.String message) Adds a message to the GUI's console and system's console (if running in command line).
int	getAutoBackupID()
double	getAutoBackupInterval() Gets the save interval in seconds.
java.lang.String	getAutoBackupIntervalTime()
FXMLController	getController() Gets the controller to interact with the GUI.
java.lang.String	getInputDirectory() Gets the input directory to be backed up.
java.util.ArrayList<java.lang.String>	getInputFiles() Gets a list of files in the input directory.
java.lang.String	getOutputDirectory() Gets the output directory on where to save the backup file.
java.lang.String	getSaveName() Gets the save name of the backup.
boolean	getShouldAutoBackup()
boolean	isReadyToZip(boolean shouldLog) Various checks to make sure essential values aren't empty.
private void	readObject(java.io.ObjectInputStream in) Reloads serialized elements to their according fields.
void	resetInputFiles() Clears the ArrayList containing which files to backup so unnecessary files aren't backed up.
void	saveBackup() Adds selected input folder (and its files) to a backup file saved to the selected output directory.
void	setAutoBackupCopies(int backupCopies)
void	setAutoBackupID(int ID)
void	setAutoBackupInterval(int interval) Sets the auto save interval.
void	setAutoBackupIntervalTime(java.lang.String autoBackupIntervalTime)
void	setController(FXMLController controller) Sets the controller.
void	setInputDirectory(java.lang.String directory) Sets the input directory.
void	setInputFiles(java.util.ArrayList<java.lang.String> inputFiles) Sets the input files.
void	setOutputDirectory(java.lang.String directory) Sets the output directory.
void	setSaveName(java.lang.String name) Sets the save name
void	setShouldAutoBackup(boolean shouldAuotBackup)
void	setShouldForceUnchangedBackups(boolean shouldForceUnchangedBackups)
private void	writeObject(java.io.ObjectOutputStream out) Serializes select elements so irrelevant ones aren't serialized.

Methods inherited from class java.lang.Object

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

Field Detail

inputFiles

private java.util.ArrayList<java.lang.String> inputFiles

shouldForceUnchangedBackups

private boolean shouldForceUnchangedBackups

shouldAutoBackup

private boolean shouldAutoBackup

progressComplete

private double progressComplete

controller

private FXMLController controller

autoBackupCopies

private int autoBackupCopies

autoBackupID

private int autoBackupID

autoBackupInterval

private int autoBackupInterval

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

autoBackupIntervalTime

private java.lang.String autoBackupIntervalTime

inputDirectory

private java.lang.String inputDirectory

outputDirectory

private java.lang.String outputDirectory

saveName

private java.lang.String saveName

Constructor Detail

BareBackups

public BareBackups()

BareBackups

public BareBackups(FXMLController controller)

Initial constructor. Sets up values so they aren't null and assigns the controller.

Parameters:

controller - The object used for interacting with the GUI elements.

Method Detail

addInputFiles

public java.lang.Boolean addInputFiles(java.io.File directory)

Adds all files/folders under 'directory' to the 'inputFiles' ArrayList.

Parameters:

directory - The directory to find files to be added.

Returns:

Whether the operation of adding files failed or not.

addInputFile

public void addInputFile(java.lang.String backupFile)

Adds a path+file to the 'backupFile' ArrayList.

Parameters:

backupFile - The path+file added to the ArrayList (the file that will be backed up).

addLog

public void addLog(java.lang.String message)

Adds a message to the GUI's console and system's console (if running in command line).

Parameters:

message - What will be printed to the console.

isReadyToZip

public boolean isReadyToZip(boolean shouldLog)

Various checks to make sure essential values aren't empty.

Parameters:

shouldLog - Whether a log should be made if a check doesn't pass.

Returns:

True if there's enough information to attempt a backup, false otherwise.

readObject

private void readObject(java.io.ObjectInputStream in)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

Reloads serialized elements to their according fields.

Parameters:

in -

Throws:

java.io.IOException

java.lang.ClassNotFoundException

resetInputFiles

public void resetInputFiles()

Clears the ArrayList containing which files to backup so unnecessary files aren't backed up.

saveBackup

public void saveBackup()

Adds selected input folder (and its files) to a backup file saved to the selected output directory.

writeObject

private void writeObject(java.io.ObjectOutputStream out)
                  throws java.io.IOException

Serializes select elements so irrelevant ones aren't serialized.

Parameters:

out -

Throws:

java.io.IOException

getAutoBackupID

public int getAutoBackupID()

getAutoBackupInterval

public double getAutoBackupInterval()

Gets the save interval in seconds.

Returns:

Integer containing how often an auto save should be run in seconds.

getAutoBackupIntervalTime

public java.lang.String getAutoBackupIntervalTime()

getController

public FXMLController getController()

Gets the controller to interact with the GUI.

Returns:

Controller object stored in BareBackups.

getInputDirectory

public java.lang.String getInputDirectory()

Gets the input directory to be backed up.

Returns:

The directory that's to be backed up.

getInputFiles

public java.util.ArrayList<java.lang.String> getInputFiles()

Gets a list of files in the input directory.

Returns:

List of files to be backed up.

getOutputDirectory

public java.lang.String getOutputDirectory()

Gets the output directory on where to save the backup file.

Returns:

Directory to where the backup file is saved.

getSaveName

public java.lang.String getSaveName()

Gets the save name of the backup.

Returns:

The name the backup file will be saved as.

getShouldAutoBackup

public boolean getShouldAutoBackup()

setAutoBackupCopies

public void setAutoBackupCopies(int backupCopies)

setAutoBackupID

public void setAutoBackupID(int ID)

setAutoBackupInterval

public void setAutoBackupInterval(int interval)

Sets the auto save interval.

Parameters:

interval - What to set the save interval to.

setAutoBackupIntervalTime

public void setAutoBackupIntervalTime(java.lang.String autoBackupIntervalTime)

setController

public void setController(FXMLController controller)

Sets the controller.

Parameters:

controller - What the controller is set to.

setShouldForceUnchangedBackups

public void setShouldForceUnchangedBackups(boolean shouldForceUnchangedBackups)

setInputDirectory

public void setInputDirectory(java.lang.String directory)

Sets the input directory.

Parameters:

directory - What the input directory is set to.

setInputFiles

public void setInputFiles(java.util.ArrayList<java.lang.String> inputFiles)

Sets the input files.

Parameters:

inputFiles - What to set the input files list to.

setOutputDirectory

public void setOutputDirectory(java.lang.String directory)

Sets the output directory.

Parameters:

directory - What to set the output directory to.

setSaveName

public void setSaveName(java.lang.String name)

Sets the save name

Parameters:

name - What to set the save name to.

setShouldAutoBackup

public void setShouldAutoBackup(boolean shouldAuotBackup)