Package com.intellij.compiler.backwardRefs

Class DirtyScopeHolder

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.compiler.backwardRefs.DirtyScopeHolder

All Implemented Interfaces:

UserDataHolder, UserDataHolderEx, AsyncFileListener

public class DirtyScopeHolder
extends UserDataHolderBase
implements AsyncFileListener

Nested Class Summary

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

AsyncFileListener.ChangeApplier

Method Summary

Modifier and Type	Method and Description
boolean	contains(VirtualFile file)
java.util.Set<Module>	getAllDirtyModules()
GlobalSearchScope	getDirtyScope()
void	installVFSListener(Disposable parentDisposable)
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	upToDateChecked(boolean isUpToDate)

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

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

Method Detail

upToDateChecked

public void upToDateChecked(boolean isUpToDate)

getDirtyScope

public GlobalSearchScope getDirtyScope()

getAllDirtyModules

public java.util.Set<Module> getAllDirtyModules()

contains

public boolean contains(VirtualFile file)

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

installVFSListener

public void installVFSListener(Disposable parentDisposable)