Package com.intellij.psi.impl

Class PsiManagerImpl

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.PsiManager

com.intellij.psi.impl.PsiManagerEx

com.intellij.psi.impl.PsiManagerImpl

All Implemented Interfaces:

Disposable, UserDataHolder, UserDataHolderEx

public final class PsiManagerImpl
extends PsiManagerEx
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
static Topic<AnyPsiChangeListener>	ANY_PSI_CHANGE_TOPIC

Constructor Summary

Constructors

Constructor and Description
PsiManagerImpl(Project project)

Method Summary

Modifier and Type	Method and Description
void	addPsiTreeChangeListener(PsiTreeChangeListener listener) Adds a listener for receiving notifications about all changes in the PSI tree of the project.
void	addPsiTreeChangeListener(PsiTreeChangeListener listener, Disposable parentDisposable) Adds a listener for receiving notifications about all changes in the PSI tree of the project.
void	addTreeChangePreprocessor(PsiTreeChangePreprocessor preprocessor)
void	afterChange(boolean isPhysical)
boolean	areElementsEquivalent(PsiElement element1, PsiElement element2) Checks if the specified two PSI elements (possibly invalid) represent the same source element or can are considered equivalent for resolve purposes.
void	beforeChange(boolean isPhysical)
void	beforeChildAddition(PsiTreeChangeEventImpl event)
void	beforeChildMovement(PsiTreeChangeEventImpl event)
void	beforeChildRemoval(PsiTreeChangeEventImpl event)
void	beforeChildrenChange(PsiTreeChangeEventImpl event)
void	beforeChildReplacement(PsiTreeChangeEventImpl event)
void	beforePropertyChange(PsiTreeChangeEventImpl event)
void	childAdded(PsiTreeChangeEventImpl event)
void	childMoved(PsiTreeChangeEventImpl event)
void	childRemoved(PsiTreeChangeEventImpl event)
void	childrenChanged(PsiTreeChangeEventImpl event)
void	childReplaced(PsiTreeChangeEventImpl event)
void	cleanupForNextTest()
void	dispose() Usually not invoked directly, see class javadoc.
void	dropPsiCaches() Clears all CachedValue depending on PsiModificationTracker.MODIFICATION_COUNT and resolve caches.
void	dropResolveCacheRegularly(ProgressIndicator indicator)
void	dropResolveCaches() Clears the resolve caches of the PSI manager.
PsiDirectory	findDirectory(VirtualFile file) Returns the PSI directory corresponding to the specified virtual file system directory.
PsiFile	findFile(VirtualFile file) Returns the PSI file corresponding to the specified virtual file.
FileViewProvider	findViewProvider(VirtualFile file)
void	finishBatchFilesProcessingMode() Notifies the PSI manager that a batch operation sequentially processing multiple files is finishing.
FileManager	getFileManager()
PsiModificationTracker	getModificationTracker() Returns the modification tracker for the project, which can be used to get the PSI modification count value.
Project	getProject() Returns the project with which the PSI manager is associated.
boolean	isAssertOnFileLoading(VirtualFile file)
boolean	isBatchFilesProcessingMode()
boolean	isDisposed() Checks if the PSI manager has been disposed and the PSI for this project can no longer be used.
boolean	isInProject(PsiElement element) Checks if the specified PSI element belongs to the sources of the project.
void	propertyChanged(PsiTreeChangeEventImpl event)
void	registerRunnableToRunAfterAnyChange(java.lang.Runnable runnable)
void	registerRunnableToRunOnAnyChange(java.lang.Runnable runnable)
void	registerRunnableToRunOnChange(java.lang.Runnable runnable)
void	reloadFromDisk(PsiFile file) Reloads the contents of the specified PSI file and its associated document (if any) from the disk.
void	removePsiTreeChangeListener(PsiTreeChangeListener listener) Removes a listener for receiving notifications about all changes in the PSI tree of the project.
void	removeTreeChangePreprocessor(PsiTreeChangePreprocessor preprocessor)
void	setAssertOnFileLoadingFilter(VirtualFileFilter filter, Disposable parentDisposable)
void	startBatchFilesProcessingMode() Notifies the PSI manager that a batch operation sequentially processing multiple files is starting.

Methods inherited from class com.intellij.psi.impl.PsiManagerEx

getInstanceEx

Methods inherited from class com.intellij.psi.PsiManager

getInstance

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

Field Detail

