PsiFileImpl (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.openapi.util.UserDataHolderBase
- - com.intellij.psi.impl.ElementBase
  - - com.intellij.psi.impl.source.PsiFileImpl

All Implemented Interfaces:

NavigationItem, Queryable, Iconable, UserDataHolder, UserDataHolderEx, Navigatable, PsiFileEx, PsiFileWithStubSupport, NavigatablePsiElement, PsiCheckedRenameElement, PsiElement, PsiFile, PsiFileSystemItem, PsiNamedElement, java.lang.Cloneable

Direct Known Subclasses:

DummyHolder, IgnoreFile, PsiCodeFragmentImpl, PsiFileBase, PsiJavaFileBaseImpl, PsiPlainTextFileImpl, RestFile, XmlFileImpl
```
public abstract class PsiFileImpl
extends ElementBase
implements PsiFileEx, PsiFileWithStubSupport, Queryable, java.lang.Cloneable
```

Nested Class Summary
- Nested classes/interfaces inherited from interface com.intellij.openapi.ui.Queryable
  Queryable.Contributor, Queryable.PrintInfo, Queryable.Util

Field Summary

Fields
Modifier and Type	Field and Description
`static Key<java.lang.Boolean>`	`BUILDING_STUB`
`protected IElementType`	`myContentElementType`
`protected PsiManagerEx`	`myManager`
`protected PsiFile`	`myOriginalFile`

Fields inherited from class com.intellij.psi.impl.ElementBase
FLAGS_LOCKED, ICON_PLACEHOLDER

Fields inherited from interface com.intellij.psi.impl.PsiFileEx
BATCH_REFERENCE_PROCESSING

Fields inherited from interface com.intellij.psi.PsiFile
EMPTY_ARRAY

Fields inherited from interface com.intellij.psi.NavigatablePsiElement
EMPTY_NAVIGATABLE_ELEMENT_ARRAY

Fields inherited from interface com.intellij.navigation.NavigationItem
EMPTY_NAVIGATION_ITEM_ARRAY

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`PsiFileImpl(FileViewProvider provider)`
`protected`	`PsiFileImpl(IElementType elementType, IElementType contentElementType, FileViewProvider provider)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`acceptChildren(PsiElementVisitor visitor)` Passes the children of the element to the specified visitor.
`PsiElement`	`add(PsiElement element)` Adds a child to this PSI element.
`PsiElement`	`addAfter(PsiElement element, PsiElement anchor)` Adds a child to this PSI element, after the specified anchor element.
`PsiElement`	`addBefore(PsiElement element, PsiElement anchor)` Adds a child to this PSI element, before the specified anchor element.
`PsiElement`	`addRange(PsiElement first, PsiElement last)` Adds a range of elements as children to this PSI element.
`PsiElement`	`addRangeAfter(PsiElement first, PsiElement last, PsiElement anchor)` Adds a range of elements as children to this PSI element, after the specified anchor element.
`PsiElement`	`addRangeBefore(PsiElement first, PsiElement last, PsiElement anchor)` Adds a range of elements as children to this PSI element, before the specified anchor element.
`protected void`	`assertReadAccessAllowed()`
`void`	`beforeAstChange()`
`StubTree`	`calcStubTree()`
`FileElement`	`calcTreeElement()`
`boolean`	`canNavigate()` Indicates whether this instance supports navigation of any kind.
`boolean`	`canNavigateToSource()` Indicates whether this instance supports navigation to source (that means some kind of editor).
`void`	`checkAdd(PsiElement element)` Checks if it is possible to add the specified element as a child to this element, and throws an exception if the add is not possible.
`void`	`checkDelete()` Checks if it is possible to delete the specified element from the tree, and throws an exception if the add is not possible.
`void`	`checkSetName(java.lang.String name)` Checks if it is possible to rename the element to the specified name, and throws an exception if the rename is not possible.
`void`	`clearCaches()` Invalidate any file-specific cache in this method.
`protected PsiFileImpl`	`clone()`
`protected PsiFileImpl`	`cloneImpl(FileElement treeElementClone)`
`PsiElement`	`copy()` Creates a copy of the file containing the PSI element and returns the corresponding element in the created copy.
`TreeElement`	`createContentLeafElement(java.lang.CharSequence leafText)`
`protected FileElement`	`createFileElement(java.lang.CharSequence docText)`
`void`	`delete()` Deletes this PSI element from the tree.
`void`	`deleteChildRange(PsiElement first, PsiElement last)` Deletes a range of children of this PSI element from the tree.
`StubTree`	`derefStub()`
`<T> T`	`findChildByClass(java.lang.Class<T> aClass)`
`<T> T []`	`findChildrenByClass(java.lang.Class<T> aClass)`
`PsiElement`	`findElementAt(int offset)` Finds a leaf PSI element at the specified offset from the start of the text range of this node.
`PsiReference`	`findReferenceAt(int offset)` Finds a reference at the specified offset from the start of the text range of this node.
`PsiElement []`	`getChildren()` Returns the array of children for the PSI element.
`PsiDirectory`	`getContainingDirectory()` Returns the directory containing the file.
`PsiFile`	`getContainingFile()` Returns the file containing the PSI element.
`IElementType`	`getContentElementType()`
`PsiElement`	`getContext()` Returns the element which should be used as the parent of this element in a tree up walk during a resolve operation.
`IStubFileElementType`	`getElementTypeForStubBuilder()`
`IFileElementType`	`getFileElementType()`
`PsiElement`	`getFirstChild()` Returns the first child of the PSI element.
`StubElement`	`getGreenStub()` A green stub is a stub object that can co-exist with tree (AST).
`StubTree`	`getGreenStubTree()`
`Language`	`getLanguage()` Returns the language of the PSI element.
`PsiElement`	`getLastChild()` Returns the last child of the PSI element.
`PsiManager`	`getManager()` Returns the PSI manager for the project to which the PSI element belongs.
`long`	`getModificationStamp()` Gets the modification stamp value.
`java.lang.String`	`getName()` Returns the name of the element.
`PsiElement`	`getNavigationElement()` Returns the PSI element which should be used as a navigation target when navigation to this PSI element is requested.
`PsiElement`	`getNextSibling()` Returns the next sibling of the PSI element.
`FileASTNode`	`getNode()` Returns the AST node corresponding to the element.
`PsiElement`	`getOriginalElement()` Returns the PSI element which corresponds to this element and belongs to either the project source path or class path.
`PsiFile`	`getOriginalFile()` If the file is a non-physical copy of a file, returns the original file which had been copied.
`PsiDirectory`	`getParent()` Returns the parent of the PSI element.
`ItemPresentation`	`getPresentation()`
`PsiElement`	`getPrevSibling()` Returns the previous sibling of the PSI element.
`Project`	`getProject()` Returns the project to which the PSI element belongs.
`PsiFile []`	`getPsiRoots()` If the file contains multiple interspersed languages, returns the roots for PSI trees for each of these languages.
`PsiReference`	`getReference()` Returns the reference from this PSI element to another PSI element (or elements), if one exists.
`PsiReference []`	`getReferences()` Returns all references from this PSI element to other PSI elements.
`GlobalSearchScope`	`getResolveScope()` Returns the scope in which the declarations for the references in this PSI element are searched.
`int`	`getStartOffsetInParent()` Returns the text offset of the PSI element relative to its parent.
`StubElement`	`getStub()`
`StubbedSpine`	`getStubbedSpine()`
`StubTree`	`getStubTree()`
`java.lang.String`	`getText()` Returns the text of the PSI element.
`int`	`getTextLength()` Returns the length of text of the PSI element.
`int`	`getTextOffset()` Returns the offset in the file to which the caret should be placed when performing the navigation to the element.
`TextRange`	`getTextRange()` Returns the text range in the document occupied by the PSI element.
`FileElement`	`getTreeElement()`
`SearchScope`	`getUseScope()` Returns the scope in which references to this element are searched.
`FileViewProvider`	`getViewProvider()`
`VirtualFile`	`getVirtualFile()` Returns the virtual file corresponding to the PSI file.
`protected void`	`init(IElementType elementType, IElementType contentElementType)`
`boolean`	`isContentsLoaded()`
`boolean`	`isDirectory()`
`boolean`	`isEquivalentTo(PsiElement another)` This method shouldn't be called by clients directly, because there are no guarantees of it being symmetric.
`boolean`	`isPhysical()` Checks if an actual source or class file corresponds to the element.
`boolean`	`isTemplateDataFile()`
`boolean`	`isValid()` Checks if this PSI element is valid.
`boolean`	`isWritable()` Checks if the contents of the element can be modified (if it belongs to a non-read-only source file.)
`void`	`markInvalidated()`
`void`	`navigate(boolean requestFocus)` Open editor and select/navigate to the object there if possible.
`void`	`onContentReload()`
`boolean`	`processChildren(PsiElementProcessor<PsiFileSystemItem> processor)`
`boolean`	`processDeclarations(PsiScopeProcessor processor, ResolveState state, PsiElement lastParent, PsiElement place)` Passes the declarations contained in this PSI element and its children for processing to the specified scope processor.
`void`	`putInfo(java.util.Map<java.lang.String,java.lang.String> info)`
`static void`	`putInfo(PsiFile psiFile, java.util.Map<java.lang.String,java.lang.String> info)`
`PsiElement`	`replace(PsiElement newElement)` Replaces this PSI element (along with all its children) with another element (along with the children).
`void`	`setContentElementType(IElementType contentElementType)`
`PsiElement`	`setName(java.lang.String name)` Renames the element.
`void`	`setOriginalFile(PsiFile originalFile)`
`void`	`setTreeElementPointer(FileElement element)`
`void`	`subtreeChanged()` Called by the PSI framework when the contents of the file changes.
`boolean`	`textContains(char c)` Checks if the text of this element contains the specified character.
`boolean`	`textMatches(java.lang.CharSequence text)` Checks if the text of this PSI element is equal to the specified character sequence.
`boolean`	`textMatches(PsiElement element)` Checks if the text of this PSI element is equal to the text of the specified PSI element.
`char []`	`textToCharArray()` Returns the text of the PSI element as a character array.
`java.lang.String`	`toString()` toString() should never be presented to the user.

Methods inherited from class com.intellij.psi.impl.ElementBase
buildRowIcon, computeBaseIcon, createLayeredIcon, getAdjustedBaseIcon, getBaseIcon, getElementIcon, getIcon, iconWithVisibilityIfNeeded, isNativeFileType, isVisibilitySupported, overlayIcons, registerIconLayer, transformFlags

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase
changeUserMap, clearUserData, 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, wait, wait, wait

Methods inherited from interface com.intellij.psi.PsiFile
getFileType

- Field Detail
  - myContentElementType
```
protected IElementType myContentElementType
```
  - myOriginalFile
```
protected PsiFile myOriginalFile
```
  - myManager
```
protected final PsiManagerEx myManager
```
  - BUILDING_STUB
```
public static final Key<java.lang.Boolean> BUILDING_STUB
```
- Constructor Detail
  - PsiFileImpl
```
protected PsiFileImpl(IElementType elementType,
                      IElementType contentElementType,
                      FileViewProvider provider)
```
  - PsiFileImpl
```
protected PsiFileImpl(FileViewProvider provider)
```
- Method Detail
  - setContentElementType
```
public void setContentElementType(IElementType contentElementType)
```
  - getContentElementType
```
public IElementType getContentElementType()
```
  - init
```
protected void init(IElementType elementType,
                    IElementType contentElementType)
```
  - createContentLeafElement
```
public TreeElement createContentLeafElement(java.lang.CharSequence leafText)
```
  - isDirectory
```
public boolean isDirectory()
```
    Specified by:
    
    isDirectory in interface PsiFileSystemItem
  - getTreeElement
```
public FileElement getTreeElement()
```
  - getVirtualFile
```
public VirtualFile getVirtualFile()
```
    Description copied from interface: PsiFile
    
    Returns the virtual file corresponding to the PSI file.
    
    Specified by:
    
    getVirtualFile in interface PsiFile
    
    Specified by:
    
    getVirtualFile in interface PsiFileSystemItem
    
    Returns:
    
    the virtual file, or null if the file exists only in memory.
  - processChildren
```
public boolean processChildren(PsiElementProcessor<PsiFileSystemItem> processor)
```
    Specified by:
    
    processChildren in interface PsiFileSystemItem
  - isValid
```
public boolean isValid()
```
    Description copied from interface: PsiElement
    Checks if this PSI element is valid. Valid elements and their hierarchy members can be accessed for reading and writing. Valid elements can still correspond to underlying documents whose text is different, when those documents have been changed and not yet committed (PsiDocumentManager.commitDocument(com.intellij.openapi.editor.Document)). (In this case an attempt to change PSI will result in an exception). Any access to invalid elements results in PsiInvalidElementAccessException. Once invalid, elements can't become valid again. Elements become invalid in following cases:
    - They have been deleted via PSI operation (PsiElement.delete())
    - They have been deleted as a result of an incremental reparse (document commit)
    - Their containing file has been changed externally, or renamed so that its PSI had to be rebuilt from scratch
    Specified by:
    
    isValid in interface PsiElement
    
    Returns:
    
    true if the element is valid, false otherwise.
    
    See Also:
    
    PsiUtilCore.ensureValid(PsiElement)
  - markInvalidated
```
public final void markInvalidated()
```
    Specified by:
    
    markInvalidated in interface PsiFileEx
  - isContentsLoaded
```
public boolean isContentsLoaded()
```
    Specified by:
    
    isContentsLoaded in interface PsiFileEx
  - assertReadAccessAllowed
```
protected void assertReadAccessAllowed()
```
  - getStubbedSpine
```
public StubbedSpine getStubbedSpine()
```
    Specified by:
    
    getStubbedSpine in interface PsiFileWithStubSupport
    
    Returns:
    
    StubbedSpine for accessing stubbed PSI, which can be backed up by stubs or AST
  - getElementTypeForStubBuilder
```
public IStubFileElementType getElementTypeForStubBuilder()
```
  - createFileElement
```
protected FileElement createFileElement(java.lang.CharSequence docText)
```
  - clearCaches
```
public void clearCaches()
```
    Description copied from interface: PsiFile
    
    Invalidate any file-specific cache in this method. It is called on file content change. If you override this method, you must call the base class implementation.
    
    Specified by:
    
    clearCaches in interface PsiFile
  - getText
```
public java.lang.String getText()
```
    Description copied from interface: PsiElement
    
    Returns the text of the PSI element.
    Note: This call requires traversing whole subtree, so it can be expensive for composite elements, and should be avoided if possible.
    
    Specified by:
    
    getText in interface PsiElement
    
    Returns:
    
    the element text.
    
    See Also:
    
    PsiElement.textMatches(java.lang.CharSequence), PsiElement.textContains(char)
  - getTextLength
```
public int getTextLength()
```
    Description copied from interface: PsiElement
    
    Returns the length of text of the PSI element.
    
    Specified by:
    
    getTextLength in interface PsiElement
    
    Returns:
    
    the text length.
  - getTextRange
```
public TextRange getTextRange()
```
    Description copied from interface: PsiElement
    
    Returns the text range in the document occupied by the PSI element.
    Note: it works in O(tree_depth) time, which can be slow in deep trees, so invoking this method should be avoided if possible.
    
    Specified by:
    
    getTextRange in interface PsiElement
    
    Returns:
    
    the text range.
  - getNextSibling
```
public PsiElement getNextSibling()
```
    Description copied from interface: PsiElement
    
    Returns the next sibling of the PSI element.
    
    Specified by:
    
    getNextSibling in interface PsiElement
    
    Returns:
    
    the next sibling, or null if the node is the last in the list of siblings.
  - getPrevSibling
```
public PsiElement getPrevSibling()
```
    Description copied from interface: PsiElement
    
    Returns the previous sibling of the PSI element.
    
    Specified by:
    
    getPrevSibling in interface PsiElement
    
    Returns:
    
    the previous sibling, or null if the node is the first in the list of siblings.
  - getModificationStamp
```
public long getModificationStamp()
```
    Description copied from interface: PsiFile
    
    Gets the modification stamp value. Modification stamp is a value changed by any modification of the content of the file. Note that it is not related to the file modification time.
    
    Specified by:
    
    getModificationStamp in interface PsiFile
    
    Returns:
    
    the modification stamp value
    
    See Also:
    
    VirtualFile.getModificationStamp()
  - subtreeChanged
```
public void subtreeChanged()
```
    Description copied from interface: PsiFile
    
    Called by the PSI framework when the contents of the file changes. If you override this method, you must call the base class implementation. While this method can be used to invalidate file-level caches, it is more much safe to invalidate them in PsiFile.clearCaches() since file contents can be reloaded completely (without any specific subtree change) without this method being called.
    
    Specified by:
    
    subtreeChanged in interface PsiFile
  - clone
```
protected PsiFileImpl clone()
```
    Overrides:
    
    clone in class UserDataHolderBase
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: PsiNamedElement
    
    Returns the name of the element.
    
    Specified by:
    
    getName in interface NavigationItem
    
    Specified by:
    
    getName in interface PsiFileSystemItem
    
    Specified by:
    
    getName in interface PsiNamedElement
    
    Returns:
    
    the element name.
  - setName
```
public PsiElement setName(java.lang.String name)
                   throws IncorrectOperationException
```
    Description copied from interface: PsiNamedElement
    
    Renames the element.
    
    Specified by:
    
    setName in interface PsiNamedElement
    
    Parameters:
    
    name - the new element name.
    
    Returns:
    
    the element corresponding to this element after the rename (either this or a different element if the rename caused the element to be replaced).
    
    Throws:
    
    IncorrectOperationException - if the modification is not supported or not possible for some reason.
  - checkSetName
```
public void checkSetName(java.lang.String name)
```
    Description copied from interface: PsiCheckedRenameElement
    
    Checks if it is possible to rename the element to the specified name, and throws an exception if the rename is not possible. Does not actually modify anything.
    
    Specified by:
    
    checkSetName in interface PsiCheckedRenameElement
    
    Parameters:
    
    name - the new name to check the renaming possibility for.
  - isWritable
```
public boolean isWritable()
```
    Description copied from interface: PsiElement
    
    Checks if the contents of the element can be modified (if it belongs to a non-read-only source file.)
    
    Specified by:
    
    isWritable in interface PsiElement
    
    Returns:
    
    true if the element can be modified, false otherwise.
  - getParent
```
public PsiDirectory getParent()
```
    Description copied from interface: PsiElement
    
    Returns the parent of the PSI element.
    
    Specified by:
    
    getParent in interface PsiElement
    
    Specified by:
    
    getParent in interface PsiFile
    
    Specified by:
    
    getParent in interface PsiFileSystemItem
    
    Returns:
    
    the parent of the element, or null if the element has no parent.
  - getContainingDirectory
```
public PsiDirectory getContainingDirectory()
```
    Description copied from interface: PsiFile
    
    Returns the directory containing the file.
    
    Specified by:
    
    getContainingDirectory in interface PsiFile
    
    Returns:
    
    the containing directory, or null if the file exists only in memory.
  - getContainingFile
```
public PsiFile getContainingFile()
```
    Description copied from interface: PsiElement
    
    Returns the file containing the PSI element.
    Note: this method might need to traverse the whole AST up, which can be slow in deep trees, so invoking this method should be avoided if possible.
    
    Specified by:
    
    getContainingFile in interface PsiElement
    
    Returns:
    
    the file instance, or null if the PSI element is not contained in a file (for example, the element represents a package or directory).
  - delete
```
public void delete()
            throws IncorrectOperationException
```
    Description copied from interface: PsiElement
    
    Deletes this PSI element from the tree.
    
    Specified by:
    
    delete in interface PsiElement
    
    Throws:
    
    IncorrectOperationException - if the modification is not supported or not possible for some reason (for example, the file containing the element is read-only).
  - checkDelete
```
public void checkDelete()
                 throws IncorrectOperationException
```
    Description copied from interface: PsiElement
    
    Checks if it is possible to delete the specified element from the tree, and throws an exception if the add is not possible. Does not actually modify anything.
    
    Specified by:
    
    checkDelete in interface PsiElement
    
    Throws:
    
    IncorrectOperationException - if the modification is not supported or not possible for some reason.
  - getOriginalFile
```
public PsiFile getOriginalFile()
```
    Description copied from interface: PsiFile
    
    If the file is a non-physical copy of a file, returns the original file which had been copied. Otherwise, returns the same file.
    
    Specified by:
    
    getOriginalFile in interface PsiFile
    
    Returns:
    
    the original file of a copy, or the same file if the file is not a copy.
  - setOriginalFile
```
public void setOriginalFile(PsiFile originalFile)
```
  - getPsiRoots
```
public PsiFile [] getPsiRoots()
```
    Description copied from interface: PsiFile
    
    If the file contains multiple interspersed languages, returns the roots for PSI trees for each of these languages. (For example, a JSPX file contains JSP, XML and Java trees.)
    
    Specified by:
    
    getPsiRoots in interface PsiFile
    
    Returns:
    
    the array of PSI roots, or a single-element array containing this if the file has only a single language.
  - isPhysical
```
public boolean isPhysical()
```
    Description copied from interface: PsiElement
    
    Checks if an actual source or class file corresponds to the element. Non-physical elements include, for example, PSI elements created for the watch expressions in the debugger. Non-physical elements do not generate tree change events. Also, PsiDocumentManager.getDocument(PsiFile) returns null for non-physical elements. Not to be confused with FileViewProvider.isPhysical().
    
    Specified by:
    
    isPhysical in interface PsiElement
    
    Returns:
    
    true if the element is physical, false otherwise.
  - getLanguage
```
public Language getLanguage()
```
    Description copied from interface: PsiElement
    
    Returns the language of the PSI element.
    
    Specified by:
    
    getLanguage in interface PsiElement
    
    Returns:
    
    the language instance.
  - getFileElementType
```
public IFileElementType getFileElementType()
```
    Specified by:
    
    getFileElementType in interface PsiFile
    
    Returns:
    
    the element type of the file node, but possibly in an efficient node that doesn't instantiate the node.
  - getViewProvider
```
public FileViewProvider getViewProvider()
```
    Specified by:
    
    getViewProvider in interface PsiFile
  - setTreeElementPointer
```
public void setTreeElementPointer(FileElement element)
```
  - findElementAt
```
public PsiElement findElementAt(int offset)
```
    Description copied from interface: PsiElement
    
    Finds a leaf PSI element at the specified offset from the start of the text range of this node.
    
    Specified by:
    
    findElementAt in interface PsiElement
    
    Parameters:
    
    offset - the relative offset for which the PSI element is requested.
    
    Returns:
    
    the element at the offset, or null if none is found.
  - findReferenceAt
```
public PsiReference findReferenceAt(int offset)
```
    Description copied from interface: PsiElement
    
    Finds a reference at the specified offset from the start of the text range of this node.
    
    Specified by:
    
    findReferenceAt in interface PsiElement
    
    Parameters:
    
    offset - the relative offset for which the reference is requested.
    
    Returns:
    
    the reference at the offset, or null if none is found.
  - textToCharArray
```
public char [] textToCharArray()
```
    Description copied from interface: PsiElement
    
    Returns the text of the PSI element as a character array.
    
    Specified by:
    
    textToCharArray in interface PsiElement
    
    Returns:
    
    the element text as a character array.
  - findChildrenByClass
```
public <T> T [] findChildrenByClass(java.lang.Class<T> aClass)
```
  - findChildByClass
```
public <T> T findChildByClass(java.lang.Class<T> aClass)
```
  - isTemplateDataFile
```
public boolean isTemplateDataFile()
```
  - getContext
```
public PsiElement getContext()
```
    Description copied from interface: PsiElement
    
    Returns the element which should be used as the parent of this element in a tree up walk during a resolve operation. For most elements, this returns getParent(), but the context can be overridden for some elements like code fragments (see JavaCodeFragmentFactory.createCodeBlockCodeFragment(String, PsiElement, boolean)).
    
    Specified by:
    
    getContext in interface PsiElement
    
    Returns:
    
    the resolve context element.
  - onContentReload
```
public void onContentReload()
```
    Specified by:
    
    onContentReload in interface PsiFileEx
  - getStub
```
public StubElement getStub()
```
    Returns:
    
    a root stub of getStubTree(), or null if the file is not stub-based or AST has been loaded.
  - getGreenStub
```
public final StubElement getGreenStub()
```
    A green stub is a stub object that can co-exist with tree (AST). So, contrary to getStub(), can be non-null even if the AST has been loaded in this file. It can be used in cases when retrieving information from a stub is cheaper than from AST.
    
    Returns:
    
    a stub object corresponding to the file's content, or null if it's not available (e.g. has been garbage-collected)
    
    See Also:
    
    getStub(), getStubTree()
  - getStubTree
```
public StubTree getStubTree()
```
    Specified by:
    
    getStubTree in interface PsiFileWithStubSupport
    
    Returns:
    
    a stub tree, if this file has it, and only if AST isn't loaded
  - derefStub
```
public StubTree derefStub()
```
  - cloneImpl
```
protected PsiFileImpl cloneImpl(FileElement treeElementClone)
```
  - getManager
```
public final PsiManager getManager()
```
    Description copied from interface: PsiElement
    
    Returns the PSI manager for the project to which the PSI element belongs.
    
    Specified by:
    
    getManager in interface PsiElement
    
    Returns:
    
    the PSI manager instance.
  - getNavigationElement
```
public PsiElement getNavigationElement()
```
    Description copied from interface: PsiElement
    
    Returns the PSI element which should be used as a navigation target when navigation to this PSI element is requested. The method can either return this or substitute a different element if this element does not have an associated file and offset. (For example, if the source code of a library is attached to a project, the navigation element for a compiled library class is its source class.)
    
    Specified by:
    
    getNavigationElement in interface PsiElement
    
    Returns:
    
    the navigation target element.
  - getOriginalElement
```
public PsiElement getOriginalElement()
```
    Description copied from interface: PsiElement
    
    Returns the PSI element which corresponds to this element and belongs to either the project source path or class path. The method can either return this or substitute a different element if this element does not belong to the source path or class path. (For example, the original element for a library source file is the corresponding compiled class file.)
    
    Specified by:
    
    getOriginalElement in interface PsiElement
    
    Returns:
    
    the original element.
  - calcTreeElement
```
public final FileElement calcTreeElement()
```
  - getChildren
```
public PsiElement [] getChildren()
```
    Description copied from interface: PsiElement
    
    Returns the array of children for the PSI element. Important: In some implementations children are only composite elements, i.e. not a leaf elements
    
    Specified by:
    
    getChildren in interface PsiElement
    
    Returns:
    
    the array of child elements.
  - getFirstChild
```
public PsiElement getFirstChild()
```
    Description copied from interface: PsiElement
    
    Returns the first child of the PSI element.
    
    Specified by:
    
    getFirstChild in interface PsiElement
    
    Returns:
    
    the first child, or null if the element has no children.
  - getLastChild
```
public PsiElement getLastChild()
```
    Description copied from interface: PsiElement
    
    Returns the last child of the PSI element.
    
    Specified by:
    
    getLastChild in interface PsiElement
    
    Returns:
    
    the last child, or null if the element has no children.
  - acceptChildren
```
public void acceptChildren(PsiElementVisitor visitor)
```
    Description copied from interface: PsiElement
    
    Passes the children of the element to the specified visitor.
    
    Specified by:
    
    acceptChildren in interface PsiElement
    
    Parameters:
    
    visitor - the visitor to pass the children to.
  - getStartOffsetInParent
```
public int getStartOffsetInParent()
```
    Description copied from interface: PsiElement
    
    Returns the text offset of the PSI element relative to its parent.
    
    Specified by:
    
    getStartOffsetInParent in interface PsiElement
    
    Returns:
    
    the relative offset.
  - getTextOffset
```
public int getTextOffset()
```
    Description copied from interface: PsiElement
    
    Returns the offset in the file to which the caret should be placed when performing the navigation to the element. (For classes implementing PsiNamedElement, this should return the offset in the file of the name identifier.)
    
    Specified by:
    
    getTextOffset in interface PsiElement
    
    Returns:
    
    the offset of the PSI element.
  - textMatches
```
public boolean textMatches(java.lang.CharSequence text)
```
    Description copied from interface: PsiElement
    
    Checks if the text of this PSI element is equal to the specified character sequence.
    
    Specified by:
    
    textMatches in interface PsiElement
    
    Parameters:
    
    text - the character sequence to compare with.
    
    Returns:
    
    true if the text is equal, false otherwise.
  - textMatches
```
public boolean textMatches(PsiElement element)
```
    Description copied from interface: PsiElement
    
    Checks if the text of this PSI element is equal to the text of the specified PSI element.
    
    Specified by:
    
    textMatches in interface PsiElement
    
    Parameters:
    
    element - the element to compare the text with.
    
    Returns:
    
    true if the text is equal, false otherwise.
  - textContains
```
public boolean textContains(char c)
```
    Description copied from interface: PsiElement
    
    Checks if the text of this element contains the specified character.
    
    Specified by:
    
    textContains in interface PsiElement
    
    Parameters:
    
    c - the character to search for.
    
    Returns:
    
    true if the character is found, false otherwise.
  - copy
```
public final PsiElement copy()
```
    Description copied from interface: PsiElement
    
    Creates a copy of the file containing the PSI element and returns the corresponding element in the created copy. Resolve operations performed on elements in the copy of the file will resolve to elements in the copy, not in the original file.
    
    Specified by:
    
    copy in interface PsiElement
    
    Returns:
    
    the element in the file copy corresponding to this element.
  - add
```
public PsiElement add(PsiElement element)
               throws IncorrectOperationException
```
    Description copied from interface: PsiElement
    
    Adds a child to this PSI element.
    
    Specified by:
    
    add in interface PsiElement
    
    Parameters:
    
    element - the child element to add.
    
    Returns:
    
    the element which was actually added (either element or its copy).
    
    Throws:
    
    IncorrectOperationException - if the modification is not supported or not possible for some reason.
  - addBefore
```
public PsiElement addBefore(PsiElement element,
                            PsiElement anchor)
                     throws IncorrectOperationException
```
    Description copied from interface: PsiElement
    
    Adds a child to this PSI element, before the specified anchor element.
    
    Specified by:
    
    addBefore in interface PsiElement
    
    Parameters:
    
    element - the child element to add.
    
    anchor - the anchor before which the child element is inserted (must be a child of this PSI element)
    
    Returns:
    
    the element which was actually added (either element or its copy).
    
    Throws:
    
    IncorrectOperationException - if the modification is not supported or not possible for some reason.
  - addAfter
```
public PsiElement addAfter(PsiElement element,
                           PsiElement anchor)
                    throws IncorrectOperationException
```
    Description copied from interface: PsiElement
    
    Adds a child to this PSI element, after the specified anchor element.
    
    Specified by:
    
    addAfter in interface PsiElement
    
    Parameters:
    
    element - the child element to add.
    
    anchor - the anchor after which the child element is inserted (must be a child of this PSI element)
    
    Returns:
    
    the element which was actually added (either element or its copy).
    
    Throws:
    
    IncorrectOperationException - if the modification is not supported or not possible for some reason.
  - checkAdd
```
public final void checkAdd(PsiElement element)
```
    Description copied from interface: PsiElement
    
    Checks if it is possible to add the specified element as a child to this element, and throws an exception if the add is not possible. Does not actually modify anything.
    
    Specified by:
    
    checkAdd in interface PsiElement
    
    Parameters:
    
    element - the child element to check the add possibility.
  - addRange
```
public PsiElement addRange(PsiElement first,
                           PsiElement last)
                    throws IncorrectOperationException
```
    Description copied from interface: PsiElement
    
    Adds a range of elements as children to this PSI element.
    
    Specified by:
    
    addRange in interface PsiElement
    
    Parameters:
    
    first - the first child element to add.
    
    last - the last child element to add (must have the same parent as first)
    
    Returns:
    
    the first child element which was actually added (either first or its copy).
    
    Throws:
    
    IncorrectOperationException - if the modification is not supported or not possible for some reason.
  - addRangeBefore
```
public PsiElement addRangeBefore(PsiElement first,
                                 PsiElement last,
                                 PsiElement anchor)
                          throws IncorrectOperationException
```
    Description copied from interface: PsiElement
    
    Adds a range of elements as children to this PSI element, before the specified anchor element.
    
    Specified by:
    
    addRangeBefore in interface PsiElement
    
    Parameters:
    
    first - the first child element to add.
    
    last - the last child element to add (must have the same parent as first)
    
    anchor - the anchor before which the child element is inserted (must be a child of this PSI element)
    
    Returns:
    
    the first child element which was actually added (either first or its copy).
    
    Throws:
    
    IncorrectOperationException - if the modification is not supported or not possible for some reason.
  - addRangeAfter
```
public PsiElement addRangeAfter(PsiElement first,
                                PsiElement last,
                                PsiElement anchor)
                         throws IncorrectOperationException
```
    Description copied from interface: PsiElement
    
    Adds a range of elements as children to this PSI element, after the specified anchor element.
    
    Specified by:
    
    addRangeAfter in interface PsiElement
    
    Parameters:
    
    first - the first child element to add.
    
    last - the last child element to add (must have the same parent as first)
    
    anchor - the anchor after which the child element is inserted (must be a child of this PSI element)
    
    Returns:
    
    the first child element which was actually added (either first or its copy).
    
    Throws:
    
    IncorrectOperationException - if the modification is not supported or not possible for some reason.
  - deleteChildRange
```
public void deleteChildRange(PsiElement first,
                             PsiElement last)
                      throws IncorrectOperationException
```
    Description copied from interface: PsiElement
    
    Deletes a range of children of this PSI element from the tree.
    
    Specified by:
    
    deleteChildRange in interface PsiElement
    
    Parameters:
    
    first - the first child to delete (must be a child of this PSI element)
    
    last - the last child to delete (must be a child of this PSI element)
    
    Throws:
    
    IncorrectOperationException - if the modification is not supported or not possible for some reason.
  - replace
```
public PsiElement replace(PsiElement newElement)
                   throws IncorrectOperationException
```
    Description copied from interface: PsiElement
    
    Replaces this PSI element (along with all its children) with another element (along with the children).
    
    Specified by:
    
    replace in interface PsiElement
    
    Parameters:
    
    newElement - the element to replace this element with.
    
    Returns:
    
    the element which was actually inserted in the tree (either newElement or its copy)
    
    Throws:
    
    IncorrectOperationException - if the modification is not supported or not possible for some reason.
  - getReference
```
public PsiReference getReference()
```
    Description copied from interface: PsiElement
    
    Returns the reference from this PSI element to another PSI element (or elements), if one exists. If the element has multiple associated references (see PsiElement.getReferences() for an example), returns the first associated reference.
    
    Specified by:
    
    getReference in interface PsiElement
    
    Returns:
    
    the reference instance, or null if the PSI element does not have any associated references.
    
    See Also:
    
    ReferencesSearch
  - getReferences
```
public PsiReference [] getReferences()
```
    Description copied from interface: PsiElement
    
    Returns all references from this PSI element to other PSI elements. An element can have multiple references when, for example, the element is a string literal containing multiple sub-strings which are valid full-qualified class names. If an element contains only one text fragment which acts as a reference but the reference has multiple possible targets, PsiPolyVariantReference should be used instead of returning multiple references.
    Actually, it's preferable to call PsiReferenceService.getReferences(com.intellij.psi.PsiElement, com.intellij.psi.PsiReferenceService.Hints) instead as it allows adding references by plugins when the element implements ContributedReferenceHost.
    
    Specified by:
    
    getReferences in interface PsiElement
    
    Returns:
    
    the array of references, or an empty array if the element has no associated references.
    
    See Also:
    
    PsiReferenceService.getReferences(com.intellij.psi.PsiElement, com.intellij.psi.PsiReferenceService.Hints), ReferencesSearch
  - processDeclarations
```
public boolean processDeclarations(PsiScopeProcessor processor,
                                   ResolveState state,
                                   PsiElement lastParent,
                                   PsiElement place)
```
    Description copied from interface: PsiElement
    
    Passes the declarations contained in this PSI element and its children for processing to the specified scope processor.
    
    Specified by:
    
    processDeclarations in interface PsiElement
    
    Parameters:
    
    processor - the processor receiving the declarations.
    
    lastParent - the child of this element has been processed during the previous step of the tree up walk (declarations under this element do not need to be processed again)
    
    place - the original element from which the tree up walk was initiated.
    
    Returns:
    
    true if the declaration processing should continue or false if it should be stopped.
  - getResolveScope
```
public GlobalSearchScope getResolveScope()
```
    Description copied from interface: PsiElement
    
    Returns the scope in which the declarations for the references in this PSI element are searched.
    
    Specified by:
    
    getResolveScope in interface PsiElement
    
    Returns:
    
    the resolve scope instance.
  - getUseScope
```
public SearchScope getUseScope()
```
    Description copied from interface: PsiElement
    
    Returns the scope in which references to this element are searched.
    
    Specified by:
    
    getUseScope in interface PsiElement
    
    Returns:
    
    the search scope instance.
    
    See Also:
    
    PsiSearchHelper.getUseScope(PsiElement)
  - getPresentation
```
public ItemPresentation getPresentation()
```
    Specified by:
    
    getPresentation in interface NavigationItem
  - navigate
```
public void navigate(boolean requestFocus)
```
    Description copied from interface: Navigatable
    
    Open editor and select/navigate to the object there if possible. Just do nothing if navigation is not possible like in case of a package
    
    Specified by:
    
    navigate in interface Navigatable
    
    Parameters:
    
    requestFocus - true if focus requesting is necessary
  - canNavigate
```
public boolean canNavigate()
```
    Description copied from interface: Navigatable
    
    Indicates whether this instance supports navigation of any kind. Usually this method is called to ensure that navigation is possible. Note that it is not called if navigation to source is supported, i.e. Navigatable.canNavigateToSource() returns true. We assume that this method should return true in such case, so implement this method respectively.
    
    Specified by:
    
    canNavigate in interface Navigatable
    
    Returns:
    
    false if navigation is not possible for any reason.
  - canNavigateToSource
```
public boolean canNavigateToSource()
```
    Description copied from interface: Navigatable
    
    Indicates whether this instance supports navigation to source (that means some kind of editor). Note that navigation can be supported even if this method returns false. In such cases it is not recommended to do batch navigation for all navigatables available via CommonDataKeys.NAVIGATABLE_ARRAY, because it may lead to opening several modal dialogs. Use OpenSourceUtil.navigate(com.intellij.pom.Navigatable...) to process such arrays correctly.
    
    Specified by:
    
    canNavigateToSource in interface Navigatable
    
    Returns:
    
    false if navigation to source is not possible for any reason.
  - getProject
```
public final Project getProject()
```
    Description copied from interface: PsiElement
    
    Returns the project to which the PSI element belongs.
    
    Specified by:
    
    getProject in interface PsiElement
    
    Returns:
    
    the project instance.
  - getNode
```
public FileASTNode getNode()
```
    Description copied from interface: PsiElement
    
    Returns the AST node corresponding to the element.
    
    Specified by:
    
    getNode in interface PsiElement
    
    Specified by:
    
    getNode in interface PsiFile
    
    Returns:
    
    the AST node instance.
  - isEquivalentTo
```
public boolean isEquivalentTo(PsiElement another)
```
    Description copied from interface: PsiElement
    
    This method shouldn't be called by clients directly, because there are no guarantees of it being symmetric. It's called by PsiManager.areElementsEquivalent(PsiElement, PsiElement) internally, which clients should invoke instead.
    Implementations of this method should return true if the parameter is resolve-equivalent to this, i.e. it represents the same entity from the language perspective. See also PsiManager.areElementsEquivalent(PsiElement, PsiElement) documentation.
    
    Specified by:
    
    isEquivalentTo in interface PsiElement
  - getGreenStubTree
```
public final StubTree getGreenStubTree()
```
    Returns:
    
    a stub tree object having getGreenStub() as a root, or null if there's no green stub available
  - calcStubTree
```
public StubTree calcStubTree()
```
  - putInfo
```
public void putInfo(java.util.Map<java.lang.String,java.lang.String> info)
```
    Specified by:
    
    putInfo in interface Queryable
  - putInfo
```
public static void putInfo(PsiFile psiFile,
                           java.util.Map<java.lang.String,java.lang.String> info)
```
  - toString
```
public java.lang.String toString()
```
    Description copied from interface: PsiElement
    
    toString() should never be presented to the user.
    
    Specified by:
    
    toString in interface PsiElement
    
    Overrides:
    
    toString in class java.lang.Object
  - beforeAstChange
```
public final void beforeAstChange()
```

Class PsiFileImpl

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.ui.Queryable

Field Summary

Fields inherited from class com.intellij.psi.impl.ElementBase

Fields inherited from interface com.intellij.psi.impl.PsiFileEx

Fields inherited from interface com.intellij.psi.PsiFile

Fields inherited from interface com.intellij.psi.NavigatablePsiElement

Fields inherited from interface com.intellij.navigation.NavigationItem

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.intellij.psi.PsiFile

Field Detail

myContentElementType

myOriginalFile

myManager

BUILDING_STUB

Constructor Detail

PsiFileImpl

PsiFileImpl

Method Detail

setContentElementType

getContentElementType

init

createContentLeafElement

isDirectory

getTreeElement

getVirtualFile

processChildren

isValid

markInvalidated

isContentsLoaded

assertReadAccessAllowed

getStubbedSpine

getElementTypeForStubBuilder

createFileElement

clearCaches

getText

getTextLength

getTextRange

getNextSibling

getPrevSibling

getModificationStamp

subtreeChanged

clone

getName

setName

checkSetName

isWritable

getParent

getContainingDirectory

getContainingFile

delete

checkDelete

getOriginalFile

setOriginalFile

getPsiRoots

isPhysical

getLanguage

getFileElementType

getViewProvider

setTreeElementPointer

findElementAt

findReferenceAt

textToCharArray

findChildrenByClass

findChildByClass

isTemplateDataFile

getContext

onContentReload

getStub

getGreenStub

getStubTree

derefStub

cloneImpl

getManager

getNavigationElement