Package com.intellij.openapi.vcs

Class RemoteFilePath

java.lang.Object

com.intellij.openapi.vcs.RemoteFilePath

All Implemented Interfaces:

FilePath

public class RemoteFilePath
extends java.lang.Object
implements FilePath

Constructor Summary

Constructors

Constructor and Description
RemoteFilePath(java.lang.String path, boolean isDirectory)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.nio.charset.Charset	getCharset()
java.nio.charset.Charset	getCharset(Project project)
Document	getDocument()
FileType	getFileType()
java.io.File	getIOFile()
java.lang.String	getName()
FilePath	getParentPath()
java.lang.String	getPath()
java.lang.String	getPresentableUrl()
VirtualFile	getVirtualFile()
VirtualFile	getVirtualFileParent()
void	hardRefresh()
int	hashCode()
boolean	isDirectory()
boolean	isNonLocal()
boolean	isUnder(FilePath parent, boolean strict) Check if the provided file is an ancestor of the current file.
void	refresh()

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteFilePath

public RemoteFilePath(java.lang.String path,
                      boolean isDirectory)

Method Detail

getVirtualFile

public VirtualFile getVirtualFile()

Specified by:

getVirtualFile in interface FilePath

Returns:

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

getVirtualFileParent

public VirtualFile getVirtualFileParent()

Specified by:

getVirtualFileParent in interface FilePath

Returns:

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

getIOFile

public java.io.File getIOFile()

Specified by:

getIOFile in interface FilePath

Returns:

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

See Also:

FilePath.isNonLocal()

getName

public java.lang.String getName()

Specified by:

getName in interface FilePath

Returns:

the file name (without directory component)

getPresentableUrl

public java.lang.String getPresentableUrl()

Specified by:

getPresentableUrl in interface FilePath

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

public Document getDocument()

Specified by:

getDocument in interface FilePath

getCharset

public java.nio.charset.Charset getCharset()

Specified by:

getCharset in interface FilePath

getCharset

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

Specified by:

getCharset in interface FilePath

Returns:

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

getFileType

public FileType getFileType()

Specified by:

getFileType in interface FilePath

Returns:

the type of the file.

refresh

public void refresh()

Specified by:

refresh in interface FilePath

hardRefresh

public void hardRefresh()

Specified by:

hardRefresh in interface FilePath

getPath

public java.lang.String getPath()

Specified by:

getPath in interface FilePath

Returns:

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

isDirectory

public boolean isDirectory()

Specified by:

isDirectory in interface FilePath

Returns:

true if the path represents the directory

isUnder

public boolean isUnder(FilePath parent,
                       boolean strict)

Description copied from interface: FilePath

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

Specified by:

isUnder in interface FilePath

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

public FilePath getParentPath()

Specified by:

getParentPath in interface FilePath

Returns:

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

isNonLocal

public boolean isNonLocal()

Specified by:

isNonLocal in interface FilePath

Returns:

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

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