Package com.intellij.openapi.vcs.changes

Class VcsDirtyScopeVfsListener

java.lang.Object

com.intellij.openapi.vcs.changes.VcsDirtyScopeVfsListener

All Implemented Interfaces:

Disposable, AsyncFileListener

public class VcsDirtyScopeVfsListener
extends java.lang.Object
implements AsyncFileListener, Disposable

Listens to file system events and notifies VcsDirtyScopeManagers responsible for changed files to mark these files dirty.

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.vfs.AsyncFileListener

AsyncFileListener.ChangeApplier

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

Disposable.Parent

Constructor Summary

Constructors

Constructor and Description
VcsDirtyScopeVfsListener(Project project)

Method Summary

Modifier and Type	Method and Description
void	dispose() Usually not invoked directly, see class javadoc.
static VcsDirtyScopeVfsListener	getInstance(Project project)
static void	install(Project project)
AsyncFileListener.ChangeApplier	prepareChange(java.util.List<? extends VFileEvent> events) Called (possibly on a background thread) when a batch of VFS events is ready to be fired.
void	setForbid(boolean forbid)
void	waitForAsyncTaskCompletion()

Methods inherited from class java.lang.Object

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

Constructor Detail

VcsDirtyScopeVfsListener

public VcsDirtyScopeVfsListener(Project project)

Method Detail

getInstance

public static VcsDirtyScopeVfsListener getInstance(Project project)

install

public static void install(Project project)

setForbid

public void setForbid(boolean forbid)

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

waitForAsyncTaskCompletion

public void waitForAsyncTaskCompletion()

prepareChange

public AsyncFileListener.ChangeApplier prepareChange(java.util.List<? extends VFileEvent> events)

Description copied from interface: AsyncFileListener

Called (possibly on a background thread) when a batch of VFS events is ready to be fired. This method should not have side effects and should guarantee its cancellability by calling ProgressManager.checkCanceled() often enough.

Note that this listener can only observe the state of the system before VFS events, and so it can't work with anything that would be after them, e.g. there will be no file in VFileCreateEvent, FileIndexFacade won't know anything about the updated state after VFS change, and so on.

Note that the events posted passed might differ from the ones passed into BulkFileListener. In particular, there may occasionally be several events about the same file (e.g deletion and then creation, or creation and then deletion of the file's parent). Hence the order of events is significant. Implementations should be prepared to such situations.

Specified by:

prepareChange in interface AsyncFileListener

Returns:

a ChangeApplier object to be called inside write action before/after the passed events are finally applied to VFS