Package com.intellij.openapi.vcs

Class AbstractVcsHelper

java.lang.Object

com.intellij.openapi.vcs.AbstractVcsHelper

Direct Known Subclasses:

AbstractVcsHelperImpl

public abstract class AbstractVcsHelper
extends java.lang.Object

Component which provides means to invoke different VCS-related services.

Field Summary

Fields

Modifier and Type	Field and Description
protected Project	myProject

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractVcsHelper(Project project)

Method Summary

Modifier and Type	Method and Description
abstract boolean	commitChanges(java.util.Collection<? extends Change> changes, LocalChangeList initialChangeList, java.lang.String commitMessage, CommitResultHandler customResultHandler) Shows commit dialog, fills it with the given changes and given commit message, initially selects the given changelist.
static AbstractVcsHelper	getInstance(Project project)
abstract void	loadAndShowCommittedChangesDetails(Project project, VcsRevisionNumber revision, VirtualFile file, VcsKey key, RepositoryLocation location, boolean local)
abstract void	openCommittedChangesTab(CommittedChangesProvider provider, RepositoryLocation location, ChangeBrowserSettings settings, int maxCount, java.lang.String title)
abstract java.util.List<VcsException>	runTransactionRunnable(AbstractVcs vcs, TransactionRunnable runnable, java.lang.Object vcsParameters) Runs the runnable inside the vcs transaction (if needed), collects all exceptions, commits/rollbacks transaction and returns all exceptions together.
abstract java.util.Collection<FilePath>	selectFilePathsToProcess(java.util.List<? extends FilePath> files, java.lang.String title, java.lang.String prompt, java.lang.String singleFileTitle, java.lang.String singleFilePromptTemplate, VcsShowConfirmationOption confirmationOption)
abstract java.util.Collection<FilePath>	selectFilePathsToProcess(java.util.List<? extends FilePath> files, java.lang.String title, java.lang.String prompt, java.lang.String singleFileTitle, java.lang.String singleFilePromptTemplate, VcsShowConfirmationOption confirmationOption, java.lang.String okActionName, java.lang.String cancelActionName)
abstract java.util.Collection<VirtualFile>	selectFilesToProcess(java.util.List<? extends VirtualFile> files, java.lang.String title, java.lang.String prompt, java.lang.String singleFileTitle, java.lang.String singleFilePromptTemplate, VcsShowConfirmationOption confirmationOption)
abstract void	showAnnotation(FileAnnotation annotation, VirtualFile file, AbstractVcs vcs)
abstract void	showAnnotation(FileAnnotation annotation, VirtualFile file, AbstractVcs vcs, int line)
abstract void	showChangesListBrowser(CommittedChangeList changelist, java.lang.String title)
abstract void	showCommittedChangesBrowser(CommittedChangesProvider provider, RepositoryLocation location, java.lang.String title, java.awt.Component parent)
void	showError(VcsException e, java.lang.String tabDisplayName)
abstract void	showErrors(java.util.List<? extends VcsException> abstractVcsExceptions, java.lang.String tabDisplayName)
abstract void	showErrors(java.util.Map<HotfixData,java.util.List<VcsException>> exceptionGroups, java.lang.String tabDisplayName)
abstract void	showFileHistory(VcsHistoryProvider historyProvider, AnnotationProvider annotationProvider, FilePath path, AbstractVcs vcs)
abstract void	showFileHistory(VcsHistoryProvider historyProvider, FilePath path, AbstractVcs vcs)
java.util.List<VirtualFile>	showMergeDialog(java.util.List<? extends VirtualFile> files) showMergeDialog(java.util.List, com.intellij.openapi.vcs.merge.MergeProvider) without description and with default merge provider for the current VCS.
java.util.List<VirtualFile>	showMergeDialog(java.util.List<? extends VirtualFile> files, MergeProvider provider) showMergeDialog(java.util.List, com.intellij.openapi.vcs.merge.MergeProvider) without description.
abstract java.util.List<VirtualFile>	showMergeDialog(java.util.List<? extends VirtualFile> files, MergeProvider provider, MergeDialogCustomizer mergeDialogCustomizer) Shows the multiple file merge dialog for resolving conflicts in the specified set of virtual files.
abstract void	showWhatDiffersBrowser(java.util.Collection<Change> changes, java.lang.String title)

Methods inherited from class java.lang.Object

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

Field Detail

myProject

protected final Project myProject

Constructor Detail

AbstractVcsHelper

protected AbstractVcsHelper(Project project)

Method Detail

getInstance

public static AbstractVcsHelper getInstance(Project project)

showErrors

public abstract void showErrors(java.util.List<? extends VcsException> abstractVcsExceptions,
                                java.lang.String tabDisplayName)

showErrors

public abstract void showErrors(java.util.Map<HotfixData,java.util.List<VcsException>> exceptionGroups,
                                java.lang.String tabDisplayName)

runTransactionRunnable

