Package com.intellij.vcsUtil

Class VcsUtil

java.lang.Object

com.intellij.vcsUtil.VcsUtil

public class VcsUtil
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MAX_VCS_LOADED_SIZE_KB
protected static char[]	ourCharsToBeChopped

Constructor Summary

Constructors

Constructor and Description
VcsUtil()

Method Summary

Modifier and Type	Method and Description
static java.util.List<VcsDirectoryMapping>	addMapping(java.util.List<? extends VcsDirectoryMapping> existingMappings, java.lang.String path, java.lang.String vcs)
static java.lang.String	chopTrailingChars(java.lang.String source, char[] chars)
static <T> T	computeWithModalProgress(Project project, java.lang.String title, boolean canBeCancelled, ThrowableConvertor<? super ProgressIndicator,T,? extends VcsException> computable)
static AbstractVcs	findVcs(AnActionEvent e)
static AbstractVcs	findVcsByKey(Project project, VcsKey key)
static java.lang.String	getCanonicalLocalPath(java.lang.String localPath)
static java.lang.String	getCanonicalPath(java.io.File file)
static java.lang.String	getCanonicalPath(java.lang.String path)
static byte []	getFileByteContent(java.io.File file)
static java.lang.String	getFileContent(java.lang.String path)
static FilePath	getFilePath(java.io.File file)
static FilePath	getFilePath(java.io.File file, boolean isDirectory)
static FilePath	getFilePath(java.lang.String path)
static FilePath	getFilePath(java.lang.String path, boolean isDirectory)
static FilePath	getFilePath(VirtualFile file)
static FilePath	getFilePath(VirtualFile parent, java.lang.String name)
static FilePath	getFilePath(VirtualFile parent, java.lang.String fileName, boolean isDirectory)
static FilePath	getFilePathForDeletedFile(java.lang.String path, boolean isDirectory) Deprecated. use getFilePath(String, boolean)
static FilePath	getFilePathOnNonLocal(java.lang.String path, boolean isDirectory)
static FilePath	getLastCommitPath(Project project, FilePath path)
static int	getMaxVcsLoadedFileSize()
static VirtualFile	getOneVirtualFile(AnActionEvent e)
static java.lang.String	getPathForProgressPresentation(java.io.File file)
static java.lang.String	getShortRevisionString(VcsRevisionNumber revision)
static AbstractVcs	getVcsFor(Project project, FilePath filePath)
static AbstractVcs	getVcsFor(Project project, VirtualFile file)
static java.util.Set<java.lang.String>	getVcsIgnoreFileNames(Project project)
static VirtualFile	getVcsRootFor(Project project, FilePath filePath)
static VirtualFile	getVcsRootFor(Project project, VirtualFile file)
static VirtualFile	getVirtualFile(java.io.File file)
static VirtualFile	getVirtualFile(java.lang.String path)
static VirtualFile []	getVirtualFiles(AnActionEvent e)
static VirtualFile	getVirtualFileWithRefresh(java.io.File file)
static <T> java.util.Map<VcsRoot,java.util.List<T>>	groupByRoots(Project project, java.util.Collection<? extends T> items, boolean putNonVcs, Function<? super T,? extends FilePath> filePathMapper)
static <T> java.util.Map<VcsRoot,java.util.List<T>>	groupByRoots(Project project, java.util.Collection<? extends T> items, Function<? super T,? extends FilePath> filePathMapper)
static boolean	isAspectAvailableByDefault(java.lang.String id)
static boolean	isAspectAvailableByDefault(java.lang.String id, boolean defaultValue)
static boolean	isChangeForDeleted(Change change)
static boolean	isChangeForFolder(Change change)
static boolean	isChangeForNew(Change change)
static boolean	isFileForVcs(FilePath path, Project project, AbstractVcs host)
static boolean	isFileForVcs(java.lang.String path, Project project, AbstractVcs host)
static boolean	isFileForVcs(VirtualFile file, Project project, AbstractVcs host) File is considered to be a valid vcs file if it resides under the content root controlled by the given vcs.
static boolean	isFileUnderVcs(Project project, FilePath file)
static boolean	isFileUnderVcs(Project project, java.lang.String file)
static boolean	isPathRemote(java.lang.String path)
static boolean	isRenameChange(Change change)
static void	markFileAsDirty(Project project, FilePath path) Deprecated. use the VcsDirtyScopeManager directly.
static void	markFileAsDirty(Project project, java.lang.String path)
static void	markFileAsDirty(Project project, VirtualFile file) Deprecated. use the VcsDirtyScopeManager directly.
static VirtualFile[]	paths2VFiles(java.lang.String[] paths)
static void	refreshFiles(Project project, java.util.HashSet<? extends FilePath> paths) Deprecated. use the VcsDirtyScopeManager directly.
static boolean	runVcsProcessWithProgress(VcsRunnable runnable, java.lang.String progressTitle, boolean canBeCanceled, Project project) Deprecated. Use ProgressManager.runProcessWithProgressSynchronously(ThrowableComputable, String, boolean, Project) and other run methods from the ProgressManager.
static void	setAspectAvailability(java.lang.String aspectID, boolean showByDefault)
static void	showStatusMessage(Project project, java.lang.String message) Deprecated. use StatusBar.Info#set(String, Project) directly.
static FilePath[]	sortPathsFromOutermost(FilePath[] files) Sort file paths so that paths under the same root are placed from the outermost to the innermost (farthest from the root).
static java.lang.String	trimCommitMessageToSaneSize(java.lang.String message)
static VirtualFile	waitForTheFile(java.lang.String path) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

