Package com.intellij.openapi.vcs.changes

Interface ChangeProvider

All Known Implementing Classes:

CvsChangeProvider, GitChangeProvider, HgChangeProvider, MockDelayingChangeProvider, SvnChangeProvider

public interface ChangeProvider

The provider of change information (from the point of view of VCS).

Method Summary

Modifier and Type	Method and Description
default void	doCleanup(java.util.List<VirtualFile> files) Accepts files for which vcs operations are temporarily blocked and tries to "cleanup" them - make vcs operations available again.
void	getChanges(VcsDirtyScope dirtyScope, ChangelistBuilder builder, ProgressIndicator progress, ChangeListManagerGate addGate) Get changes from point of view of VCS.
boolean	isModifiedDocumentTrackingRequired() Returns true if the initial unsaved modification of a document should cause dirty scope invalidation for the file corresponding to the document.

Method Detail

getChanges

void getChanges(VcsDirtyScope dirtyScope,
                ChangelistBuilder builder,
                ProgressIndicator progress,
                ChangeListManagerGate addGate)
         throws VcsException

Get changes from point of view of VCS. The vcs plugin should invoke methods on the builder object to report how changes in dirtyScope map to VCS.

The implementations of this method should not report changes outside of the dirty scope, but if these changes are reported, they will be ignored by the caller.

Parameters:

dirtyScope - a changes on the virtual file system

builder - a builder of VCS changes

progress - a current progress object

Throws:

VcsException - if there there is a VCS specific problem

isModifiedDocumentTrackingRequired

boolean isModifiedDocumentTrackingRequired()

Returns true if the initial unsaved modification of a document should cause dirty scope invalidation for the file corresponding to the document.

Returns:

true if document modification should mark the scope as dirty, false otherwise

doCleanup

default void doCleanup(java.util.List<VirtualFile> files)

Accepts files for which vcs operations are temporarily blocked and tries to "cleanup" them - make vcs operations available again. Such files could be reported using ChangelistBuilder.processLockedFolder(VirtualFile).

For instance, for Subversion this method is used to perform "svn cleanup" on corresponding locked working copy directories.