ANY_PSI_CHANGE_TOPIC

public static final Topic<AnyPsiChangeListener> ANY_PSI_CHANGE_TOPIC

Constructor Detail

PsiManagerImpl

public PsiManagerImpl(Project project)

Method Detail

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

isDisposed

public boolean isDisposed()

Description copied from class: PsiManager

Checks if the PSI manager has been disposed and the PSI for this project can no longer be used.

Specified by:

isDisposed in class PsiManager

Returns:

true if the PSI manager is disposed, false otherwise.

dropResolveCaches

public void dropResolveCaches()

Description copied from class: PsiManager

Clears the resolve caches of the PSI manager. Can be used to reduce memory consumption in batch operations sequentially processing multiple files. Can be invoked from any thread.

Specified by:

dropResolveCaches in class PsiManager

dropPsiCaches

public void dropPsiCaches()

Description copied from class: PsiManager

Clears all CachedValue depending on PsiModificationTracker.MODIFICATION_COUNT and resolve caches. Can be used to reduce memory consumption in batch operations sequentially processing multiple files. Should be invoked on Swing thread.

Specified by:

dropPsiCaches in class PsiManager

isInProject

public boolean isInProject(PsiElement element)

Description copied from class: PsiManager

Checks if the specified PSI element belongs to the sources of the project.

Specified by:

isInProject in class PsiManager

Parameters:

element - the element to check.

Returns:

true if the element belongs to the sources of the project, false otherwise.

setAssertOnFileLoadingFilter

public void setAssertOnFileLoadingFilter(VirtualFileFilter filter,
                                         Disposable parentDisposable)

Specified by:

setAssertOnFileLoadingFilter in class PsiManagerEx

isAssertOnFileLoading

public boolean isAssertOnFileLoading(VirtualFile file)

Specified by:

isAssertOnFileLoading in class PsiManagerEx

getProject

public Project getProject()

Description copied from class: PsiManager

Returns the project with which the PSI manager is associated.

Specified by:

getProject in class PsiManager

Returns:

the project instance.

getFileManager

public FileManager getFileManager()

Specified by:

getFileManager in class PsiManagerEx

areElementsEquivalent

public boolean areElementsEquivalent(PsiElement element1,
                                     PsiElement element2)

Description copied from class: PsiManager

Checks if the specified two PSI elements (possibly invalid) represent the same source element or can are considered equivalent for resolve purposes.

Can be used to match two versions of the PSI tree with each other after a reparse.

For example, Java classes with the same fully-qualified name are equivalent, which is useful when working with both library source and class roots. Source and compiled classes are definitely different (equals() returns false), but for reference resolve or inheritance checks, they're equivalent.

Specified by:

areElementsEquivalent in class PsiManager

Parameters:

element1 - the first element to check for equivalence

element2 - the second element to check for equivalence

Returns:

true if the elements are equivalent, false if the elements are different or it was not possible to determine the equivalence

findFile

public PsiFile findFile(VirtualFile file)

Description copied from class: PsiManager

Returns the PSI file corresponding to the specified virtual file.

Specified by:

findFile in class PsiManager

Parameters:

file - the file for which the PSI is requested.

Returns:

the PSI file, or null if file is a directory, an invalid virtual file, or the current project is a dummy or default project.

findViewProvider

public FileViewProvider findViewProvider(VirtualFile file)

Specified by:

findViewProvider in class PsiManager

findDirectory

public PsiDirectory findDirectory(VirtualFile file)

Description copied from class: PsiManager

Returns the PSI directory corresponding to the specified virtual file system directory.

Specified by:

findDirectory in class PsiManager

Parameters:

file - the directory for which the PSI is requested.

Returns:

the PSI directory, or null if there is no PSI for the specified directory in this project.

reloadFromDisk

public void reloadFromDisk(PsiFile file)

Description copied from class: PsiManager

Reloads the contents of the specified PSI file and its associated document (if any) from the disk.

Specified by:

reloadFromDisk in class PsiManager

Parameters:

file - the PSI file to reload.

addPsiTreeChangeListener

public void addPsiTreeChangeListener(PsiTreeChangeListener listener)

Description copied from class: PsiManager

Adds a listener for receiving notifications about all changes in the PSI tree of the project.

Specified by:

addPsiTreeChangeListener in class PsiManager

Parameters:

listener - the listener instance.

addPsiTreeChangeListener

