Package com.intellij.util.indexing

Class ChangedFilesCollector

java.lang.Object

com.intellij.util.indexing.ChangedFilesCollector

All Implemented Interfaces:

AsyncFileListener

public final class ChangedFilesCollector
extends java.lang.Object

Nested Class Summary

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

AsyncFileListener.ChangeApplier

Constructor Summary

Constructors

Constructor and Description
ChangedFilesCollector()

Method Summary

Modifier and Type	Method and Description
protected void	buildIndicesForFileRecursively(VirtualFile file, boolean contentChange)
boolean	containsFileId(int fileId)
protected void	iterateIndexableFiles(VirtualFile file, ContentIterator iterator)
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	waitForVfsEventsExecuted(long timeout, java.util.concurrent.TimeUnit unit)

Methods inherited from class java.lang.Object

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

Constructor Detail

ChangedFilesCollector

public ChangedFilesCollector()

Method Detail

buildIndicesForFileRecursively

protected void buildIndicesForFileRecursively(VirtualFile file,
                                              boolean contentChange)

iterateIndexableFiles

protected void iterateIndexableFiles(VirtualFile file,
                                     ContentIterator iterator)

containsFileId

public boolean containsFileId(int fileId)

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

waitForVfsEventsExecuted

public void waitForVfsEventsExecuted(long timeout,
                                     java.util.concurrent.TimeUnit unit)
                              throws java.lang.Exception

Throws:

java.lang.Exception