Package com.intellij.openapi.vcs.impl

Class ProjectLevelVcsManagerImpl

java.lang.Object

com.intellij.openapi.vcs.ProjectLevelVcsManager

com.intellij.openapi.vcs.ex.ProjectLevelVcsManagerEx

com.intellij.openapi.vcs.impl.ProjectLevelVcsManagerImpl

All Implemented Interfaces:

PersistentStateComponent<Element>, Disposable

public final class ProjectLevelVcsManagerImpl
extends ProjectLevelVcsManagerEx
implements PersistentStateComponent<Element>, Disposable

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields inherited from class com.intellij.openapi.vcs.ProjectLevelVcsManager

VCS_CONFIGURATION_CHANGED, VCS_CONFIGURATION_CHANGED_IN_PLUGIN

Constructor Summary

Constructors

Constructor and Description
ProjectLevelVcsManagerImpl(Project project)

Method Summary

Modifier and Type	Method and Description
void	addInitializationRequest(VcsInitObject vcsInitObject, java.lang.Runnable runnable)
void	addMessageToConsoleWindow(java.lang.String message, ConsoleViewContentType contentType)
void	addMessageToConsoleWindow(java.lang.String message, TextAttributes attributes) Deprecated.
void	addVcsListener(VcsListener listener) Adds a listener for receiving notifications about changes in VCS configuration for the project.
boolean	checkAllFilesAreUnder(AbstractVcs abstractVcs, VirtualFile[] files) Checks if all given files are managed by the specified VCS.
boolean	checkVcsIsActive(AbstractVcs vcs) Checks if the specified VCS is used by any of the modules in the project.
boolean	checkVcsIsActive(java.lang.String vcsName) Checks if the VCS with the specified name is used by any of the modules in the project.
void	dispose() Usually not invoked directly, see class javadoc.
AbstractVcs	findVcsByName(java.lang.String name) Returns the version control system with the specified name.
AbstractVcs	findVersioningVcs(VirtualFile file) Used to guess VCS for automatic mapping through a look into a working copy
void	fireDirectoryMappingsChanged()
AbstractVcs []	getAllActiveVcss() Returns the list of VCSes used by at least one module in the project.
java.util.List<VcsShowConfirmationOptionImpl>	getAllConfirmations()
java.util.List<VcsShowOptionsSettingImpl>	getAllOptions()
VcsRoot []	getAllVcsRoots()
VcsDescriptor[]	getAllVcss() Returns the list of all registered version control systems.
VirtualFile[]	getAllVersionedRoots()
VcsAnnotationLocalChangesListener	getAnnotationLocalChangesListener()
BackgroundableActionEnabledHandler	getBackgroundableActionHandler(VcsBackgroundableActions action) Deprecated. use BackgroundableActionLock
CheckoutProvider.Listener	getCompositeCheckoutListener()
VcsShowConfirmationOptionImpl	getConfirmation(VcsConfiguration.StandardConfirmation option)
ContentManager	getContentManager()
ContentRevisionCache	getContentRevisionCache()
VcsDescriptor	getDescriptor(java.lang.String name)
java.util.List<VirtualFile>	getDetailedVcsMappings(AbstractVcs vcs) Also includes into list all modules under roots
VcsDirectoryMapping	getDirectoryMappingFor(FilePath file)
java.util.List<VcsDirectoryMapping>	getDirectoryMappings()
java.util.List<VcsDirectoryMapping>	getDirectoryMappings(AbstractVcs vcs)
static ProjectLevelVcsManagerImpl	getInstanceImpl(Project project)
VcsShowSettingOption	getOptions(VcsConfiguration.StandardOption option)
VcsShowSettingOption	getOrCreateCustomOption(java.lang.String vcsActionName, AbstractVcs vcs)
VcsRootChecker	getRootChecker(AbstractVcs vcs)
VirtualFile []	getRootsUnderVcs(AbstractVcs vcs)
java.util.List<VirtualFile>	getRootsUnderVcsWithoutFiltering(AbstractVcs vcs)
VcsShowConfirmationOption	getStandardConfirmation(VcsConfiguration.StandardConfirmation option, AbstractVcs vcs)
VcsShowSettingOption	getStandardOption(VcsConfiguration.StandardOption option, AbstractVcs vcs)
Element	getState()
AbstractVcs	getVcsFor(FilePath file) Returns the VCS managing the specified file path.
AbstractVcs	getVcsFor(VirtualFile file) Returns the VCS managing the specified file.
VcsHistoryCache	getVcsHistoryCache()
VirtualFile	getVcsRootFor(FilePath file) Return the parent directory of the specified file path which is mapped to a VCS.
VirtualFile	getVcsRootFor(VirtualFile file) Return the parent directory of the specified file which is mapped to a VCS.
VcsRoot	getVcsRootObjectFor(FilePath file)
VcsRoot	getVcsRootObjectFor(VirtualFile file)
boolean	hasActiveVcss()
boolean	hasAnyMappings()
java.lang.String	haveDefaultMapping()
boolean	haveVcses()
boolean	isBackgroundVcsOperationRunning() Checks if a background VCS operation (commit or update) is currently in progress.
boolean	isFileInContent(VirtualFile vf)
boolean	isIgnored(FilePath filePath)
boolean	isIgnored(VirtualFile vf)
void	iterateVcsRoot(VirtualFile root, Processor<? super FilePath> iterator)
void	iterateVcsRoot(VirtualFile root, Processor<? super FilePath> iterator, VirtualFileFilter directoryFilter)
void	iterateVfUnderVcsRoot(VirtualFile file, Processor<? super VirtualFile> processor)
void	loadState(Element state) This method is called when new component state is loaded.
boolean	needAutodetectMappings() Returns 'true' during initial project setup, ie: There are no explicitly configured mappings (setDirectoryMapping(java.lang.String, java.lang.String) vs setAutoDirectoryMappings(java.util.List<? extends com.intellij.openapi.vcs.VcsDirectoryMapping>)) There are no mappings inherited from "Default Project" configuration (excluding <Project> mappings) (myMappingsLoaded Project was not reopened a second time (ATTRIBUTE_DEFAULT_PROJECT)
void	notifyDirectoryMappingChanged()
void	registerVcs(AbstractVcs vcs)
void	removeDirectoryMapping(VcsDirectoryMapping mapping)
void	removeVcsListener(VcsListener listener) Removes a listener for receiving notifications about changes in VCS configuration for the project.
void	scheduleMappedRootsUpdate()
void	setAutoDirectoryMapping(java.lang.String path, java.lang.String activeVcsName) Deprecated. use setAutoDirectoryMappings(List)
void	setAutoDirectoryMappings(java.util.List<? extends VcsDirectoryMapping> mappings)
void	setDirectoryMapping(java.lang.String path, java.lang.String activeVcsName) This method can be used only when initially loading the project configuration!
void	setDirectoryMappings(java.util.List<VcsDirectoryMapping> items)
void	showProjectOperationInfo(UpdatedFiles updatedFiles, java.lang.String displayActionName)
UpdateInfoTree	showUpdateProjectInfo(UpdatedFiles updatedFiles, java.lang.String displayActionName, ActionInfo actionInfo, boolean canceled)
void	startBackgroundVcsOperation() Marks the beginning of a background VCS operation (commit or update).
void	stopBackgroundVcsOperation() Marks the end of a background VCS operation (commit or update).
void	unregisterVcs(AbstractVcs vcs)
void	waitForInitialized()

Methods inherited from class com.intellij.openapi.vcs.ex.ProjectLevelVcsManagerEx

getInstanceEx

Methods inherited from class com.intellij.openapi.vcs.ProjectLevelVcsManager

getInstance, getInstanceChecked, updateActiveVcss

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.components.PersistentStateComponent

initializeComponent, noStateLoaded

Constructor Detail

ProjectLevelVcsManagerImpl

public ProjectLevelVcsManagerImpl(Project project)

Method Detail

getInstanceImpl

public static ProjectLevelVcsManagerImpl getInstanceImpl(Project project)

registerVcs

public void registerVcs(AbstractVcs vcs)

findVcsByName

public AbstractVcs findVcsByName(java.lang.String name)

Description copied from class: ProjectLevelVcsManager

Returns the version control system with the specified name.

Specified by:

findVcsByName in class ProjectLevelVcsManager

Returns:

the VCS instance, or null if none was found.

getDescriptor

public VcsDescriptor getDescriptor(java.lang.String name)

Specified by:

getDescriptor in class ProjectLevelVcsManager

iterateVfUnderVcsRoot

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

Specified by:

iterateVfUnderVcsRoot in class ProjectLevelVcsManager

getAllVcss

public VcsDescriptor[] getAllVcss()

Description copied from class: ProjectLevelVcsManager

Returns the list of all registered version control systems.

Specified by:

getAllVcss in class ProjectLevelVcsManager

haveVcses

public boolean haveVcses()

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

getAnnotationLocalChangesListener

public VcsAnnotationLocalChangesListener getAnnotationLocalChangesListener()

Specified by:

getAnnotationLocalChangesListener in class ProjectLevelVcsManager

checkAllFilesAreUnder

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

Description copied from class: ProjectLevelVcsManager

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

Specified by:

checkAllFilesAreUnder in class ProjectLevelVcsManager

getVcsFor

public AbstractVcs getVcsFor(VirtualFile file)

Description copied from class: ProjectLevelVcsManager

Returns the VCS managing the specified file.

Specified by:

getVcsFor in class ProjectLevelVcsManager

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 AbstractVcs getVcsFor(FilePath file)

Description copied from class: ProjectLevelVcsManager

Returns the VCS managing the specified file path.

Specified by:

getVcsFor in class ProjectLevelVcsManager

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 VirtualFile getVcsRootFor(VirtualFile file)

Description copied from class: ProjectLevelVcsManager

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

Specified by:

getVcsRootFor in class ProjectLevelVcsManager

Returns:

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

getVcsRootObjectFor

public VcsRoot getVcsRootObjectFor(VirtualFile file)

Specified by:

getVcsRootObjectFor in class ProjectLevelVcsManager

getVcsRootFor

public VirtualFile getVcsRootFor(FilePath file)

Description copied from class: ProjectLevelVcsManager

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

Specified by:

getVcsRootFor in class ProjectLevelVcsManager

Returns:

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

getVcsRootObjectFor

public VcsRoot getVcsRootObjectFor(FilePath file)

Specified by:

getVcsRootObjectFor in class ProjectLevelVcsManager

unregisterVcs

public void unregisterVcs(AbstractVcs vcs)

getContentManager

public ContentManager getContentManager()

Specified by:

getContentManager in class ProjectLevelVcsManagerEx

checkVcsIsActive

public boolean checkVcsIsActive(AbstractVcs vcs)

Description copied from class: ProjectLevelVcsManager

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

Specified by:

checkVcsIsActive in class ProjectLevelVcsManager

checkVcsIsActive

public boolean checkVcsIsActive(java.lang.String vcsName)

Description copied from class: ProjectLevelVcsManager

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

Specified by:

checkVcsIsActive in class ProjectLevelVcsManager

getAllActiveVcss

public AbstractVcs [] getAllActiveVcss()

Description copied from class: ProjectLevelVcsManager

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

Specified by:

getAllActiveVcss in class ProjectLevelVcsManager

hasActiveVcss

public boolean hasActiveVcss()

Specified by:

hasActiveVcss in class ProjectLevelVcsManager

hasAnyMappings

public boolean hasAnyMappings()

Specified by:

hasAnyMappings in class ProjectLevelVcsManager

addMessageToConsoleWindow

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

Deprecated.

Specified by:

addMessageToConsoleWindow in class ProjectLevelVcsManager

addMessageToConsoleWindow

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

Specified by:

addMessageToConsoleWindow in class ProjectLevelVcsManager

getOptions

public VcsShowSettingOption getOptions(VcsConfiguration.StandardOption option)

Specified by:

getOptions in class ProjectLevelVcsManagerEx

getAllOptions

public java.util.List<VcsShowOptionsSettingImpl> getAllOptions()

Specified by:

getAllOptions in class ProjectLevelVcsManagerEx

getStandardOption

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

Specified by:

getStandardOption in class ProjectLevelVcsManager

getOrCreateCustomOption

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

Specified by:

getOrCreateCustomOption in class ProjectLevelVcsManager

showProjectOperationInfo

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

Specified by:

showProjectOperationInfo in class ProjectLevelVcsManager

showUpdateProjectInfo

public UpdateInfoTree showUpdateProjectInfo(UpdatedFiles updatedFiles,
                                            java.lang.String displayActionName,
                                            ActionInfo actionInfo,
                                            boolean canceled)

Specified by:

showUpdateProjectInfo in class ProjectLevelVcsManagerEx

getDirectoryMappings

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

Specified by:

getDirectoryMappings in class ProjectLevelVcsManager

getDirectoryMappings

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

Specified by:

getDirectoryMappings in class ProjectLevelVcsManager

getDirectoryMappingFor

public VcsDirectoryMapping getDirectoryMappingFor(FilePath file)

Specified by:

getDirectoryMappingFor in class ProjectLevelVcsManager

setDirectoryMapping

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

Description copied from class: ProjectLevelVcsManager

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

Specified by:

setDirectoryMapping in class ProjectLevelVcsManager

setAutoDirectoryMapping

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

Deprecated. use setAutoDirectoryMappings(List)

setAutoDirectoryMappings

public void setAutoDirectoryMappings(java.util.List<? extends VcsDirectoryMapping> mappings)

removeDirectoryMapping

public void removeDirectoryMapping(VcsDirectoryMapping mapping)

setDirectoryMappings

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

Specified by:

setDirectoryMappings in class ProjectLevelVcsManager

scheduleMappedRootsUpdate

public void scheduleMappedRootsUpdate()

Specified by:

scheduleMappedRootsUpdate in class ProjectLevelVcsManagerEx

iterateVcsRoot

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

Specified by:

iterateVcsRoot in class ProjectLevelVcsManager

iterateVcsRoot

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

Specified by:

iterateVcsRoot in class ProjectLevelVcsManager

getState

public Element getState()

Specified by:

getState in interface PersistentStateComponent<Element>

Returns:

a component state. All properties, public and annotated fields are serialized. Only values, which differ from the default (i.e., the value of newly instantiated class) are serialized. null value indicates that the returned state won't be stored, as a result previously stored state will be used.

See Also:

XmlSerializer

loadState

public void loadState(Element state)

Description copied from interface: PersistentStateComponent

This method is called when new component state is loaded. The method can and will be called several times, if config files were externally changed while IDE was running.

State object should be used directly, defensive copying is not required.

Specified by:

loadState in interface PersistentStateComponent<Element>

Parameters:

state - loaded component state

See Also:

XmlSerializerUtil.copyBean(Object, Object)

getStandardConfirmation

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

Specified by:

getStandardConfirmation in class ProjectLevelVcsManager

getAllConfirmations

public java.util.List<VcsShowConfirmationOptionImpl> getAllConfirmations()

Specified by:

getAllConfirmations in class ProjectLevelVcsManagerEx

getConfirmation

public VcsShowConfirmationOptionImpl getConfirmation(VcsConfiguration.StandardConfirmation option)

Specified by:

getConfirmation in class ProjectLevelVcsManagerEx

addVcsListener

public void addVcsListener(VcsListener listener)

Description copied from class: ProjectLevelVcsManager

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

Specified by:

addVcsListener in class ProjectLevelVcsManager

removeVcsListener

public void removeVcsListener(VcsListener listener)

Description copied from class: ProjectLevelVcsManager

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

Specified by:

removeVcsListener in class ProjectLevelVcsManager

startBackgroundVcsOperation

public void startBackgroundVcsOperation()

Description copied from class: ProjectLevelVcsManager

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

Specified by:

startBackgroundVcsOperation in class ProjectLevelVcsManager

stopBackgroundVcsOperation

public void stopBackgroundVcsOperation()

Description copied from class: ProjectLevelVcsManager

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

Specified by:

stopBackgroundVcsOperation in class ProjectLevelVcsManager

isBackgroundVcsOperationRunning

public boolean isBackgroundVcsOperationRunning()

Description copied from class: ProjectLevelVcsManager

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

Specified by:

isBackgroundVcsOperationRunning in class ProjectLevelVcsManager

getRootsUnderVcsWithoutFiltering

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

Specified by:

getRootsUnderVcsWithoutFiltering in class ProjectLevelVcsManager

getRootsUnderVcs

public VirtualFile [] getRootsUnderVcs(AbstractVcs vcs)

Specified by:

getRootsUnderVcs in class ProjectLevelVcsManager

getDetailedVcsMappings

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

Description copied from class: ProjectLevelVcsManager

Also includes into list all modules under roots

Specified by:

getDetailedVcsMappings in class ProjectLevelVcsManager

getAllVersionedRoots

public VirtualFile[] getAllVersionedRoots()

Specified by:

getAllVersionedRoots in class ProjectLevelVcsManager

getAllVcsRoots

public VcsRoot [] getAllVcsRoots()

Specified by:

getAllVcsRoots in class ProjectLevelVcsManager

notifyDirectoryMappingChanged

public void notifyDirectoryMappingChanged()

Specified by:

notifyDirectoryMappingChanged in class ProjectLevelVcsManagerEx

needAutodetectMappings

public boolean needAutodetectMappings()

Returns 'true' during initial project setup, ie:

• There are no explicitly configured mappings (setDirectoryMapping(java.lang.String, java.lang.String) vs setAutoDirectoryMappings(java.util.List<? extends com.intellij.openapi.vcs.VcsDirectoryMapping>))
• There are no mappings inherited from "Default Project" configuration (excluding <Project> mappings) (myMappingsLoaded
• Project was not reopened a second time (ATTRIBUTE_DEFAULT_PROJECT)

findVersioningVcs

public AbstractVcs findVersioningVcs(VirtualFile file)

Used to guess VCS for automatic mapping through a look into a working copy

Specified by:

findVersioningVcs in class ProjectLevelVcsManager

getRootChecker

public VcsRootChecker getRootChecker(AbstractVcs vcs)

Specified by:

getRootChecker in class ProjectLevelVcsManager

getCompositeCheckoutListener

public CheckoutProvider.Listener getCompositeCheckoutListener()

Specified by:

getCompositeCheckoutListener in class ProjectLevelVcsManager

fireDirectoryMappingsChanged

public void fireDirectoryMappingsChanged()

Specified by:

fireDirectoryMappingsChanged in class ProjectLevelVcsManagerEx

haveDefaultMapping

public java.lang.String haveDefaultMapping()

Specified by:

haveDefaultMapping in class ProjectLevelVcsManagerEx

Returns:

VCS name for default mapping, if any

getBackgroundableActionHandler

@Deprecated
public BackgroundableActionEnabledHandler getBackgroundableActionHandler(VcsBackgroundableActions action)

Deprecated. use BackgroundableActionLock

addInitializationRequest

public void addInitializationRequest(VcsInitObject vcsInitObject,
                                     java.lang.Runnable runnable)

isFileInContent

public boolean isFileInContent(VirtualFile vf)

Specified by:

isFileInContent in class ProjectLevelVcsManager

isIgnored

public boolean isIgnored(VirtualFile vf)

Specified by:

isIgnored in class ProjectLevelVcsManager

isIgnored

public boolean isIgnored(FilePath filePath)

Specified by:

isIgnored in class ProjectLevelVcsManager

getVcsHistoryCache

public VcsHistoryCache getVcsHistoryCache()

Specified by:

getVcsHistoryCache in class ProjectLevelVcsManager

getContentRevisionCache

public ContentRevisionCache getContentRevisionCache()

Specified by:

getContentRevisionCache in class ProjectLevelVcsManager

waitForInitialized

public void waitForInitialized()