Package com.intellij.openapi.vcs.rollback

Interface RollbackEnvironment

All Known Implementing Classes:

CvsRollbackEnvironment, DefaultRollbackEnvironment, GitRollbackEnvironment, HgRollbackEnvironment, SvnRollbackEnvironment

public interface RollbackEnvironment

Interface for performing VCS rollback / revert operations.

Method Summary

Modifier and Type	Method and Description
default java.util.Collection<? extends AnAction>	createCustomRollbackActions()
java.lang.String	getRollbackOperationName() Returns the name of operation which is shown in the UI (in menu item name, dialog title and button text).
void	rollbackChanges(java.util.List<Change> changes, java.util.List<VcsException> vcsExceptions, RollbackProgressListener listener) Rolls back the specified changes.
void	rollbackIfUnchanged(VirtualFile file) This is called when the user performs an undo that returns a file to a state in which it was checked out or last saved.
void	rollbackMissingFileDeletion(java.util.List<FilePath> files, java.util.List<VcsException> exceptions, RollbackProgressListener listener) Rolls back the deletion of files which have been deleted locally but not scheduled for deletion from VCS.
void	rollbackModifiedWithoutCheckout(java.util.List<VirtualFile> files, java.util.List<VcsException> exceptions, RollbackProgressListener listener) Rolls back the modifications of files which have been made writable but not properly checked out from VCS.

Method Detail

getRollbackOperationName

java.lang.String getRollbackOperationName()

Returns the name of operation which is shown in the UI (in menu item name, dialog title and button text).

Returns:

the user-readable name of operation (for example, "Rollback" or "Revert").

rollbackChanges

void rollbackChanges(java.util.List<Change> changes,
                     java.util.List<VcsException> vcsExceptions,
                     RollbackProgressListener listener)

Rolls back the specified changes.

Parameters:

changes - the changes to roll back.

vcsExceptions -

listener -

rollbackMissingFileDeletion

void rollbackMissingFileDeletion(java.util.List<FilePath> files,
                                 java.util.List<VcsException> exceptions,
                                 RollbackProgressListener listener)

Rolls back the deletion of files which have been deleted locally but not scheduled for deletion from VCS. The implementation of this method should get the current version of the listed files from VCS. You do not need to implement this method if you never report such files to ChangelistBuilder.processLocallyDeletedFile(com.intellij.openapi.vcs.FilePath).

Parameters:

files - the files to rollback deletion of.

exceptions -

listener - @return list of errors occurred, or an empty list if no errors occurred.

rollbackModifiedWithoutCheckout

void rollbackModifiedWithoutCheckout(java.util.List<VirtualFile> files,
                                     java.util.List<VcsException> exceptions,
                                     RollbackProgressListener listener)

Rolls back the modifications of files which have been made writable but not properly checked out from VCS. You do not need to implement this method if you never report such files to ChangelistBuilder.processModifiedWithoutCheckout(com.intellij.openapi.vfs.VirtualFile).

Parameters:

files - the files to rollback.

exceptions -

listener - @return list of errors occurred, or an empty list if no errors occurred.

rollbackIfUnchanged

void rollbackIfUnchanged(VirtualFile file)

This is called when the user performs an undo that returns a file to a state in which it was checked out or last saved. The implementation of this method can compare the current state of file with the base revision and undo the checkout if the file is identical. Implementing this method is optional.

Parameters:

file - the file to rollback.

createCustomRollbackActions

default java.util.Collection<? extends AnAction> createCustomRollbackActions()

Returns:

the list of VCS-specific rollback-flavoured actions to show in Commit dialog