public void addPsiTreeChangeListener(PsiTreeChangeListener listener,
                                     Disposable parentDisposable)

Description copied from class: PsiManager

Adds a listener for receiving notifications about all changes in the PSI tree of the project.

Specified by:

addPsiTreeChangeListener in class PsiManager

Parameters:

listener - the listener instance.

parentDisposable - object, after whose disposing the listener should be removed

removePsiTreeChangeListener

public void removePsiTreeChangeListener(PsiTreeChangeListener listener)

Description copied from class: PsiManager

Removes a listener for receiving notifications about all changes in the PSI tree of the project.

Specified by:

removePsiTreeChangeListener in class PsiManager

Parameters:

listener - the listener instance.

beforeChildAddition

public void beforeChildAddition(PsiTreeChangeEventImpl event)

Specified by:

beforeChildAddition in class PsiManagerEx

beforeChildRemoval

public void beforeChildRemoval(PsiTreeChangeEventImpl event)

Specified by:

beforeChildRemoval in class PsiManagerEx

beforeChildReplacement

public void beforeChildReplacement(PsiTreeChangeEventImpl event)

Specified by:

beforeChildReplacement in class PsiManagerEx

beforeChildrenChange

public void beforeChildrenChange(PsiTreeChangeEventImpl event)

beforeChildMovement

public void beforeChildMovement(PsiTreeChangeEventImpl event)

beforePropertyChange

public void beforePropertyChange(PsiTreeChangeEventImpl event)

childAdded

public void childAdded(PsiTreeChangeEventImpl event)

childRemoved

public void childRemoved(PsiTreeChangeEventImpl event)

childReplaced

public void childReplaced(PsiTreeChangeEventImpl event)

childMoved

public void childMoved(PsiTreeChangeEventImpl event)

childrenChanged

public void childrenChanged(PsiTreeChangeEventImpl event)

propertyChanged

public void propertyChanged(PsiTreeChangeEventImpl event)

addTreeChangePreprocessor

public void addTreeChangePreprocessor(PsiTreeChangePreprocessor preprocessor)

removeTreeChangePreprocessor

public void removeTreeChangePreprocessor(PsiTreeChangePreprocessor preprocessor)

registerRunnableToRunOnChange

public void registerRunnableToRunOnChange(java.lang.Runnable runnable)

Specified by:

registerRunnableToRunOnChange in class PsiManagerEx

Parameters:

runnable - to be run before physical PSI change

registerRunnableToRunOnAnyChange

public void registerRunnableToRunOnAnyChange(java.lang.Runnable runnable)

Specified by:

registerRunnableToRunOnAnyChange in class PsiManagerEx

Parameters:

runnable - to be run before physical or non-physical PSI change

registerRunnableToRunAfterAnyChange

public void registerRunnableToRunAfterAnyChange(java.lang.Runnable runnable)

Specified by:

registerRunnableToRunAfterAnyChange in class PsiManagerEx

beforeChange

public void beforeChange(boolean isPhysical)

Specified by:

beforeChange in class PsiManagerEx

afterChange

public void afterChange(boolean isPhysical)

Specified by:

afterChange in class PsiManagerEx

getModificationTracker

public PsiModificationTracker getModificationTracker()

Description copied from class: PsiManager

Returns the modification tracker for the project, which can be used to get the PSI modification count value.

Specified by:

getModificationTracker in class PsiManager

Returns:

the modification tracker instance.

startBatchFilesProcessingMode

public void startBatchFilesProcessingMode()

Description copied from class: PsiManager

Notifies the PSI manager that a batch operation sequentially processing multiple files is starting. Memory occupied by cached PSI trees is released more eagerly during such a batch operation.

Specified by:

startBatchFilesProcessingMode in class PsiManager

finishBatchFilesProcessingMode

public void finishBatchFilesProcessingMode()

Description copied from class: PsiManager

Notifies the PSI manager that a batch operation sequentially processing multiple files is finishing. Memory occupied by cached PSI trees is released more eagerly during such a batch operation.

Specified by:

finishBatchFilesProcessingMode in class PsiManager

isBatchFilesProcessingMode

public boolean isBatchFilesProcessingMode()

Specified by:

isBatchFilesProcessingMode in class PsiManagerEx

cleanupForNextTest

public void cleanupForNextTest()

dropResolveCacheRegularly

public void dropResolveCacheRegularly(ProgressIndicator indicator)