Package com.intellij.openapi.vfs.impl

Class VirtualFileManagerImpl

java.lang.Object

com.intellij.openapi.vfs.VirtualFileManager

com.intellij.openapi.vfs.ex.VirtualFileManagerEx

com.intellij.openapi.vfs.impl.VirtualFileManagerImpl

All Implemented Interfaces:

Disposable, ModificationTracker

Direct Known Subclasses:

PlatformVirtualFileManager

public class VirtualFileManagerImpl
extends VirtualFileManagerEx
implements Disposable

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOG

Fields inherited from class com.intellij.openapi.vfs.VirtualFileManager

VFS_CHANGES, VFS_STRUCTURE_MODIFICATIONS

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

EVER_CHANGED, NEVER_CHANGED

Constructor Summary

Constructors

Constructor and Description
VirtualFileManagerImpl(java.util.List<? extends VirtualFileSystem> preCreatedFileSystems)
VirtualFileManagerImpl(java.util.List<? extends VirtualFileSystem> preCreatedFileSystems, MessageBus bus)

Method Summary

Modifier and Type	Method and Description
void	addAsyncFileListener(AsyncFileListener listener, Disposable parentDisposable) Consider using extension point vfs.asyncListener.
void	addVirtualFileListener(VirtualFileListener listener)
void	addVirtualFileListener(VirtualFileListener listener, Disposable parentDisposable)
void	addVirtualFileManagerListener(VirtualFileManagerListener listener)
void	addVirtualFileManagerListener(VirtualFileManagerListener listener, Disposable parentDisposable)
long	asyncRefresh(java.lang.Runnable postAction) Refreshes the cached file systems information from the physical file systems asynchronously.
void	dispose() Usually not invoked directly, see class javadoc.
protected long	doRefresh(boolean asynchronous, java.lang.Runnable postAction)
VirtualFile	findFileByUrl(java.lang.String url) Searches for a file specified by the given URL.
void	fireAfterRefreshFinish(boolean asynchronous)
void	fireBeforeRefreshStart(boolean asynchronous)
java.util.List<AsyncFileListener>	getAsyncFileListeners()
VirtualFileSystem	getFileSystem(java.lang.String protocol) Gets VirtualFileSystem with the specified protocol.
long	getModificationCount()
java.util.List<VirtualFileSystem>	getPhysicalFileSystems()
long	getStructureModificationCount()
java.lang.CharSequence	getVFileName(int nameId)
void	notifyPropertyChanged(VirtualFile virtualFile, java.lang.String property, java.lang.Object oldValue, java.lang.Object newValue)
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.
void	refreshWithoutFileWatcher(boolean asynchronous)
void	removeVirtualFileListener(VirtualFileListener listener)
void	removeVirtualFileManagerListener(VirtualFileManagerListener listener)
int	storeName(java.lang.String name)
long	syncRefresh() Refreshes the cached file systems information from the physical file systems synchronously.

Methods inherited from class com.intellij.openapi.vfs.VirtualFileManager

constructUrl, extractPath, extractProtocol, findFileById, getInstance

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Logger LOG

Constructor Detail

VirtualFileManagerImpl

public VirtualFileManagerImpl(java.util.List<? extends VirtualFileSystem> preCreatedFileSystems)

VirtualFileManagerImpl

public VirtualFileManagerImpl(java.util.List<? extends VirtualFileSystem> preCreatedFileSystems,
                              MessageBus bus)

Method Detail

getPhysicalFileSystems

public java.util.List<VirtualFileSystem> getPhysicalFileSystems()

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

getStructureModificationCount

public long getStructureModificationCount()

Specified by:

getStructureModificationCount in class VirtualFileManager

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:

VirtualFileManager.getModificationCount()

getFileSystem

public VirtualFileSystem getFileSystem(java.lang.String protocol)

Description copied from class: VirtualFileManager

Gets VirtualFileSystem with the specified protocol.

Specified by:

getFileSystem in class VirtualFileManager

Parameters:

protocol - String representing the protocol

Returns:

VirtualFileSystem

See Also:

VirtualFileSystem.getProtocol()

syncRefresh

public long syncRefresh()

Description copied from class: VirtualFileManager

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))

Specified by:

syncRefresh in class VirtualFileManager

Returns:

refresh session ID.

asyncRefresh

public long asyncRefresh(java.lang.Runnable postAction)

Description copied from class: VirtualFileManager

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

Specified by:

asyncRefresh in class VirtualFileManager

Returns:

refresh session ID.

doRefresh

protected long doRefresh(boolean asynchronous,
                         java.lang.Runnable postAction)

refreshWithoutFileWatcher

public void refreshWithoutFileWatcher(boolean asynchronous)

Specified by:

refreshWithoutFileWatcher in class VirtualFileManager

findFileByUrl

public VirtualFile findFileByUrl(java.lang.String url)

Description copied from class: VirtualFileManager

Searches for a file specified by the given URL.

Specified by:

findFileByUrl in class VirtualFileManager

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), VirtualFileManager.refreshAndFindFileByUrl(java.lang.String)

refreshAndFindFileByUrl

public VirtualFile refreshAndFindFileByUrl(java.lang.String url)

Description copied from class: VirtualFileManager

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.

Specified by:

refreshAndFindFileByUrl in class VirtualFileManager

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

public void addVirtualFileListener(VirtualFileListener listener)

Specified by:

addVirtualFileListener in class VirtualFileManager

addVirtualFileListener

public void addVirtualFileListener(VirtualFileListener listener,
                                   Disposable parentDisposable)

Specified by:

addVirtualFileListener in class VirtualFileManager

removeVirtualFileListener

public void removeVirtualFileListener(VirtualFileListener listener)

Specified by:

removeVirtualFileListener in class VirtualFileManager

addVirtualFileManagerListener

public void addVirtualFileManagerListener(VirtualFileManagerListener listener)

Specified by:

addVirtualFileManagerListener in class VirtualFileManager

addVirtualFileManagerListener

public void addVirtualFileManagerListener(VirtualFileManagerListener listener,
                                          Disposable parentDisposable)

Specified by:

addVirtualFileManagerListener in class VirtualFileManager

removeVirtualFileManagerListener

public void removeVirtualFileManagerListener(VirtualFileManagerListener listener)

Specified by:

removeVirtualFileManagerListener in class VirtualFileManager

addAsyncFileListener

public void addAsyncFileListener(AsyncFileListener listener,
                                 Disposable parentDisposable)

Description copied from class: VirtualFileManager

Consider using extension point vfs.asyncListener.

Specified by:

addAsyncFileListener in class VirtualFileManager

getAsyncFileListeners

public java.util.List<AsyncFileListener> getAsyncFileListeners()

notifyPropertyChanged

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

Specified by:

notifyPropertyChanged in class VirtualFileManager

fireBeforeRefreshStart

public void fireBeforeRefreshStart(boolean asynchronous)

Specified by:

fireBeforeRefreshStart in class VirtualFileManagerEx

fireAfterRefreshFinish

public void fireAfterRefreshFinish(boolean asynchronous)

Specified by:

fireAfterRefreshFinish in class VirtualFileManagerEx

getModificationCount

public long getModificationCount()

Specified by:

getModificationCount in interface ModificationTracker

Specified by:

getModificationCount in class VirtualFileManager

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:

VirtualFileManager.getStructureModificationCount()

storeName

public int storeName(java.lang.String name)

Specified by:

storeName in class VirtualFileManager

getVFileName

public java.lang.CharSequence getVFileName(int nameId)

Specified by:

getVFileName in class VirtualFileManager