AbstractVcs (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.openapi.vcs.StartedActivated
- - com.intellij.openapi.vcs.AbstractVcs

Direct Known Subclasses:

CvsVcs2, GitVcs, HgVcs, MockAbstractVcs, SvnVcs
```
public abstract class AbstractVcs
extends StartedActivated
```
The base class for a version control system integrated with IDEA.

See Also:

ProjectLevelVcsManager

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AbstractVcs.RootsConvertor

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AbstractVcs.RootsConvertor`

Field Summary

Fields
Modifier and Type Field and Description

protected Project myProject

protected static java.lang.String ourIntegerPattern

Fields
Modifier and Type	Field and Description
`protected Project`	`myProject`
`protected static java.lang.String`	`ourIntegerPattern`

Constructor Summary

Constructors
Constructor and Description

AbstractVcs(Project project, java.lang.String name)

Constructors
Constructor and Description
`AbstractVcs(Project project, java.lang.String name)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`activate()`
`boolean`	`allowsNestedRoots()`
`boolean`	`allowsRemoteCalls(VirtualFile file)`
`boolean`	`areDirectoriesVersionedItems()`
`boolean`	`arePartialChangelistsSupported()`
`protected CheckinEnvironment`	`createCheckinEnvironment()` creates the object for performing checkin / commit / submit operations.
`VcsRootSettings`	`createEmptyVcsRootSettings()`
`protected static VcsKey`	`createKey(java.lang.String name)`
`protected RollbackEnvironment`	`createRollbackEnvironment()` Returns the interface for performing revert / rollback operations.
`protected UpdateEnvironment`	`createUpdateEnvironment()` Returns the interface for performing update/sync operations.
`protected void`	`deactivate()`
`void`	`enableIntegration()` This method is called when user invokes "Enable VCS Integration" and selects a particular VCS.
`boolean`	`equals(java.lang.Object o)`
`boolean`	`fileExistsInVcs(FilePath path)` Returns true if the specified file path represents a file which exists in the VCS repository (is neither unversioned nor scheduled for addition).
`static boolean`	`fileInVcsByFileStatus(Project project, FilePath path)`
`static boolean`	`fileInVcsByFileStatus(Project project, VirtualFile file)`
`boolean`	`fileIsUnderVcs(FilePath filePath)` Deprecated. Use `VcsRootChecker` instead.
`boolean`	`fileListenerIsSynchronous()`
`<S> java.util.List<S>`	`filterUniqueRoots(java.util.List<S> in, java.util.function.Function<? super S,? extends VirtualFile> convertor)` Deprecated.
`AnnotationProvider`	`getAnnotationProvider()`
`CachingCommittedChangesProvider`	`getCachingCommittedChangesProvider()`
`ChangeProvider`	`getChangeProvider()`
`CheckinEnvironment`	`getCheckinEnvironment()` Returns the interface for performing checkin / commit / submit operations.
`CheckoutProvider`	`getCheckoutProvider()`
`java.util.List<CommitExecutor>`	`getCommitExecutors()`
`CommittedChangesProvider`	`getCommittedChangesProvider()`
`abstract Configurable`	`getConfigurable()`
`VcsConfiguration`	`getConfiguration()`
`AbstractVcs.RootsConvertor`	`getCustomConvertor()`
`DiffProvider`	`getDiffProvider()`
`abstract java.lang.String`	`getDisplayName()` Returns the name of the VCS as it should be displayed in the UI.
`EditFileProvider`	`getEditFileProvider()` Returns the interface for performing check out / edit file operations.
`UpdateEnvironment`	`getIntegrateEnvironment()` Returns the interface for performing integrate operations (merging changes made in another branch of the project into the current working copy).
`VcsKey`	`getKeyInstanceMethod()`
`java.lang.String`	`getMenuItemText()`
`MergeProvider`	`getMergeProvider()` Returns the implementation of the merge provider which is used to load the revisions to be merged for a particular file.
`java.lang.String`	`getName()`
`VcsOutgoingChangesProvider<CommittedChangeList>`	`getOutgoingChangesProvider()`
`protected VcsOutgoingChangesProvider<CommittedChangeList>`	`getOutgoingProviderImpl()`
`Project`	`getProject()`
`FileStatus[]`	`getProvidedStatuses()`
`RemoteDifferenceStrategy`	`getRemoteDifferenceStrategy()`
`java.lang.String`	`getRevisionPattern()`
`RevisionSelector`	`getRevisionSelector()` Returns the interface for selecting file version numbers.
`RollbackEnvironment`	`getRollbackEnvironment()`
`UnnamedConfigurable`	`getRootConfigurable(VcsDirectoryMapping mapping)` Returns the configurable to be shown in the VCS directory mapping dialog which should be displayed for configuring VCS-specific settings for the specified root, or null if no such configuration is required.
`java.lang.String`	`getShortName()` Returns the short or abbreviated name of this VCS, which name can be used in those places in the UI where the space is limited.
`UpdateEnvironment`	`getStatusEnvironment()` Returns the interface for performing "check status" operations (operations which show the differences between the local working copy state and the latest server state).
`TransactionProvider`	`getTransactionProvider()`
`TreeDiffProvider`	`getTreeDiffProvider()`
`protected TreeDiffProvider`	`getTreeDiffProviderImpl()`
`VcsType`	`getType()`
`UpdateEnvironment`	`getUpdateEnvironment()`
`VcsHistoryProvider`	`getVcsBlockHistoryProvider()`
`VcsExceptionsHotFixer`	`getVcsExceptionsHotFixer()`
`VcsHistoryProvider`	`getVcsHistoryProvider()`
`int`	`hashCode()`
`boolean`	`isTrackingUnchangedContent()`
`boolean`	`isVcsBackgroundOperationsAllowed(VirtualFile root)` Can be temporarily forbidden, for instance, when authorization credentials are wrong - to don't repeat wrong credentials passing (in some cases it can produce user's account blocking)
`boolean`	`isVersionedDirectory(VirtualFile dir)` Deprecated. Use `VcsRootChecker` instead.
`CommittedChangeList`	`loadRevisions(VirtualFile vf, VcsRevisionNumber number)`
`void`	`loadSettings()`
`boolean`	`markExternalChangesAsUpToDate()`
`ThreeState`	`mayRemoveChangeList(LocalChangeList list, boolean explicitly)` Invoked when a changelist is deleted explicitly by user or implicitly (e.g.
`boolean`	`needsCaseSensitiveDirtyScope()`
`boolean`	`needsLegacyDefaultMappings()` This switch disables platform support for "default mapping" aka "<Project>".
`VcsRevisionNumber`	`parseRevisionNumber(java.lang.String revisionNumberString)`
`VcsRevisionNumber`	`parseRevisionNumber(java.lang.String revisionNumberString, FilePath path)` For some version controls (like Git) the revision parsing is dependent on the the specific repository instance since the the revision number returned from this method is later used for comparison information.
`void`	`setCheckinEnvironment(CheckinEnvironment checkinEnvironment)`
`void`	`setRollbackEnvironment(RollbackEnvironment rollbackEnvironment)`
`void`	`setUpdateEnvironment(UpdateEnvironment updateEnvironment)`
`void`	`setupEnvironments()`
`protected void`	`shutdown()`
`protected void`	`start()`
`java.lang.String`	`toString()`

Methods inherited from class com.intellij.openapi.vcs.StartedActivated
doActivate, doDeactivate, doShutdown, doStart

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ourIntegerPattern
```
protected static final java.lang.String ourIntegerPattern
```
    See Also:
    
    Constant Field Values
  - myProject
```
protected final Project myProject
```
- Constructor Detail
  - AbstractVcs
```
public AbstractVcs(Project project,
                   java.lang.String name)
```
- Method Detail
  - start
```
protected void start()
              throws VcsException
```
    Specified by:
    
    start in class StartedActivated
    
    Throws:
    
    VcsException
  - shutdown
```
protected void shutdown()
                 throws VcsException
```
    Specified by:
    
    shutdown in class StartedActivated
    
    Throws:
    
    VcsException
  - activate
```
protected void activate()
```
    Specified by:
    
    activate in class StartedActivated
  - deactivate
```
protected void deactivate()
```
    Specified by:
    
    deactivate in class StartedActivated
  - getName
```
public final java.lang.String getName()
```
  - getDisplayName
```
public abstract java.lang.String getDisplayName()
```
    Returns the name of the VCS as it should be displayed in the UI.
    
    See Also:
    
    getShortName()
  - getShortName
```
public java.lang.String getShortName()
```
    Returns the short or abbreviated name of this VCS, which name can be used in those places in the UI where the space is limited. (e.g. it can be "SVN" for Subversion or "Hg" for Mercurial).
    
    By default returns the same as getDisplayName().
  - getConfigurable
```
public abstract Configurable getConfigurable()
```
  - getTransactionProvider
```
public TransactionProvider getTransactionProvider()
```
  - getChangeProvider
```
public ChangeProvider getChangeProvider()
```
  - getConfiguration
```
public final VcsConfiguration getConfiguration()
```
  - getEditFileProvider
```
public EditFileProvider getEditFileProvider()
```
    Returns the interface for performing check out / edit file operations.
    
    Returns:
    
    the interface implementation, or null if none is provided.
  - markExternalChangesAsUpToDate
```
public boolean markExternalChangesAsUpToDate()
```
  - createCheckinEnvironment
```
protected CheckinEnvironment createCheckinEnvironment()
```
    creates the object for performing checkin / commit / submit operations.
  - getCheckinEnvironment
```
public CheckinEnvironment getCheckinEnvironment()
```
    Returns the interface for performing checkin / commit / submit operations.
    
    Returns:
    
    the checkin interface, or null if checkins are not supported by the VCS.
  - createRollbackEnvironment
```
protected RollbackEnvironment createRollbackEnvironment()
```
    Returns the interface for performing revert / rollback operations.
  - getRollbackEnvironment
```
public RollbackEnvironment getRollbackEnvironment()
```
    Returns:
    
    the rollback interface, or null if rollbacks are not supported by the VCS.
  - getVcsHistoryProvider
```
public VcsHistoryProvider getVcsHistoryProvider()
```
  - getVcsBlockHistoryProvider
```
public VcsHistoryProvider getVcsBlockHistoryProvider()
```
  - getMenuItemText
```
public java.lang.String getMenuItemText()
```
  - createUpdateEnvironment
```
protected UpdateEnvironment createUpdateEnvironment()
```
    Returns the interface for performing update/sync operations.
  - getUpdateEnvironment
```
public UpdateEnvironment getUpdateEnvironment()
```
    Returns:
    
    the update interface, or null if the updates are not supported by the VCS.
  - fileIsUnderVcs
```
@Deprecated
public boolean fileIsUnderVcs(FilePath filePath)
```
    Deprecated. Use VcsRootChecker instead.
    
    Returns true if the specified file path is located under a directory which is managed by this VCS. This method is called only for directories which are mapped to this VCS in the project configuration.
    
    Parameters:
    
    filePath - the path to check.
    
    Returns:
    
    true if the path is managed by this VCS, false otherwise.
  - fileExistsInVcs
```
public boolean fileExistsInVcs(FilePath path)
```
    Returns true if the specified file path represents a file which exists in the VCS repository (is neither unversioned nor scheduled for addition). This method is called only for directories which are mapped to this VCS in the project configuration.
    
    Parameters:
    
    path - the path to check.
    
    Returns:
    
    true if the corresponding file exists in the repository, false otherwise.
  - enableIntegration
```
public void enableIntegration()
```
    This method is called when user invokes "Enable VCS Integration" and selects a particular VCS. By default it sets up a single mapping <Project> -> selected VCS.
  - mayRemoveChangeList
```
public ThreeState mayRemoveChangeList(LocalChangeList list,
                                      boolean explicitly)
```
    Invoked when a changelist is deleted explicitly by user or implicitly (e.g. after default changelist switch when the previous one was empty).
    
    Parameters:
    
    list - change list that's about to be removed
    
    explicitly - whether it's a result of explicit Delete action, or just after switching the active changelist.
    
    Returns:
    
    UNSURE if the VCS has nothing to say about this changelist. YES or NO if the changelist has to be removed or not, and no further confirmations are needed about this changelist (in particular, the VCS can show a confirmation to the user by itself)
  - isTrackingUnchangedContent
```
public boolean isTrackingUnchangedContent()
```
  - fileInVcsByFileStatus
```
public static boolean fileInVcsByFileStatus(Project project,
                                            FilePath path)
```
  - fileInVcsByFileStatus
```
public static boolean fileInVcsByFileStatus(Project project,
                                            VirtualFile file)
```
  - getStatusEnvironment
```
public UpdateEnvironment getStatusEnvironment()
```
    Returns the interface for performing "check status" operations (operations which show the differences between the local working copy state and the latest server state).
    
    Returns:
    
    the status interface, or null if the check status operation is not supported or required by the VCS.
  - getAnnotationProvider
```
public AnnotationProvider getAnnotationProvider()
```
  - getDiffProvider
```
public DiffProvider getDiffProvider()
```
  - loadSettings
```
public void loadSettings()
```
  - getProvidedStatuses
```
public FileStatus[] getProvidedStatuses()
```
  - getRevisionSelector
```
public RevisionSelector getRevisionSelector()
```
    Returns the interface for selecting file version numbers.
    
    Returns:
    
    the revision selector implementation, or null if none is provided.
  - getIntegrateEnvironment
```
public UpdateEnvironment getIntegrateEnvironment()
```
    Returns the interface for performing integrate operations (merging changes made in another branch of the project into the current working copy).
    
    Returns:
    
    the update interface, or null if the integrate operations are not supported by the VCS.
  - getCommittedChangesProvider
```
public CommittedChangesProvider getCommittedChangesProvider()
```
  - getCachingCommittedChangesProvider
```
public final CachingCommittedChangesProvider getCachingCommittedChangesProvider()
```
  - parseRevisionNumber
```
public VcsRevisionNumber parseRevisionNumber(java.lang.String revisionNumberString,
                                             FilePath path)
                                      throws VcsException
```
    For some version controls (like Git) the revision parsing is dependent on the the specific repository instance since the the revision number returned from this method is later used for comparison information. By default, this method invokes parseRevisionNumber(String). The client code should invoke this method, if it expect ordering information from revision numbers.
    
    Parameters:
    
    revisionNumberString - the string to be parsed
    
    path - the path for which revision number is queried
    
    Returns:
    
    the parsed revision number
    
    Throws:
    
    VcsException
  - parseRevisionNumber
```
public VcsRevisionNumber parseRevisionNumber(java.lang.String revisionNumberString)
                                      throws VcsException
```
    Throws:
    
    VcsException
  - getRevisionPattern
```
public java.lang.String getRevisionPattern()
```
    Returns:
    
    null if does not support revision parsing
  - isVersionedDirectory
```
@Deprecated
public boolean isVersionedDirectory(VirtualFile dir)
```
    Deprecated. Use VcsRootChecker instead.
    
    Checks if the specified directory is managed by this version control system (regardless of the project VCS configuration). For example, for CVS this checks the presense of "CVS" admin directories. This method is used for VCS autodetection during initial project creation and VCS configuration.
    
    Parameters:
    
    dir - the directory to check.
    
    Returns:
    
    true if directory is managed by this VCS
  - getRootConfigurable
```
public UnnamedConfigurable getRootConfigurable(VcsDirectoryMapping mapping)
```
    Returns the configurable to be shown in the VCS directory mapping dialog which should be displayed for configuring VCS-specific settings for the specified root, or null if no such configuration is required. The VCS-specific settings are stored in VcsDirectoryMapping.getRootSettings().
    
    Parameters:
    
    mapping - the mapping being configured
    
    Returns:
    
    the configurable instance, or null if no configuration is required.
  - createEmptyVcsRootSettings
```
public VcsRootSettings createEmptyVcsRootSettings()
```
  - getCustomConvertor
```
public AbstractVcs.RootsConvertor getCustomConvertor()
```
  - needsLegacyDefaultMappings
```
public boolean needsLegacyDefaultMappings()
```
    This switch disables platform support for "default mapping" aka "<Project>".
    If enabled, platform will do nothing. All roots from DefaultVcsRootPolicy will be registered as vcs root. Vcs can try using AbstractVcs.RootsConvertor to process roots itself.
    If disabled, platform will use VcsRootChecker or VcsEP.administrativeAreaName to find actual vcs roots. If vcs does not implement these EP, no vcs roots will be registered for "default mapping".
    
    See Also:
    
    ProjectLevelVcsManager, NewMappings
  - getMergeProvider
```
public MergeProvider getMergeProvider()
```
    Returns the implementation of the merge provider which is used to load the revisions to be merged for a particular file.
    
    Returns:
    
    the merge provider implementation, or null if the VCS doesn't support merge operations.
  - allowsNestedRoots
```
public boolean allowsNestedRoots()
```
  - filterUniqueRoots
```
@Deprecated
public <S> java.util.List<S> filterUniqueRoots(java.util.List<S> in,
                                               java.util.function.Function<? super S,? extends VirtualFile> convertor)
```
    Deprecated.
  - getVcsExceptionsHotFixer
```
public VcsExceptionsHotFixer getVcsExceptionsHotFixer()
```
  - getProject
```
public Project getProject()
```
  - createKey
```
protected static VcsKey createKey(java.lang.String name)
```
  - getKeyInstanceMethod
```
public final VcsKey getKeyInstanceMethod()
```
  - getType
```
public VcsType getType()
```
  - getOutgoingProviderImpl
```
protected VcsOutgoingChangesProvider<CommittedChangeList> getOutgoingProviderImpl()
```
  - getOutgoingChangesProvider
```
public final VcsOutgoingChangesProvider<CommittedChangeList> getOutgoingChangesProvider()
```
  - getRemoteDifferenceStrategy
```
public RemoteDifferenceStrategy getRemoteDifferenceStrategy()
```
  - areDirectoriesVersionedItems
```
public boolean areDirectoriesVersionedItems()
```
  - getTreeDiffProviderImpl
```
protected TreeDiffProvider getTreeDiffProviderImpl()
```
  - getTreeDiffProvider
```
public TreeDiffProvider getTreeDiffProvider()
```
  - getCommitExecutors
```
public java.util.List<CommitExecutor> getCommitExecutors()
```
  - isVcsBackgroundOperationsAllowed
```
public boolean isVcsBackgroundOperationsAllowed(VirtualFile root)
```
    Can be temporarily forbidden, for instance, when authorization credentials are wrong - to don't repeat wrong credentials passing (in some cases it can produce user's account blocking)
  - allowsRemoteCalls
