Package com.intellij.openapi.vcs

Class VcsRootChecker

java.lang.Object

com.intellij.openapi.vcs.VcsRootChecker

Direct Known Subclasses:

DefaultVcsRootChecker, GitRootChecker, HgRootChecker

public abstract class VcsRootChecker
extends java.lang.Object

Provides methods to check if the given directory is a root of the given VCS. This is used e.g. by the VcsRootDetector to detect invalid roots (registered in the settings, but not related to real VCS roots on disk) and unregistered roots (real roots on disk not registered in the settings).

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<VcsRootChecker>	EXTENSION_POINT_NAME

Constructor Summary

Constructors

Constructor and Description
VcsRootChecker()

Method Summary

Modifier and Type	Method and Description
boolean	areChildrenValidMappings()
abstract VcsKey	getSupportedVcs() Returns the VCS supported by this checker.
boolean	isIgnored(VirtualFile root, VirtualFile checkForIgnore) Check if the given directory is ignored in the given VCS root.
boolean	isRoot(java.lang.String path) Checks if the given path represents a root of the supported VCS.
boolean	isVcsDir(java.lang.String dirName) Checks if the given directory looks like a VCS special directory, e.g.
boolean	validateRoot(java.lang.String path) Checks if registered mapping can be used to perform VCS operations.

Methods inherited from class java.lang.Object

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

Field Detail

EXTENSION_POINT_NAME

public static final ExtensionPointName<VcsRootChecker> EXTENSION_POINT_NAME

Constructor Detail

VcsRootChecker

public VcsRootChecker()

Method Detail

isRoot

public boolean isRoot(java.lang.String path)

Checks if the given path represents a root of the supported VCS.

validateRoot

public boolean validateRoot(java.lang.String path)

Checks if registered mapping can be used to perform VCS operations. The difference with isRoot(java.lang.String) is that this method should return true if unsure.

getSupportedVcs

public abstract VcsKey getSupportedVcs()

Returns the VCS supported by this checker.

isVcsDir

public boolean isVcsDir(java.lang.String dirName)

Checks if the given directory looks like a VCS special directory, e.g. ".git".

This is a quick rough check. A more precise is done in isRoot(String).

isIgnored

public boolean isIgnored(VirtualFile root,
                         VirtualFile checkForIgnore)

Check if the given directory is ignored in the given VCS root. Such situation can happen, when we detect a VCS root above the directory: in that case we should detect the root only if the directory is not ignored from that root (e.g. the root is the home directory, and the VCS is used for storing configs, ignoring everything else).

areChildrenValidMappings

public boolean areChildrenValidMappings()

Returns:

Whether any descendant of VCS root can be registered as valid VCS mapping.