Package com.intellij.openapi.vcs

Class ProjectLevelVcsManager

java.lang.Object

com.intellij.openapi.vcs.ProjectLevelVcsManager

Direct Known Subclasses:

ProjectLevelVcsManagerEx

public abstract class ProjectLevelVcsManager
extends java.lang.Object

Manages the version control systems used by a specific project.

Field Summary

Fields

Modifier and Type	Field and Description
static Topic<VcsListener>	VCS_CONFIGURATION_CHANGED
static Topic<VcsListener>	VCS_CONFIGURATION_CHANGED_IN_PLUGIN

Constructor Summary

Constructors

Constructor and Description
ProjectLevelVcsManager()

Method Summary

Modifier and Type	Method and Description
abstract void	addMessageToConsoleWindow(java.lang.String message, ConsoleViewContentType contentType)
abstract void	addMessageToConsoleWindow(java.lang.String message, TextAttributes attributes) Deprecated. use addMessageToConsoleWindow(String, ConsoleViewContentType)
abstract void	addVcsListener(VcsListener listener) Deprecated. use VCS_CONFIGURATION_CHANGED instead
abstract boolean	checkAllFilesAreUnder(AbstractVcs abstractVcs, VirtualFile[] files) Checks if all given files are managed by the specified VCS.
abstract boolean	checkVcsIsActive(AbstractVcs vcs) Checks if the specified VCS is used by any of the modules in the project.
abstract boolean	checkVcsIsActive(java.lang.String vcsName) Checks if the VCS with the specified name is used by any of the modules in the project.
abstract AbstractVcs	findVcsByName(java.lang.String name) Returns the version control system with the specified name.
abstract AbstractVcs	findVersioningVcs(VirtualFile file)
abstract AbstractVcs []	getAllActiveVcss() Returns the list of VCSes used by at least one module in the project.
abstract VcsRoot []	getAllVcsRoots()
abstract VcsDescriptor[]	getAllVcss() Returns the list of all registered version control systems.
abstract VirtualFile[]	getAllVersionedRoots()
abstract VcsAnnotationLocalChangesListener	getAnnotationLocalChangesListener()
abstract CheckoutProvider.Listener	getCompositeCheckoutListener()
abstract ContentRevisionCache	getContentRevisionCache()
abstract VcsDescriptor	getDescriptor(java.lang.String name)
abstract java.util.List<VirtualFile>	getDetailedVcsMappings(AbstractVcs vcs) Also includes into list all modules under roots
abstract VcsDirectoryMapping	getDirectoryMappingFor(FilePath path)
abstract java.util.List<VcsDirectoryMapping>	getDirectoryMappings()
abstract java.util.List<VcsDirectoryMapping>	getDirectoryMappings(AbstractVcs vcs)
static ProjectLevelVcsManager	getInstance(Project project) Returns the instance for the specified project.
static ProjectLevelVcsManager	getInstanceChecked(Project project) Gets the instance of the component if the project wasn't disposed.
abstract VcsShowSettingOption	getOrCreateCustomOption(java.lang.String vcsActionName, AbstractVcs vcs)
abstract VcsRootChecker	getRootChecker(AbstractVcs vcs)
abstract VirtualFile[]	getRootsUnderVcs(AbstractVcs vcs)
abstract java.util.List<VirtualFile>	getRootsUnderVcsWithoutFiltering(AbstractVcs vcs)
abstract VcsShowConfirmationOption	getStandardConfirmation(VcsConfiguration.StandardConfirmation option, AbstractVcs vcs)
abstract VcsShowSettingOption	getStandardOption(VcsConfiguration.StandardOption option, AbstractVcs vcs)
abstract AbstractVcs	getVcsFor(FilePath file) Returns the VCS managing the specified file path.
abstract AbstractVcs	getVcsFor(VirtualFile file) Returns the VCS managing the specified file.
abstract VcsHistoryCache	getVcsHistoryCache()
abstract VirtualFile	getVcsRootFor(FilePath file) Return the parent directory of the specified file path which is mapped to a VCS.
abstract VirtualFile	getVcsRootFor(VirtualFile file) Return the parent directory of the specified file which is mapped to a VCS.
abstract VcsRoot	getVcsRootObjectFor(FilePath file)
abstract VcsRoot	getVcsRootObjectFor(VirtualFile file)
abstract boolean	hasActiveVcss()
abstract boolean	hasAnyMappings()
abstract boolean	isBackgroundVcsOperationRunning() Checks if a background VCS operation (commit or update) is currently in progress.
abstract boolean	isFileInContent(VirtualFile vf)
abstract boolean	isIgnored(FilePath filePath)
abstract boolean	isIgnored(VirtualFile vf)
abstract void	iterateVcsRoot(VirtualFile root, Processor<? super FilePath> iterator)
abstract void	iterateVcsRoot(VirtualFile root, Processor<? super FilePath> iterator, VirtualFileFilter directoryFilter)
abstract void	iterateVfUnderVcsRoot(VirtualFile file, Processor<? super VirtualFile> processor)
abstract void	removeVcsListener(VcsListener listener) Deprecated. use VCS_CONFIGURATION_CHANGED instead
abstract void	setDirectoryMapping(java.lang.String path, java.lang.String activeVcsName) Deprecated.
abstract void	setDirectoryMappings(java.util.List<VcsDirectoryMapping> items)
abstract void	showProjectOperationInfo(UpdatedFiles updatedFiles, java.lang.String displayActionName)
abstract void	startBackgroundVcsOperation() Marks the beginning of a background VCS operation (commit or update).
abstract void	stopBackgroundVcsOperation() Marks the end of a background VCS operation (commit or update).
void	updateActiveVcss() Deprecated. Use just setDirectoryMappings(List).