ourCharsToBeChopped

protected static final char[] ourCharsToBeChopped

MAX_VCS_LOADED_SIZE_KB

public static final java.lang.String MAX_VCS_LOADED_SIZE_KB

See Also:

Constant Field Values

Constructor Detail

VcsUtil

public VcsUtil()

Method Detail

getMaxVcsLoadedFileSize

public static int getMaxVcsLoadedFileSize()

markFileAsDirty

@Deprecated
public static void markFileAsDirty(Project project,
                                   VirtualFile file)

Deprecated. use the VcsDirtyScopeManager directly.

markFileAsDirty

@Deprecated
public static void markFileAsDirty(Project project,
                                   FilePath path)

Deprecated. use the VcsDirtyScopeManager directly.

markFileAsDirty

public static void markFileAsDirty(Project project,
                                   java.lang.String path)

refreshFiles

@Deprecated
public static void refreshFiles(Project project,
                                java.util.HashSet<? extends FilePath> paths)

Deprecated. use the VcsDirtyScopeManager directly.

isFileUnderVcs

public static boolean isFileUnderVcs(Project project,
                                     java.lang.String file)

Parameters:

project - Project component

file - File to check

Returns:

true if the given file resides under the root associated with any

isFileUnderVcs

public static boolean isFileUnderVcs(Project project,
                                     FilePath file)

isFileForVcs

public static boolean isFileForVcs(VirtualFile file,
                                   Project project,
                                   AbstractVcs host)

File is considered to be a valid vcs file if it resides under the content root controlled by the given vcs.

isFileForVcs

public static boolean isFileForVcs(FilePath path,
                                   Project project,
                                   AbstractVcs host)

isFileForVcs

public static boolean isFileForVcs(java.lang.String path,
                                   Project project,
                                   AbstractVcs host)

getVcsFor

public static AbstractVcs getVcsFor(Project project,
                                    FilePath filePath)

getVcsFor

public static AbstractVcs getVcsFor(Project project,
                                    VirtualFile file)

findVcsByKey

public static AbstractVcs findVcsByKey(Project project,
                                       VcsKey key)

findVcs

public static AbstractVcs findVcs(AnActionEvent e)

getVcsRootFor

public static VirtualFile getVcsRootFor(Project project,
                                        FilePath filePath)

getVcsRootFor

public static VirtualFile getVcsRootFor(Project project,
                                        VirtualFile file)

getVirtualFile

public static VirtualFile getVirtualFile(java.lang.String path)

getVirtualFile

public static VirtualFile getVirtualFile(java.io.File file)

getVirtualFileWithRefresh

public static VirtualFile getVirtualFileWithRefresh(java.io.File file)

getFileContent

public static java.lang.String getFileContent(java.lang.String path)

getFileByteContent

public static byte [] getFileByteContent(java.io.File file)

getFilePath

public static FilePath getFilePath(java.lang.String path)

getFilePath

public static FilePath getFilePath(VirtualFile file)

getFilePath

public static FilePath getFilePath(java.io.File file)

getFilePath

public static FilePath getFilePath(java.lang.String path,
                                   boolean isDirectory)

getFilePathOnNonLocal

public static FilePath getFilePathOnNonLocal(java.lang.String path,
                                             boolean isDirectory)

getFilePath

public static FilePath getFilePath(java.io.File file,
                                   boolean isDirectory)

getFilePathForDeletedFile

@Deprecated
public static FilePath getFilePathForDeletedFile(java.lang.String path,
                                                 boolean isDirectory)

Deprecated. use getFilePath(String, boolean)

getFilePath

public static FilePath getFilePath(VirtualFile parent,
                                   java.lang.String name)

getFilePath

public static FilePath getFilePath(VirtualFile parent,
                                   java.lang.String fileName,
                                   boolean isDirectory)

showStatusMessage

@Deprecated
public static void showStatusMessage(Project project,
                                     java.lang.String message)

Deprecated. use StatusBar.Info#set(String, Project) directly.

isRenameChange

public static boolean isRenameChange(Change change)

Parameters:

change - "Change" description.

Returns:

