org.netbeans.modules.refactoring.spi

Class BackupFacility

java.lang.Object

org.netbeans.modules.refactoring.spi.BackupFacility

Deprecated.

@Deprecated
public abstract class BackupFacility
extends Object

Simple backup facility can be used to backup files and implement undo For instance Java Refactoring module implements undo this way: public Problem prepare(RefactoringElementsBag elements) { . . elements.registerTransaction(new RetoucheCommit(results)); } where RetoucheCommit is Transaction:

 BackupFacility.Handle handle;
 public void commit() {
   FileObject[] files;
   .
   .
   handle = BackupFacility.getDefault().backup(files);
   doCommit();
 }
 public void rollback() {
   //rollback all files
   handle.restore();
 }
 

You can register your own implementation via META-INF services.

See Also:

Transaction, RefactoringElementImplementation.performChange(), RefactoringElementImplementation.undoChange(), RefactoringElementsBag.registerTransaction(org.netbeans.modules.refactoring.spi.Transaction), RefactoringElementsBag.addFileChange(org.netbeans.modules.refactoring.api.AbstractRefactoring, org.netbeans.modules.refactoring.spi.RefactoringElementImplementation), BackupFacility.Handle

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BackupFacility.Handle Deprecated. Handle class representing handle to file(s), which were backuped by org.netbeans.modules.refactoring.spi.BackupFacility#backup()

Method Summary

Modifier and Type	Method and Description
BackupFacility.Handle	backup(Collection<? extends FileObject> fileObjects) Deprecated. does backup
abstract BackupFacility.Handle	backup(FileObject... file) Deprecated. does beckup
abstract void	clear() Deprecated. do cleanup all backup files are deleted all internal structures cleared default implementa
static BackupFacility	getDefault() Deprecated.

Methods inherited from class java.lang.Object

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

Method Detail

backup

public abstract BackupFacility.Handle backup(FileObject... file)
                                      throws IOException

Deprecated.

does beckup

Parameters:

file - file(s) to backup

Returns:

handle which can be used to restore files

Throws:

IOException - if backup failed

backup

public final BackupFacility.Handle backup(Collection<? extends FileObject> fileObjects)
                                   throws IOException

Deprecated.

does backup

Parameters:

fileObjects - FileObjects to backup

Returns:

handle which can be used to restore files

Throws:

IOException

clear

public abstract void clear()

Deprecated.

do cleanup all backup files are deleted all internal structures cleared default implementa

getDefault

public static BackupFacility getDefault()

Deprecated.

Returns:

default instance of this class. If there is instance of this class in META-INF services -> this class is returned. Otherwise default implementation is used.