Methods inherited from class java.lang.Object

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

Field Detail

VCS_CONFIGURATION_CHANGED

public static final Topic<VcsListener> VCS_CONFIGURATION_CHANGED

VCS_CONFIGURATION_CHANGED_IN_PLUGIN

public static final Topic<VcsListener> VCS_CONFIGURATION_CHANGED_IN_PLUGIN

Constructor Detail

ProjectLevelVcsManager

public ProjectLevelVcsManager()

Method Detail

iterateVfUnderVcsRoot

public abstract void iterateVfUnderVcsRoot(VirtualFile file,
                                           Processor<? super VirtualFile> processor)

getInstance

public static ProjectLevelVcsManager getInstance(Project project)

Returns the instance for the specified project.

getInstanceChecked

public static ProjectLevelVcsManager getInstanceChecked(Project project)

Gets the instance of the component if the project wasn't disposed. If the project was disposed, throws ProcessCanceledException. Should only be used for calling from background threads (for example, committed changes refresh thread).

getAllVcss

public abstract VcsDescriptor[] getAllVcss()

Returns the list of all registered version control systems.

findVcsByName

public abstract AbstractVcs findVcsByName(java.lang.String name)

Returns the version control system with the specified name.

Returns:

the VCS instance, or null if none was found.

getDescriptor

public abstract VcsDescriptor getDescriptor(java.lang.String name)

checkAllFilesAreUnder

public abstract boolean checkAllFilesAreUnder(AbstractVcs abstractVcs,
                                              VirtualFile[] files)

Checks if all given files are managed by the specified VCS.

getVcsFor

public abstract AbstractVcs getVcsFor(VirtualFile file)

Returns the VCS managing the specified file.

Returns:

the VCS instance, or null if the file does not belong to any module or the module it belongs to is not under version control.

getVcsFor

public abstract AbstractVcs getVcsFor(FilePath file)

Returns the VCS managing the specified file path.

Returns:

the VCS instance, or null if the file does not belong to any module or the module it belongs to is not under version control.

getVcsRootFor

public abstract VirtualFile getVcsRootFor(VirtualFile file)

Return the parent directory of the specified file which is mapped to a VCS.

Returns:

the root, or null if the specified file is not in a VCS-managed directory.

getVcsRootFor

public abstract VirtualFile getVcsRootFor(FilePath file)

Return the parent directory of the specified file path which is mapped to a VCS.

Returns:

the root, or null if the specified file is not in a VCS-managed directory.

getVcsRootObjectFor

public abstract VcsRoot getVcsRootObjectFor(VirtualFile file)

getVcsRootObjectFor

public abstract VcsRoot getVcsRootObjectFor(FilePath file)

checkVcsIsActive

public abstract boolean checkVcsIsActive(AbstractVcs vcs)

Checks if the specified VCS is used by any of the modules in the project.

checkVcsIsActive

public abstract boolean checkVcsIsActive(java.lang.String vcsName)

Checks if the VCS with the specified name is used by any of the modules in the project.

getAllActiveVcss

public abstract AbstractVcs [] getAllActiveVcss()

Returns the list of VCSes used by at least one module in the project.

hasActiveVcss

public abstract boolean hasActiveVcss()

hasAnyMappings

public abstract boolean hasAnyMappings()

