Package com.intellij.openapi.vfs

Class VirtualFileManager

java.lang.Object

com.intellij.openapi.vfs.VirtualFileManager

All Implemented Interfaces:

ModificationTracker

Direct Known Subclasses:

VirtualFileManagerEx

public abstract class VirtualFileManager
extends java.lang.Object
implements ModificationTracker

Manages virtual file systems.

See Also:

VirtualFileSystem

Field Summary

Fields

Modifier and Type	Field and Description
static Topic<BulkFileListener>	VFS_CHANGES
static ModificationTracker	VFS_STRUCTURE_MODIFICATIONS

Fields inherited from interface com.intellij.openapi.util.ModificationTracker

EVER_CHANGED, NEVER_CHANGED

Constructor Summary

Constructors

Constructor and Description
VirtualFileManager()

Method Summary

Modifier and Type	Method and Description
abstract void	addAsyncFileListener(AsyncFileListener listener, Disposable parentDisposable) Consider using extension point vfs.asyncListener.
abstract void	addVirtualFileListener(VirtualFileListener listener) Deprecated. Use VFS_CHANGES message bus topic.
abstract void	addVirtualFileListener(VirtualFileListener listener, Disposable parentDisposable) Deprecated. Use VFS_CHANGES message bus topic.
abstract void	addVirtualFileManagerListener(VirtualFileManagerListener listener)
abstract void	addVirtualFileManagerListener(VirtualFileManagerListener listener, Disposable parentDisposable)
abstract long	asyncRefresh(java.lang.Runnable postAction) Refreshes the cached file systems information from the physical file systems asynchronously.
static java.lang.String	constructUrl(java.lang.String protocol, java.lang.String path) Constructs a URL by specified protocol and path.
static java.lang.String	extractPath(java.lang.String url) Extracts path from the given URL.
static java.lang.String	extractProtocol(java.lang.String url) Extracts protocol from the given URL.
VirtualFile	findFileById(int id)
abstract VirtualFile	findFileByUrl(java.lang.String url) Searches for a file specified by the given URL.
abstract VirtualFileSystem	getFileSystem(java.lang.String protocol) Gets VirtualFileSystem with the specified protocol.
static VirtualFileManager	getInstance() Gets the instance of VirtualFileManager.
abstract long	getModificationCount()
abstract long	getStructureModificationCount()
abstract java.lang.CharSequence	getVFileName(int nameId)
abstract void	notifyPropertyChanged(VirtualFile virtualFile, java.lang.String property, java.lang.Object oldValue, java.lang.Object newValue)
abstract VirtualFile	refreshAndFindFileByUrl(java.lang.String url) Refreshes only the part of the file system needed for searching the file by the given URL and finds file by the given URL.
abstract void	refreshWithoutFileWatcher(boolean asynchronous)
abstract void	removeVirtualFileListener(VirtualFileListener listener) Deprecated. Use VFS_CHANGES message bus topic.
abstract void	removeVirtualFileManagerListener(VirtualFileManagerListener listener)
abstract int	storeName(java.lang.String name)
abstract long	syncRefresh() Refreshes the cached file systems information from the physical file systems synchronously.

Methods inherited from class java.lang.Object

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

Field Detail

VFS_CHANGES

public static final Topic<BulkFileListener> VFS_CHANGES

VFS_STRUCTURE_MODIFICATIONS

public static final ModificationTracker VFS_STRUCTURE_MODIFICATIONS

Constructor Detail

VirtualFileManager

public VirtualFileManager()

Method Detail

getInstance

public static VirtualFileManager getInstance()

Gets the instance of VirtualFileManager.

Returns:

VirtualFileManager

getFileSystem

public abstract VirtualFileSystem getFileSystem(java.lang.String protocol)

Gets VirtualFileSystem with the specified protocol.

Parameters:

protocol - String representing the protocol

Returns:

VirtualFileSystem

See Also:

VirtualFileSystem.getProtocol()

syncRefresh

public abstract long syncRefresh()

Refreshes the cached file systems information from the physical file systems synchronously.

