Package com.intellij.openapi.vcs.changes

Interface ChangelistBuilder

All Known Implementing Classes:

EmptyChangelistBuilder, GatheringChangelistBuilder, UnversionedAndNotTouchedFilesGroupCollector

public interface ChangelistBuilder

Builder for the changes list in the file system. The instances of this class are used to collect changes that happened in the file system.

See Also:

ChangeProvider.getChanges(VcsDirtyScope, ChangelistBuilder,com.intellij.openapi.progress.ProgressIndicator, ChangeListManagerGate)

Method Summary

Modifier and Type	Method and Description
void	processChange(Change change, VcsKey vcsKey) Process a change to the file.
void	processChangeInList(Change change, ChangeList changeList, VcsKey vcsKey)
void	processChangeInList(Change change, java.lang.String changeListName, VcsKey vcsKey) Put the given change into the change list with the given name.
void	processIgnoredFile(FilePath filePath)
default void	processIgnoredFile(VirtualFile file) Deprecated. use processIgnoredFile(FilePath) instead
void	processLocallyDeletedFile(FilePath file) Process a file that was deleted locally, but version control has not been notified about removal yet.
void	processLocallyDeletedFile(LocallyDeletedChange locallyDeletedChange)
void	processLockedFolder(VirtualFile file) technically locked folder (for Subversion: locked in working copy to keep WC's state consistent)
void	processLogicallyLockedFolder(VirtualFile file, LogicalLock logicalLock) Logically locked file: (in repository) in lock-modify-unlock model
void	processModifiedWithoutCheckout(VirtualFile file) Process the file that was modified without explicit checkout (if version control supports such behavior).
void	processRootSwitch(VirtualFile file, java.lang.String branch)
void	processSwitchedFile(VirtualFile file, java.lang.String branch, boolean recursive) Report a file which has been updated to a branch other than that of the files around it ("switched").
void	processUnversionedFile(FilePath filePath)
default void	processUnversionedFile(VirtualFile file) Deprecated. use processUnversionedFile(FilePath) instead
void	removeRegisteredChangeFor(FilePath path)
void	reportAdditionalInfo(Factory<javax.swing.JComponent> infoComponent)
void	reportAdditionalInfo(java.lang.String text)
boolean	reportChangesOutsideProject()

Method Detail

processChange

void processChange(Change change,
                   VcsKey vcsKey)

Process a change to the file. This method is used to report changes that version control system knows about.

Parameters:

change - a change to process.

vcsKey -

processChangeInList

void processChangeInList(Change change,
                         ChangeList changeList,
                         VcsKey vcsKey)

processChangeInList

void processChangeInList(Change change,
                         java.lang.String changeListName,
                         VcsKey vcsKey)

Put the given change into the change list with the given name. If there is no such change list it is created. This method allows not to refer to ChangeListManager for the LocalChangeList object.

Parameters:

change - Submitted change

changeListName - A name for a change list.

vcsKey -

removeRegisteredChangeFor

void removeRegisteredChangeFor(FilePath path)

processUnversionedFile

@Deprecated
default void processUnversionedFile(VirtualFile file)

Deprecated. use processUnversionedFile(FilePath) instead

Process a file that is not under version control.

Parameters:

file - a file to process

processUnversionedFile

void processUnversionedFile(FilePath filePath)

processLocallyDeletedFile

void processLocallyDeletedFile(FilePath file)

Process a file that was deleted locally, but version control has not been notified about removal yet.

Parameters:

file - a file to process

processLocallyDeletedFile

void processLocallyDeletedFile(LocallyDeletedChange locallyDeletedChange)

processModifiedWithoutCheckout

void processModifiedWithoutCheckout(VirtualFile file)

Process the file that was modified without explicit checkout (if version control supports such behavior).

Parameters:

file - a file to process

processIgnoredFile

@Deprecated
default void processIgnoredFile(VirtualFile file)

Deprecated. use processIgnoredFile(FilePath) instead

Process the file that is ignored by the version control.

Parameters:

file - an ignored file

processIgnoredFile

void processIgnoredFile(FilePath filePath)

processLockedFolder

void processLockedFolder(VirtualFile file)

technically locked folder (for Subversion: locked in working copy to keep WC's state consistent)

processLogicallyLockedFolder

void processLogicallyLockedFolder(VirtualFile file,
                                  LogicalLock logicalLock)

Logically locked file: (in repository) in lock-modify-unlock model

processSwitchedFile

void processSwitchedFile(VirtualFile file,
                         java.lang.String branch,
                         boolean recursive)

Report a file which has been updated to a branch other than that of the files around it ("switched"). Changed files (reported through processChange(com.intellij.openapi.vcs.changes.Change, com.intellij.openapi.vcs.VcsKey)) can also be reported as switched.

Parameters:

file - the switched file

branch - the name of the branch to which the file is switched.

recursive - if true, all subdirectories of file are also marked as switched to that branch

processRootSwitch

void processRootSwitch(VirtualFile file,
                       java.lang.String branch)

reportChangesOutsideProject

boolean reportChangesOutsideProject()

reportAdditionalInfo

void reportAdditionalInfo(java.lang.String text)

reportAdditionalInfo

void reportAdditionalInfo(Factory<javax.swing.JComponent> infoComponent)