org.eclipse.equinox.internal.p2.touchpoint.natives

Class LazyBackupStore

java.lang.Object

org.eclipse.equinox.internal.p2.touchpoint.natives.LazyBackupStore

All Implemented Interfaces:

IBackupStore

public class LazyBackupStore
extends java.lang.Object
implements IBackupStore

LazyBackupStore is a BackupStore that only instantiates a real backup store when needed.

Constructor Summary

Constructors

Constructor and Description
LazyBackupStore(java.lang.String prefix) Creates a new lazy backup store

Method Summary

Modifier and Type	Method and Description
boolean	backup(java.io.File file) Backup the file.
void	backupAll(java.io.File file) Backs up a file, or everything under a directory.
boolean	backupCopy(java.io.File file) Same as IBackupStore.backup(File) except that a copy is kept in the original location.
void	backupCopyAll(java.io.File file) Backs up a file, or everything under a directory.
boolean	backupDirectory(java.io.File file) Performs backup of an empty directory.
void	discard() Discards and closes this BackupStore.
java.lang.String	getBackupName() Returns the unique backup name (this is the name of generated backup directories).
void	restore() Restores all backup files from backup store.

Methods inherited from class java.lang.Object

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

Constructor Detail

LazyBackupStore

public LazyBackupStore(java.lang.String prefix)

Creates a new lazy backup store

Parameters:

prefix - The prefix to use in constructing the backup store directory

Method Detail

backup

public boolean backup(java.io.File file)
               throws java.io.IOException

Description copied from interface: IBackupStore

Backup the file. Calling this method with a file that represents a directory is equivalent to calling IBackupStore.backupDirectory(File). A file (path) can only be backed up once per IBackupStore instance. If a directory is first backed up, and later replaced by a regular file, and this file is also backed up (or vice versa) - an IllegalArgumentException is thrown A backup can not be performed on a closed IBackupStore.

Specified by:

backup in interface IBackupStore

Parameters:

file - - the file (or directory) to backup

Returns:

true if the file was backed up, false if this file (path) has already been backed up (the file is not moved to the store).

Throws:

java.io.IOException - - if the backup operation fails, or the file does not exist

backupDirectory

public boolean backupDirectory(java.io.File file)
                        throws java.io.IOException

Description copied from interface: IBackupStore

Performs backup of an empty directory. The directory must be empty before it can be backed up (i.e. similar to a delete of a directory). Backup the files of the directory first. A call to backup a directory is really only needed for empty directories as a restore of a file will also restore all of its parent directories.

Specified by:

backupDirectory in interface IBackupStore

Parameters:

file - - the (empty) directory to back up

Returns:

true if the directory was moved to backup. false if the directory was already backed up and remains.

Throws:

java.io.IOException - if directory can not be moved to the backup store, or if the directory is not writeable

discard

public void discard()

Description copied from interface: IBackupStore

Discards and closes this BackupStore. Does nothing if this store is already restored or discarded.

Specified by:

discard in interface IBackupStore

restore

public void restore()
             throws java.io.IOException

Description copied from interface: IBackupStore

Restores all backup files from backup store. Note that restore of a (non directory) file deletes an existing file or directory found in the restore location. When the backup has been restored it can not be used for further backup or restore. If there are unrestorable items (non writeable directories, or general IO exceptions) these items should be written to the log, and the backup copies should be retained for manual restore.

Specified by:

restore in interface IBackupStore

Throws:

java.io.IOException - if the backup was not fully restored - unrestored items should have been logged.

getBackupName

public java.lang.String getBackupName()

Description copied from interface: IBackupStore

Returns the unique backup name (this is the name of generated backup directories).

Specified by:

getBackupName in interface IBackupStore

Returns:

the backup name.

backupCopy

public boolean backupCopy(java.io.File file)
                   throws java.io.IOException

Description copied from interface: IBackupStore

Same as IBackupStore.backup(File) except that a copy is kept in the original location. Can not be used to copy directories.

Specified by:

backupCopy in interface IBackupStore

Parameters:

file - to backup and copy

Returns:

true if the file was backed up, false if this file (path) has already been backed up (the file is not moved to the store).

Throws:

java.io.IOException - - if the backup operation fails, if the file does not exist, or if the copy can not be created.

backupCopyAll

public void backupCopyAll(java.io.File file)
                   throws java.io.IOException

Description copied from interface: IBackupStore

Backs up a file, or everything under a directory. A copy of the backup is left in the original place.

Specified by:

backupCopyAll in interface IBackupStore

Throws:

java.io.IOException

backupAll

public void backupAll(java.io.File file)
               throws java.io.IOException

Description copied from interface: IBackupStore

Backs up a file, or everything under a directory.

Specified by:

backupAll in interface IBackupStore

Parameters:

file - - file to backup or directory

Throws:

java.io.IOException - if backup operation failed