platform: update VirtualFileListener javadoc

GitOrigin-RevId: 091258e8e1deb54dac2a2b086a8e06a176e21af6
This commit is contained in:
Aleksey Pivovarov
2022-06-30 13:04:10 +02:00
committed by intellij-monorepo-bot
parent 11734f874f
commit f0bda341e0
2 changed files with 7 additions and 4 deletions

View File

@@ -23,7 +23,8 @@ import java.util.EventListener;
* Receives notifications about changes in the virtual file system.
*
* @see VirtualFileManager#addVirtualFileListener(VirtualFileListener)
* @see VirtualFileListener
* @see com.intellij.openapi.vfs.newvfs.BulkFileListener
* @see AsyncFileListener
*/
public interface VirtualFileListener extends EventListener {

View File

@@ -84,6 +84,7 @@ public abstract class VirtualFileManager implements ModificationTracker {
/**
* Looks for a related {@link VirtualFile} for a given {@link Path}
*
* @return <code>{@link VirtualFile}</code> if the file was found, {@code null} otherwise
* @see VirtualFile#getUrl
* @see VirtualFileSystem#findFileByPath
@@ -129,19 +130,20 @@ public abstract class VirtualFileManager implements ModificationTracker {
}
/**
* @deprecated Use {@link #VFS_CHANGES} message bus topic.
* @deprecated Prefer {@link #addVirtualFileListener(VirtualFileListener, Disposable)} or other VFS listeners.
*/
@Deprecated
public abstract void addVirtualFileListener(@NotNull VirtualFileListener listener);
/**
* @deprecated Use {@link #VFS_CHANGES} message bus topic.
* @deprecated When possible, migrate to {@link AsyncFileListener} to process events on a pooled thread.
* Otherwise, consider using {@link #VFS_CHANGES} message bus topic to avoid early initialization of {@link VirtualFileManager}.
*/
@Deprecated
public abstract void addVirtualFileListener(@NotNull VirtualFileListener listener, @NotNull Disposable parentDisposable);
/**
* @deprecated Use {@link #VFS_CHANGES} message bus topic.
* @deprecated Prefer {@link #addVirtualFileListener(VirtualFileListener, Disposable)} or other VFS listeners.
*/
@Deprecated
public abstract void removeVirtualFileListener(@NotNull VirtualFileListener listener);