Package com.intellij.openapi.vcs.actions

Interface VcsContextFactory

All Known Implementing Classes:

VcsContextFactoryImpl

public interface VcsContextFactory

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	VcsContextFactory.SERVICE

Method Summary

Modifier and Type	Method and Description
VcsContext	createCachedContextOn(AnActionEvent event)
VcsContext	createContextOn(AnActionEvent event)
FilePath	createFilePath(java.lang.String path, boolean isDirectory)
FilePath	createFilePath(VirtualFile parent, java.lang.String fileName, boolean isDirectory)
FilePath	createFilePathOn(java.io.File file) Creates a FilePath corresponding to the specified java.io.File.
FilePath	createFilePathOn(java.io.File file, boolean isDirectory) Creates a FilePath corresponding to the specified java.io.File.
FilePath	createFilePathOn(VirtualFile virtualFile) Creates a FilePath corresponding to the specified virtual file.
FilePath	createFilePathOn(VirtualFile parent, java.lang.String name) Creates a FilePath corresponding to a file with the specified name in the specified directory.
FilePath	createFilePathOnDeleted(java.io.File file, boolean isDirectory) Deprecated. use createFilePathOn(File, boolean)
FilePath	createFilePathOnNonLocal(java.lang.String path, boolean isDirectory) Creates a FilePath corresponding to the specified path in a VCS repository.
LocalChangeList	createLocalChangeList(Project project, java.lang.String name)

Method Detail

createCachedContextOn

VcsContext createCachedContextOn(AnActionEvent event)

createContextOn

VcsContext createContextOn(AnActionEvent event)

createFilePathOn

FilePath createFilePathOn(VirtualFile virtualFile)

Creates a FilePath corresponding to the specified virtual file.

Parameters:

virtualFile - the file for which the FilePath should be created.

Returns:

the FilePath instance.

createFilePathOn

FilePath createFilePathOn(java.io.File file)

Creates a FilePath corresponding to the specified java.io.File.

Parameters:

file - the file for which the FilePath should be created.

Returns:

the FilePath instance.

createFilePathOnDeleted

@Deprecated
FilePath createFilePathOnDeleted(java.io.File file,
                                 boolean isDirectory)

Deprecated. use createFilePathOn(File, boolean)

Creates a FilePath corresponding to the specified java.io.File. Assumes that the file does not exist in the filesystem and does not try to find the corresponding VirtualFile, which provides a performance benefit.

Parameters:

file - the file for which the FilePath should be created.

isDirectory - whether file specifies a file or a directory.

Returns:

the FilePath instance.

createFilePathOn

FilePath createFilePathOn(java.io.File file,
                          boolean isDirectory)

Creates a FilePath corresponding to the specified java.io.File. If the file does not exist, uses the value of the isDirectory parameter to determine if the file is a directory.

Parameters:

file - the file for which the FilePath should be created.

isDirectory - whether file specifies a file or a directory.

Returns:

the FilePath instance.

createFilePathOnNonLocal

FilePath createFilePathOnNonLocal(java.lang.String path,
                                  boolean isDirectory)

Creates a FilePath corresponding to the specified path in a VCS repository. Does not try to locate the file in the local filesystem.

Parameters:

path - the repository path for which the FilePath should be created.

isDirectory - whether file specifies a file or a directory.

Returns:

the FilePath instance.

createFilePathOn

FilePath createFilePathOn(VirtualFile parent,
                          java.lang.String name)

Creates a FilePath corresponding to a file with the specified name in the specified directory. Assumes that the file does not exist in the filesystem and does not try to find the corresponding VirtualFile, which provides a performance benefit.

Parameters:

parent - the containing directory for the file.

name - the name of the file.

Returns:

the FilePath instance.

createFilePath

FilePath createFilePath(VirtualFile parent,
                        java.lang.String fileName,
                        boolean isDirectory)

createLocalChangeList

LocalChangeList createLocalChangeList(Project project,
                                      java.lang.String name)

createFilePath

FilePath createFilePath(java.lang.String path,
                        boolean isDirectory)