```
public boolean allowsRemoteCalls(VirtualFile file)
```
  - setCheckinEnvironment
```
public void setCheckinEnvironment(CheckinEnvironment checkinEnvironment)
```
  - setUpdateEnvironment
```
public void setUpdateEnvironment(UpdateEnvironment updateEnvironment)
```
  - setRollbackEnvironment
```
public void setRollbackEnvironment(RollbackEnvironment rollbackEnvironment)
```
  - setupEnvironments
```
public void setupEnvironments()
```
  - loadRevisions
```
public CommittedChangeList loadRevisions(VirtualFile vf,
                                         VcsRevisionNumber number)
```
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - fileListenerIsSynchronous
```
public boolean fileListenerIsSynchronous()
```
  - arePartialChangelistsSupported
```
public boolean arePartialChangelistsSupported()
```
  - getCheckoutProvider
```
public CheckoutProvider getCheckoutProvider()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - needsCaseSensitiveDirtyScope
```
public boolean needsCaseSensitiveDirtyScope()
```

Class AbstractVcs

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

ourIntegerPattern

myProject

Constructor Detail

AbstractVcs

Method Detail

start

shutdown

activate

deactivate

getName

getDisplayName

getShortName

getConfigurable

getTransactionProvider

getChangeProvider

getConfiguration

getEditFileProvider

markExternalChangesAsUpToDate

createCheckinEnvironment

getCheckinEnvironment

createRollbackEnvironment

getRollbackEnvironment

getVcsHistoryProvider

getVcsBlockHistoryProvider

getMenuItemText

createUpdateEnvironment

getUpdateEnvironment

fileIsUnderVcs

fileExistsInVcs

enableIntegration

mayRemoveChangeList

isTrackingUnchangedContent

fileInVcsByFileStatus

fileInVcsByFileStatus

getStatusEnvironment

getAnnotationProvider

getDiffProvider

loadSettings

getProvidedStatuses

getRevisionSelector

getIntegrateEnvironment

getCommittedChangesProvider

getCachingCommittedChangesProvider

parseRevisionNumber

parseRevisionNumber

getRevisionPattern

isVersionedDirectory

getRootConfigurable

createEmptyVcsRootSettings

getCustomConvertor

needsLegacyDefaultMappings

getMergeProvider

allowsNestedRoots

filterUniqueRoots

getVcsExceptionsHotFixer

getProject

createKey

getKeyInstanceMethod

getType

getOutgoingProviderImpl

getOutgoingChangesProvider

getRemoteDifferenceStrategy

areDirectoriesVersionedItems

getTreeDiffProviderImpl

getTreeDiffProvider

getCommitExecutors

isVcsBackgroundOperationsAllowed

allowsRemoteCalls

setCheckinEnvironment

setUpdateEnvironment

setRollbackEnvironment

setupEnvironments