addMessageToConsoleWindow

@Deprecated
public abstract void addMessageToConsoleWindow(java.lang.String message,
                                               TextAttributes attributes)

Deprecated. use addMessageToConsoleWindow(String, ConsoleViewContentType)

addMessageToConsoleWindow

public abstract void addMessageToConsoleWindow(java.lang.String message,
                                               ConsoleViewContentType contentType)

getStandardOption

public abstract VcsShowSettingOption getStandardOption(VcsConfiguration.StandardOption option,
                                                       AbstractVcs vcs)

getStandardConfirmation

public abstract VcsShowConfirmationOption getStandardConfirmation(VcsConfiguration.StandardConfirmation option,
                                                                  AbstractVcs vcs)

getOrCreateCustomOption

public abstract VcsShowSettingOption getOrCreateCustomOption(java.lang.String vcsActionName,
                                                             AbstractVcs vcs)

showProjectOperationInfo

public abstract void showProjectOperationInfo(UpdatedFiles updatedFiles,
                                              java.lang.String displayActionName)

addVcsListener

@Deprecated
public abstract void addVcsListener(VcsListener listener)

Deprecated. use VCS_CONFIGURATION_CHANGED instead

Adds a listener for receiving notifications about changes in VCS configuration for the project.

removeVcsListener

@Deprecated
public abstract void removeVcsListener(VcsListener listener)

Deprecated. use VCS_CONFIGURATION_CHANGED instead

Removes a listener for receiving notifications about changes in VCS configuration for the project.

startBackgroundVcsOperation

public abstract void startBackgroundVcsOperation()

Marks the beginning of a background VCS operation (commit or update).

stopBackgroundVcsOperation

public abstract void stopBackgroundVcsOperation()

Marks the end of a background VCS operation (commit or update).

isBackgroundVcsOperationRunning

public abstract boolean isBackgroundVcsOperationRunning()

Checks if a background VCS operation (commit or update) is currently in progress.

getRootsUnderVcsWithoutFiltering

public abstract java.util.List<VirtualFile> getRootsUnderVcsWithoutFiltering(AbstractVcs vcs)

getRootsUnderVcs

public abstract VirtualFile[] getRootsUnderVcs(AbstractVcs vcs)

getDetailedVcsMappings

public abstract java.util.List<VirtualFile> getDetailedVcsMappings(AbstractVcs vcs)

Also includes into list all modules under roots

getAllVersionedRoots

public abstract VirtualFile[] getAllVersionedRoots()

getAllVcsRoots

public abstract VcsRoot [] getAllVcsRoots()

updateActiveVcss

@Deprecated
public void updateActiveVcss()

Deprecated. Use just setDirectoryMappings(List).

getDirectoryMappings

public abstract java.util.List<VcsDirectoryMapping> getDirectoryMappings()

getDirectoryMappings

public abstract java.util.List<VcsDirectoryMapping> getDirectoryMappings(AbstractVcs vcs)

getDirectoryMappingFor

public abstract VcsDirectoryMapping getDirectoryMappingFor(FilePath path)

setDirectoryMapping

@Deprecated
public abstract void setDirectoryMapping(java.lang.String path,
                                         java.lang.String activeVcsName)

Deprecated.

This method can be used only when initially loading the project configuration!

setDirectoryMappings

public abstract void setDirectoryMappings(java.util.List<VcsDirectoryMapping> items)

iterateVcsRoot

public abstract void iterateVcsRoot(VirtualFile root,
                                    Processor<? super FilePath> iterator)

iterateVcsRoot

public abstract void iterateVcsRoot(VirtualFile root,
                                    Processor<? super FilePath> iterator,
                                    VirtualFileFilter directoryFilter)

findVersioningVcs

public abstract AbstractVcs findVersioningVcs(VirtualFile file)

getRootChecker

public abstract VcsRootChecker getRootChecker(AbstractVcs vcs)

getCompositeCheckoutListener

public abstract CheckoutProvider.Listener getCompositeCheckoutListener()

getVcsHistoryCache

public abstract VcsHistoryCache getVcsHistoryCache()

getContentRevisionCache

public abstract ContentRevisionCache getContentRevisionCache()

isFileInContent

public abstract boolean isFileInContent(VirtualFile vf)

isIgnored

public abstract boolean isIgnored(VirtualFile vf)

isIgnored

public abstract boolean isIgnored(FilePath filePath)

getAnnotationLocalChangesListener

public abstract VcsAnnotationLocalChangesListener getAnnotationLocalChangesListener()