Note: this method should be only called within a write-action (see Application.runWriteAction(java.lang.Runnable))

Returns:

refresh session ID.

asyncRefresh

public abstract long asyncRefresh(java.lang.Runnable postAction)

Refreshes the cached file systems information from the physical file systems asynchronously. Launches specified action when refresh is finished.

Returns:

refresh session ID.

refreshWithoutFileWatcher

public abstract void refreshWithoutFileWatcher(boolean asynchronous)

findFileByUrl

public abstract VirtualFile findFileByUrl(java.lang.String url)

Searches for a file specified by the given URL.

Parameters:

url - the URL to find file by

Returns:

VirtualFile if the file was found, null otherwise

See Also:

VirtualFile.getUrl(), VirtualFileSystem.findFileByPath(java.lang.String), refreshAndFindFileByUrl(java.lang.String)

refreshAndFindFileByUrl

public abstract VirtualFile refreshAndFindFileByUrl(java.lang.String url)

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

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.

Parameters:

url - the URL

Returns:

VirtualFile if the file was found, null otherwise

See Also:

VirtualFileSystem.findFileByPath(java.lang.String), VirtualFileSystem.refreshAndFindFileByPath(java.lang.String)

addVirtualFileListener

@Deprecated
public abstract void addVirtualFileListener(VirtualFileListener listener)

Deprecated. Use VFS_CHANGES message bus topic.

addVirtualFileListener

@Deprecated
public abstract void addVirtualFileListener(VirtualFileListener listener,
                                            Disposable parentDisposable)

Deprecated. Use VFS_CHANGES message bus topic.

removeVirtualFileListener

@Deprecated
public abstract void removeVirtualFileListener(VirtualFileListener listener)

Deprecated. Use VFS_CHANGES message bus topic.

addAsyncFileListener

public abstract void addAsyncFileListener(AsyncFileListener listener,
                                          Disposable parentDisposable)

Consider using extension point vfs.asyncListener.

constructUrl

public static java.lang.String constructUrl(java.lang.String protocol,
                                            java.lang.String path)

Constructs a URL by specified protocol and path.

Parameters:

protocol - the protocol

path - the path

Returns:

URL

See Also:

VirtualFile.getUrl()

extractProtocol

public static java.lang.String extractProtocol(java.lang.String url)

Extracts protocol from the given URL. Protocol is a substring from the beginning of the URL till "://".

Parameters:

url - the URL

Returns:

protocol or null if there is no "://" in the URL

See Also:

VirtualFileSystem.getProtocol()

extractPath

public static java.lang.String extractPath(java.lang.String url)

Extracts path from the given URL. Path is a substring from "://" till the end of URL. If there is no "://" URL itself is returned.

Parameters:

url - the URL

Returns:

path

addVirtualFileManagerListener

public abstract void addVirtualFileManagerListener(VirtualFileManagerListener listener)

addVirtualFileManagerListener

public abstract void addVirtualFileManagerListener(VirtualFileManagerListener listener,
                                                   Disposable parentDisposable)

removeVirtualFileManagerListener

public abstract void removeVirtualFileManagerListener(VirtualFileManagerListener listener)

notifyPropertyChanged

public abstract void notifyPropertyChanged(VirtualFile virtualFile,
                                           java.lang.String property,
                                           java.lang.Object oldValue,
                                           java.lang.Object newValue)

getModificationCount

public abstract long getModificationCount()

Specified by:

getModificationCount in interface ModificationTracker

Returns:

a number that's incremented every time something changes in the VFS, i.e. file hierarchy, names, flags, attributes, contents. This only counts modifications done in current IDE session.

See Also:

getStructureModificationCount()

getStructureModificationCount

public abstract long getStructureModificationCount()

Returns:

a number that's incremented every time something changes in the VFS structure, i.e. file hierarchy or names. This only counts modifications done in current IDE session.

See Also:

getModificationCount()

findFileById

public VirtualFile findFileById(int id)

storeName

public abstract int storeName(java.lang.String name)

getVFileName

public abstract java.lang.CharSequence getVFileName(int nameId)