Package com.intellij.openapi.vcs

Interface FilePath

All Known Implementing Classes:

CvsFilePath, FilePathImpl, LocalFilePath, RemoteFilePath

public interface FilePath

Represents a path to a (possibly non-existing) file on disk or in a VCS repository.

Method Summary

Modifier and Type	Method and Description
java.nio.charset.Charset	getCharset()
java.nio.charset.Charset	getCharset(Project project)
Document	getDocument() Deprecated. to remove in IDEA 16. Use FileDocumentManager.getDocument(VirtualFile) directly.
FileType	getFileType()
java.io.File	getIOFile()
java.lang.String	getName()
FilePath	getParentPath()
@SystemIndependent java.lang.String	getPath()
java.lang.String	getPresentableUrl()
VirtualFile	getVirtualFile()
VirtualFile	getVirtualFileParent()
void	hardRefresh() Deprecated. to remove in IDEA 16. Use VirtualFileSystem.refreshAndFindFileByPath(java.lang.String) instead.
boolean	isDirectory()
boolean	isNonLocal()
boolean	isUnder(FilePath parent, boolean strict) Check if the provided file is an ancestor of the current file.
void	refresh() Deprecated. to remove in IDEA 16. Use VfsUtil.findFileByIoFile(java.io.File, boolean) or VirtualFileSystem.findFileByPath(java.lang.String) instead.

Method Detail

getVirtualFile

VirtualFile getVirtualFile()

Returns:

a virtual file that corresponds to this path, or null if the virtual file is no more valid.

getVirtualFileParent

VirtualFile getVirtualFileParent()

Returns:

the virtual file that corresponds to the parent file path, or null if the virtual file is no more valid.

getIOFile

java.io.File getIOFile()

Returns:

the File that corresponds to the path. The path might be non-existent or not local.

See Also:

isNonLocal()

getName

java.lang.String getName()

Returns:

the file name (without directory component)

getPresentableUrl

java.lang.String getPresentableUrl()

Returns:

the path to the file in the format suitable for displaying in the UI, e.g. for local file it is the path to this file with system separators.

getDocument

@Deprecated
Document getDocument()

Deprecated. to remove in IDEA 16. Use FileDocumentManager.getDocument(VirtualFile) directly.

getCharset

java.nio.charset.Charset getCharset()

getCharset

java.nio.charset.Charset getCharset(Project project)

Returns:

the character set, considering the project settings and the virtual file corresponding to this FilePath (if it exists).

getFileType

FileType getFileType()

Returns:

the type of the file.

refresh

@Deprecated
void refresh()

Deprecated. to remove in IDEA 16. Use VfsUtil.findFileByIoFile(java.io.File, boolean) or VirtualFileSystem.findFileByPath(java.lang.String) instead.

hardRefresh

@Deprecated
void hardRefresh()

Deprecated. to remove in IDEA 16. Use VirtualFileSystem.refreshAndFindFileByPath(java.lang.String) instead.

getPath

@SystemIndependent java.lang.String getPath()

Returns:

the path to the file represented by this file path in the system-independent format.

isDirectory

boolean isDirectory()

Returns:

true if the path represents the directory

isUnder

boolean isUnder(FilePath parent,
                boolean strict)

Check if the provided file is an ancestor of the current file.

Parameters:

parent - a possible parent

strict - if false, the method also returns true if files are equal

Returns:

true if this file is ancestor of the parent.

getParentPath

FilePath getParentPath()

Returns:

the parent path or null if there is no parent of this file.

isNonLocal

boolean isNonLocal()

Returns:

true if the path does not represents a file in the local file system