Package com.intellij.psi

Interface PsiFile

All Superinterfaces:

Iconable, Navigatable, NavigatablePsiElement, NavigationItem, PsiCheckedRenameElement, PsiElement, PsiFileSystemItem, PsiNamedElement, UserDataHolder

All Known Subinterfaces:

BaseJspFile, GroovyFile, GroovyFileBase, JavaCodeFragment, JsonFile, JspFile, ManifestFile, PsiBinaryFile, PsiClassOwner, PsiClassOwnerEx, PsiCodeFragment, PsiCompiledFile, PsiExpressionCodeFragment, PsiFileEx, PsiFileWithStubSupport, PsiImportHolder, PsiJavaCodeReferenceCodeFragment, PsiJavaFile, PsiJShellFile, PsiLargeBinaryFile, PsiLargeFile, PsiLargeTextFile, PsiPlainTextFile, PsiTypeCodeFragment, PyExpressionCodeFragment, PyFile, RncFile, ServerPageFile, XmlFile, YAMLFile

All Known Implementing Classes:

BuildoutCfgFile, ClsFileImpl, CommandLineFile, DummyHolder, GroovyCodeFragment, GroovyFileBaseImpl, GroovyFileImpl, GroovyShellCodeFragment, HtmlFileImpl, IgnoreFile, JavaDummyHolder, JqlFile, JShellFileImpl, JsonFileImpl, LightPsiFileBase, LightPsiFileImpl, ManifestFileImpl, MarkdownFile, PropertiesFileImpl, PsiBinaryFileImpl, PsiCodeFragmentImpl, PsiExpressionCodeFragmentImpl, PsiFileBase, PsiFileImpl, PsiJavaCodeReferenceCodeFragmentImpl, PsiJavaFileBaseImpl, PsiJavaFileImpl, PsiLargeBinaryFileImpl, PsiLargeTextFileImpl, PsiPlainTextFileImpl, PsiTypeCodeFragmentImpl, PyDocstringFile, PyExpressionCodeFragment, PyExpressionCodeFragmentImpl, PyFileImpl, PyFunctionTypeAnnotationFile, RegExpFile, RestFile, RncFileImpl, ShFile, SPIFile, TextMateFile, XmlFileImpl, XPathFile, YAMLFileImpl, YouTrackFile

public interface PsiFile
extends PsiFileSystemItem

A PSI element representing a file.

Please see PSI Files for high-level overview.

See Also:

CommonDataKeys.PSI_FILE, PsiElement.getContainingFile(), PsiManager.findFile(VirtualFile), PsiDocumentManager.getPsiFile(com.intellij.openapi.editor.Document)

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.util.Iconable

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields

Modifier and Type	Field and Description
static PsiFile[]	EMPTY_ARRAY The empty array of PSI files which can be reused to avoid unnecessary allocations.

Fields inherited from interface com.intellij.psi.PsiElement

ARRAY_FACTORY

Fields inherited from interface com.intellij.openapi.util.Iconable

ICON_FLAG_IGNORE_MASK, ICON_FLAG_OPEN, ICON_FLAG_READ_STATUS, ICON_FLAG_VISIBILITY

Fields inherited from interface com.intellij.psi.NavigatablePsiElement

EMPTY_NAVIGATABLE_ELEMENT_ARRAY

Fields inherited from interface com.intellij.navigation.NavigationItem

EMPTY_NAVIGATION_ITEM_ARRAY

Method Summary

Modifier and Type	Method and Description
default void	clearCaches() Invalidate any file-specific cache in this method.
PsiDirectory	getContainingDirectory() Returns the directory containing the file.
default IFileElementType	getFileElementType()
FileType	getFileType() Returns the file type for the file.
long	getModificationStamp() Gets the modification stamp value.
FileASTNode	getNode() Returns the AST node corresponding to the element.
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.
PsiFile []	getPsiRoots() Deprecated. Use FileViewProvider.getAllFiles() instead.
FileViewProvider	getViewProvider()
VirtualFile	getVirtualFile() Returns the virtual file corresponding to the PSI file.
void	subtreeChanged() Called by the PSI framework when the contents of the file changes.

Methods inherited from interface com.intellij.psi.PsiFileSystemItem

getName, isDirectory, processChildren

Methods inherited from interface com.intellij.psi.PsiCheckedRenameElement

checkSetName

Methods inherited from interface com.intellij.psi.PsiNamedElement

setName

Methods inherited from interface com.intellij.psi.PsiElement

accept, acceptChildren, add, addAfter, addBefore, addRange, addRangeAfter, addRangeBefore, checkAdd, checkDelete, copy, delete, deleteChildRange, findElementAt, findReferenceAt, getChildren, getContainingFile, getContext, getCopyableUserData, getFirstChild, getLanguage, getLastChild, getManager, getNavigationElement, getNextSibling, getOriginalElement, getOwnReferences, getPrevSibling, getProject, getReference, getReferences, getResolveScope, getStartOffsetInParent, getText, getTextLength, getTextOffset, getTextRange, getTextRangeInParent, getUseScope, isEquivalentTo, isPhysical, isValid, isWritable, processDeclarations, putCopyableUserData, replace, textContains, textMatches, textMatches, textToCharArray, toString

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Methods inherited from interface com.intellij.openapi.util.Iconable

getIcon

Methods inherited from interface com.intellij.navigation.NavigationItem

getPresentation

Methods inherited from interface com.intellij.pom.Navigatable

canNavigate, canNavigateToSource, navigate

Field Detail

EMPTY_ARRAY

static final PsiFile[] EMPTY_ARRAY

The empty array of PSI files which can be reused to avoid unnecessary allocations.

Method Detail

getVirtualFile

VirtualFile getVirtualFile()

Returns the virtual file corresponding to the PSI file.

Specified by:

getVirtualFile in interface PsiFileSystemItem

Returns:

the virtual file, or null if the file exists only in memory.

getContainingDirectory

PsiDirectory getContainingDirectory()

Returns the directory containing the file.

Returns:

the containing directory, or null if the file exists only in memory.

getParent

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 PsiFileSystemItem

Returns:

the parent of the element, or null if the element has no parent.

getModificationStamp

long getModificationStamp()

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.

Returns:

the modification stamp value

See Also:

VirtualFile.getModificationStamp()

getOriginalFile

PsiFile getOriginalFile()

If the file is a non-physical copy of a file, returns the original file which had been copied. Otherwise, returns the same file.

Returns:

the original file of a copy, or the same file if the file is not a copy.

getFileType

FileType getFileType()

Returns the file type for the file.

Returns:

the file type instance.

getPsiRoots

@Deprecated
PsiFile [] getPsiRoots()

Deprecated. Use FileViewProvider.getAllFiles() instead.

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.)

Returns:

the array of PSI roots, or a single-element array containing this if the file has only a single language.

getViewProvider

FileViewProvider getViewProvider()

getNode

FileASTNode getNode()

Description copied from interface: PsiElement

Returns the AST node corresponding to the element.

Specified by:

getNode in interface PsiElement

Returns:

the AST node instance.

subtreeChanged

void subtreeChanged()

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 clearCaches() since file contents can be reloaded completely (without any specific subtree change) without this method being called.

clearCaches

default void clearCaches()

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.

getFileElementType

default IFileElementType getFileElementType()

Returns:

the element type of the file node, but possibly in an efficient node that doesn't instantiate the node.