Return true if the "Change" object is created for "Rename" operation: in this case name of files for "before" and "after" revisions must not coincide.

isChangeForNew

public static boolean isChangeForNew(Change change)

Parameters:

change - "Change" description.

Returns:

Return true if the "Change" object is created for "New" operation: "before" revision is obviously NULL, while "after" revision is not.

isChangeForDeleted

public static boolean isChangeForDeleted(Change change)

Parameters:

change - "Change" description.

Returns:

Return true if the "Change" object is created for "Delete" operation: "before" revision is NOT NULL, while "after" revision is NULL.

isChangeForFolder

public static boolean isChangeForFolder(Change change)

sortPathsFromOutermost

public static FilePath[] sortPathsFromOutermost(FilePath[] files)

Sort file paths so that paths under the same root are placed from the outermost to the innermost (farthest from the root).

Parameters:

files - An array of file paths to be sorted. Sorting is done over the parameter.

Returns:

Sorted array of the file paths.

getOneVirtualFile

public static VirtualFile getOneVirtualFile(AnActionEvent e)

Parameters:

e - ActionEvent object

Returns:

VirtualFile available in the current context. Returns not null if and only if exactly one file is available.

getVirtualFiles

public static VirtualFile [] getVirtualFiles(AnActionEvent e)

Parameters:

e - ActionEvent object

Returns:

VirtualFiles available in the current context. Returns empty array if there are no available files.

runVcsProcessWithProgress

@Deprecated
public static boolean runVcsProcessWithProgress(VcsRunnable runnable,
                                                java.lang.String progressTitle,
                                                boolean canBeCanceled,
                                                Project project)
                                         throws VcsException

Deprecated. Use ProgressManager.runProcessWithProgressSynchronously(ThrowableComputable, String, boolean, Project) and other run methods from the ProgressManager.

Throws:

VcsException

computeWithModalProgress

public static <T> T computeWithModalProgress(Project project,
                                             java.lang.String title,
                                             boolean canBeCancelled,
                                             ThrowableConvertor<? super ProgressIndicator,T,? extends VcsException> computable)
                                      throws VcsException

Throws:

VcsException

waitForTheFile

@Deprecated
public static VirtualFile waitForTheFile(java.lang.String path)

Deprecated.

getCanonicalLocalPath

public static java.lang.String getCanonicalLocalPath(java.lang.String localPath)

getCanonicalPath

public static java.lang.String getCanonicalPath(java.lang.String path)

getCanonicalPath

public static java.lang.String getCanonicalPath(java.io.File file)

chopTrailingChars

public static java.lang.String chopTrailingChars(java.lang.String source,
                                                 char[] chars)

Parameters:

source - Source string

chars - Symbols to be trimmed

Returns:

string without all specified chars at the end. For example, chopTrailingChars("c:\\my_directory\\//\\",new char[]{'\\'}) is "c:\\my_directory\\//", chopTrailingChars("c:\\my_directory\\//\\",new char[]{'\\','/'}) is "c:\my_directory". Actually this method can be used to normalize file names to chop trailing separator chars.

getShortRevisionString

public static java.lang.String getShortRevisionString(VcsRevisionNumber revision)

paths2VFiles

public static VirtualFile[] paths2VFiles(java.lang.String[] paths)

isAspectAvailableByDefault

public static boolean isAspectAvailableByDefault(java.lang.String id)

isAspectAvailableByDefault

public static boolean isAspectAvailableByDefault(java.lang.String id,
                                                 boolean defaultValue)

setAspectAvailability

public static void setAspectAvailability(java.lang.String aspectID,
                                         boolean showByDefault)

isPathRemote

public static boolean isPathRemote(java.lang.String path)

getPathForProgressPresentation

public static java.lang.String getPathForProgressPresentation(java.io.File file)

groupByRoots

public static <T> java.util.Map<VcsRoot,java.util.List<T>> groupByRoots(Project project,
                                                                        java.util.Collection<? extends T> items,
                                                                        Function<? super T,? extends FilePath> filePathMapper)

groupByRoots

public static <T> java.util.Map<VcsRoot,java.util.List<T>> groupByRoots(Project project,
                                                                        java.util.Collection<? extends T> items,
                                                                        boolean putNonVcs,
                                                                        Function<? super T,? extends FilePath> filePathMapper)

addMapping

public static java.util.List<VcsDirectoryMapping> addMapping(java.util.List<? extends VcsDirectoryMapping> existingMappings,
                                                             java.lang.String path,
                                                             java.lang.String vcs)

getLastCommitPath

public static FilePath getLastCommitPath(Project project,
                                         FilePath path)

getVcsIgnoreFileNames

public static java.util.Set<java.lang.String> getVcsIgnoreFileNames(Project project)

trimCommitMessageToSaneSize

public static java.lang.String trimCommitMessageToSaneSize(java.lang.String message)