Package com.intellij.openapi.vfs

Class VirtualFileSystem

java.lang.Object

com.intellij.openapi.vfs.VirtualFileSystem

Direct Known Subclasses:

DeprecatedVirtualFileSystem, LazyAttachVirtualFS, NewVirtualFileSystem

public abstract class VirtualFileSystem
extends java.lang.Object

Represents a Virtual File System (VFS).

See Virtual File System (SDK docs).

See Also:

VirtualFile, VirtualFileManager

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VirtualFileSystem()

Method Summary

Modifier and Type	Method and Description
abstract void	addVirtualFileListener(VirtualFileListener listener) Adds listener to the file system.
protected abstract VirtualFile	copyFile(java.lang.Object requestor, VirtualFile virtualFile, VirtualFile newParent, java.lang.String copyName) Implementation of copying files in this file system
protected abstract VirtualFile	createChildDirectory(java.lang.Object requestor, VirtualFile vDir, java.lang.String dirName) Implementation of adding directories in this file system
protected abstract VirtualFile	createChildFile(java.lang.Object requestor, VirtualFile vDir, java.lang.String fileName) Implementation of adding files in this file system
protected abstract void	deleteFile(java.lang.Object requestor, VirtualFile vFile) Implementation of deleting files in this file system
java.lang.String	extractPresentableUrl(java.lang.String path) Fetches presentable URL of file with the given path in this file system.
abstract VirtualFile	findFileByPath(java.lang.String path) Searches for the file specified by given path.
abstract java.lang.String	getProtocol() Gets the protocol for this file system.
boolean	isCaseSensitive()
abstract boolean	isReadOnly()
boolean	isValidName(java.lang.String name)
protected abstract void	moveFile(java.lang.Object requestor, VirtualFile vFile, VirtualFile newParent) Implementation of moving files in this file system
abstract void	refresh(boolean asynchronous) Refreshes the cached information for all files in this file system from the physical file system.
abstract VirtualFile	refreshAndFindFileByPath(java.lang.String path) Refreshes only the part of the file system needed for searching the file by the given path and finds file by the given path. This method is useful when the file was created externally and you need to find VirtualFile corresponding to it.
abstract void	removeVirtualFileListener(VirtualFileListener listener) Removes listener form the file system.
protected abstract void	renameFile(java.lang.Object requestor, VirtualFile vFile, java.lang.String newName) Implementation of renaming files in this file system

Methods inherited from class java.lang.Object

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

Constructor Detail

VirtualFileSystem

protected VirtualFileSystem()

Method Detail

getProtocol

public abstract java.lang.String getProtocol()

Gets the protocol for this file system. Protocols should differ for all file systems. Should be the same as corresponding KeyedLazyInstanceEP.key.

Returns:

String representing the protocol

See Also:

VirtualFile.getUrl(), VirtualFileManager.getFileSystem(java.lang.String)

findFileByPath

public abstract VirtualFile findFileByPath(java.lang.String path)

Searches for the file specified by given path. Path is a string which uniquely identifies file within given VirtualFileSystem. Format of the path depends on the concrete file system. For LocalFileSystem it is an absolute path (both Unix- and Windows-style separator chars are allowed).

Parameters:

path - the path to find file by

Returns:

a virtual file if found, null otherwise

extractPresentableUrl

public java.lang.String extractPresentableUrl(java.lang.String path)

Fetches presentable URL of file with the given path in this file system.

Parameters:

path - the path to get presentable URL for

Returns:

presentable URL

See Also:

VirtualFile.getPresentableUrl()

refresh

public abstract void refresh(boolean asynchronous)

Refreshes the cached information for all files in this file system from the physical file system.

If asynchronous is false this method should be only called within write-action. See Application.runWriteAction(java.lang.Runnable).

Parameters:

asynchronous - if true then the operation will be performed in a separate thread, otherwise will be performed immediately

See Also:

VirtualFile.refresh(boolean, boolean), VirtualFileManager.syncRefresh(), VirtualFileManager.asyncRefresh(java.lang.Runnable)

refreshAndFindFileByPath

public abstract VirtualFile refreshAndFindFileByPath(java.lang.String path)

Refreshes only the part of the file system needed for searching the file by the given path and finds file by the given path.

This method is useful when the file was created externally and you need to find VirtualFile corresponding to it.

If this method is invoked not from Swing event dispatch thread, then it must not happen inside a read action. The reason is that then the method call won't return until proper VFS events are fired, which happens on Swing thread and in write action. So invoking this method in a read action would result in a deadlock.

Parameters:

path - the path

Returns:

VirtualFile if the file was found, null otherwise

addVirtualFileListener

public abstract void addVirtualFileListener(VirtualFileListener listener)

Adds listener to the file system. Normally one should use VirtualFileManager.VFS_CHANGES message bus topic.

Parameters:

listener - the listener

See Also:

VirtualFileListener, VirtualFileManager.VFS_CHANGES

removeVirtualFileListener

public abstract void removeVirtualFileListener(VirtualFileListener listener)

Removes listener form the file system.

Parameters:

listener - the listener

deleteFile

protected abstract void deleteFile(java.lang.Object requestor,
                                   VirtualFile vFile)
                            throws java.io.IOException

Implementation of deleting files in this file system

Throws:

java.io.IOException

See Also:

VirtualFile.delete(Object)

moveFile

protected abstract void moveFile(java.lang.Object requestor,
                                 VirtualFile vFile,
                                 VirtualFile newParent)
                          throws java.io.IOException

Implementation of moving files in this file system

Throws:

java.io.IOException

See Also:

VirtualFile.move(Object,VirtualFile)

renameFile

protected abstract void renameFile(java.lang.Object requestor,
                                   VirtualFile vFile,
                                   java.lang.String newName)
                            throws java.io.IOException

Implementation of renaming files in this file system

Throws:

java.io.IOException

See Also:

VirtualFile.rename(Object,String)

createChildFile

protected abstract VirtualFile createChildFile(java.lang.Object requestor,
                                               VirtualFile vDir,
                                               java.lang.String fileName)
                                        throws java.io.IOException

Implementation of adding files in this file system

Throws:

java.io.IOException

See Also:

VirtualFile.createChildData(Object,String)

createChildDirectory

protected abstract VirtualFile createChildDirectory(java.lang.Object requestor,
                                                    VirtualFile vDir,
                                                    java.lang.String dirName)
                                             throws java.io.IOException

Implementation of adding directories in this file system

Throws:

java.io.IOException

See Also:

VirtualFile.createChildDirectory(Object,String)

copyFile

protected abstract VirtualFile copyFile(java.lang.Object requestor,
                                        VirtualFile virtualFile,
                                        VirtualFile newParent,
                                        java.lang.String copyName)
                                 throws java.io.IOException

Implementation of copying files in this file system

Throws:

java.io.IOException

See Also:

VirtualFile.copy(Object,VirtualFile,String)

isReadOnly

public abstract boolean isReadOnly()

isCaseSensitive

public boolean isCaseSensitive()

isValidName

public boolean isValidName(java.lang.String name)