PsiManager (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.openapi.util.UserDataHolderBase
- - com.intellij.psi.PsiManager

All Implemented Interfaces:

UserDataHolder, UserDataHolderEx

Direct Known Subclasses:

PsiManagerEx
```
public abstract class PsiManager
extends UserDataHolderBase
```
The main entry point for accessing the PSI services for a project.

Constructor Summary

Constructors
Constructor and Description

PsiManager()

Constructors
Constructor and Description
`PsiManager()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`addPsiTreeChangeListener(PsiTreeChangeListener listener)` Adds a listener for receiving notifications about all changes in the PSI tree of the project.
`abstract void`	`addPsiTreeChangeListener(PsiTreeChangeListener listener, Disposable parentDisposable)` Adds a listener for receiving notifications about all changes in the PSI tree of the project.
`abstract 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.
`abstract void`	`dropPsiCaches()` Clears all `CachedValue` depending on `PsiModificationTracker.MODIFICATION_COUNT` and resolve caches.
`abstract void`	`dropResolveCaches()` Clears the resolve caches of the PSI manager.
`abstract PsiDirectory`	`findDirectory(VirtualFile file)` Returns the PSI directory corresponding to the specified virtual file system directory.
`abstract PsiFile`	`findFile(VirtualFile file)` Returns the PSI file corresponding to the specified virtual file.
`abstract FileViewProvider`	`findViewProvider(VirtualFile file)`
`abstract void`	`finishBatchFilesProcessingMode()` Notifies the PSI manager that a batch operation sequentially processing multiple files is finishing.
`static PsiManager`	`getInstance(Project project)` Returns the PSI manager instance for the specified project.
`abstract PsiModificationTracker`	`getModificationTracker()` Returns the modification tracker for the project, which can be used to get the PSI modification count value.
`abstract Project`	`getProject()` Returns the project with which the PSI manager is associated.
`abstract boolean`	`isDisposed()` Checks if the PSI manager has been disposed and the PSI for this project can no longer be used.
`abstract boolean`	`isInProject(PsiElement element)` Checks if the specified PSI element belongs to the sources of the project.
`abstract void`	`reloadFromDisk(PsiFile file)` Reloads the contents of the specified PSI file and its associated document (if any) from the disk.
`abstract void`	`removePsiTreeChangeListener(PsiTreeChangeListener listener)` Removes a listener for receiving notifications about all changes in the PSI tree of the project.
`abstract void`	`startBatchFilesProcessingMode()` Notifies the PSI manager that a batch operation sequentially processing multiple files is starting.

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

- Constructor Detail
  - PsiManager
```
public PsiManager()
```
- Method Detail
  - getInstance
```
public static PsiManager getInstance(Project project)
```
    Returns the PSI manager instance for the specified project.
    
    Parameters:
    
    project - the project for which the PSI manager is requested.
    
    Returns:
    
    the PSI manager instance.
  - getProject
```
public abstract Project getProject()
```
    Returns the project with which the PSI manager is associated.
    
    Returns:
    
    the project instance.
  - findFile
```
public abstract PsiFile findFile(VirtualFile file)
```
    Returns the PSI file corresponding to the specified virtual file.
    
    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 abstract FileViewProvider findViewProvider(VirtualFile file)
```
  - findDirectory
```
public abstract PsiDirectory findDirectory(VirtualFile file)
```
    Returns the PSI directory corresponding to the specified virtual file system directory.
    
    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.
  - areElementsEquivalent
```
public abstract 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.
    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.
    
    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
  - reloadFromDisk
```
public abstract void reloadFromDisk(PsiFile file)
```
    Reloads the contents of the specified PSI file and its associated document (if any) from the disk.
    
    Parameters:
    
    file - the PSI file to reload.
  - addPsiTreeChangeListener
```
public abstract void addPsiTreeChangeListener(PsiTreeChangeListener listener)
```
    Adds a listener for receiving notifications about all changes in the PSI tree of the project.
    
    Parameters:
    
    listener - the listener instance.
  - addPsiTreeChangeListener
```
public abstract void addPsiTreeChangeListener(PsiTreeChangeListener listener,
                                              Disposable parentDisposable)
```
    Adds a listener for receiving notifications about all changes in the PSI tree of the project.
    
    Parameters:
    
    listener - the listener instance.
    
    parentDisposable - object, after whose disposing the listener should be removed
  - removePsiTreeChangeListener
```
public abstract void removePsiTreeChangeListener(PsiTreeChangeListener listener)
```
    Removes a listener for receiving notifications about all changes in the PSI tree of the project.
    
    Parameters:
    
    listener - the listener instance.
  - getModificationTracker
```
public abstract PsiModificationTracker getModificationTracker()
```
    Returns the modification tracker for the project, which can be used to get the PSI modification count value.
    
    Returns:
    
    the modification tracker instance.
  - startBatchFilesProcessingMode
```
public abstract void startBatchFilesProcessingMode()
```
    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.
  - finishBatchFilesProcessingMode
```
public abstract void finishBatchFilesProcessingMode()
```
    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.
  - isDisposed
```
public abstract boolean isDisposed()
```
    Checks if the PSI manager has been disposed and the PSI for this project can no longer be used.
    
    Returns:
    
    true if the PSI manager is disposed, false otherwise.
  - dropResolveCaches
```
public abstract void dropResolveCaches()
```
    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.
  - dropPsiCaches
```
public abstract void dropPsiCaches()
```
    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.
  - isInProject
```
public abstract boolean isInProject(PsiElement element)
```
    Checks if the specified PSI element belongs to the sources of the project.
    
    Parameters:
    
    element - the element to check.
    
    Returns:
    
    true if the element belongs to the sources of the project, false otherwise.

Class PsiManager

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

PsiManager

Method Detail

getInstance

getProject

findFile

findViewProvider

findDirectory

areElementsEquivalent

reloadFromDisk

addPsiTreeChangeListener

addPsiTreeChangeListener

removePsiTreeChangeListener

getModificationTracker

startBatchFilesProcessingMode

finishBatchFilesProcessingMode

isDisposed

dropResolveCaches

dropPsiCaches

isInProject