public abstract java.util.List<VcsException> runTransactionRunnable(AbstractVcs vcs,
                                                                    TransactionRunnable runnable,
                                                                    java.lang.Object vcsParameters)

Runs the runnable inside the vcs transaction (if needed), collects all exceptions, commits/rollbacks transaction and returns all exceptions together.

showError

public void showError(VcsException e,
                      java.lang.String tabDisplayName)

showAnnotation

public abstract void showAnnotation(FileAnnotation annotation,
                                    VirtualFile file,
                                    AbstractVcs vcs)

showAnnotation

public abstract void showAnnotation(FileAnnotation annotation,
                                    VirtualFile file,
                                    AbstractVcs vcs,
                                    int line)

showChangesListBrowser

public abstract void showChangesListBrowser(CommittedChangeList changelist,
                                            java.lang.String title)

showWhatDiffersBrowser

public abstract void showWhatDiffersBrowser(java.util.Collection<Change> changes,
                                            java.lang.String title)

showCommittedChangesBrowser

public abstract void showCommittedChangesBrowser(CommittedChangesProvider provider,
                                                 RepositoryLocation location,
                                                 java.lang.String title,
                                                 java.awt.Component parent)

openCommittedChangesTab

public abstract void openCommittedChangesTab(CommittedChangesProvider provider,
                                             RepositoryLocation location,
                                             ChangeBrowserSettings settings,
                                             int maxCount,
                                             java.lang.String title)

showMergeDialog

public abstract java.util.List<VirtualFile> showMergeDialog(java.util.List<? extends VirtualFile> files,
                                                            MergeProvider provider,
                                                            MergeDialogCustomizer mergeDialogCustomizer)

Shows the multiple file merge dialog for resolving conflicts in the specified set of virtual files. Assumes all files are under the same VCS.

Parameters:

files - the files to show in the merge dialog.

provider - MergeProvider to be used for merging.

mergeDialogCustomizer - custom container of titles, descriptions and messages for the merge dialog.

Returns:

changed files for which the merge was actually performed.

showMergeDialog

public final java.util.List<VirtualFile> showMergeDialog(java.util.List<? extends VirtualFile> files,
                                                         MergeProvider provider)

showMergeDialog(java.util.List, com.intellij.openapi.vcs.merge.MergeProvider) without description.

showMergeDialog

public final java.util.List<VirtualFile> showMergeDialog(java.util.List<? extends VirtualFile> files)

showMergeDialog(java.util.List, com.intellij.openapi.vcs.merge.MergeProvider) without description and with default merge provider for the current VCS.

showFileHistory

public abstract void showFileHistory(VcsHistoryProvider historyProvider,
                                     FilePath path,
                                     AbstractVcs vcs)

showFileHistory

public abstract void showFileHistory(VcsHistoryProvider historyProvider,
                                     AnnotationProvider annotationProvider,
                                     FilePath path,
                                     AbstractVcs vcs)

selectFilesToProcess

public abstract java.util.Collection<VirtualFile> selectFilesToProcess(java.util.List<? extends VirtualFile> files,
                                                                       java.lang.String title,
                                                                       java.lang.String prompt,
                                                                       java.lang.String singleFileTitle,
                                                                       java.lang.String singleFilePromptTemplate,
                                                                       VcsShowConfirmationOption confirmationOption)

selectFilePathsToProcess

public abstract java.util.Collection<FilePath> selectFilePathsToProcess(java.util.List<? extends FilePath> files,
                                                                        java.lang.String title,
                                                                        java.lang.String prompt,
                                                                        java.lang.String singleFileTitle,
                                                                        java.lang.String singleFilePromptTemplate,
                                                                        VcsShowConfirmationOption confirmationOption)

selectFilePathsToProcess

public abstract java.util.Collection<FilePath> selectFilePathsToProcess(java.util.List<? extends FilePath> files,
                                                                        java.lang.String title,
                                                                        java.lang.String prompt,
                                                                        java.lang.String singleFileTitle,
                                                                        java.lang.String singleFilePromptTemplate,
                                                                        VcsShowConfirmationOption confirmationOption,
                                                                        java.lang.String okActionName,
                                                                        java.lang.String cancelActionName)

commitChanges

public abstract boolean commitChanges(java.util.Collection<? extends Change> changes,
                                      LocalChangeList initialChangeList,
                                      java.lang.String commitMessage,
                                      CommitResultHandler customResultHandler)

Shows commit dialog, fills it with the given changes and given commit message, initially selects the given changelist.

Note that the method is asynchronous: it returns right after user presses "Commit" or "Cancel" and after all pre-commit handlers have been called. It doesn't wait for commit itself to succeed or fail - for this use the customResultHandler.

Returns:

true if user decides to commit the changes, false if user presses Cancel.

loadAndShowCommittedChangesDetails

public abstract void loadAndShowCommittedChangesDetails(Project project,
                                                        VcsRevisionNumber revision,
                                                        VirtualFile file,
                                                        VcsKey key,
                                                        RepositoryLocation location,
                                                        boolean local)