Package com.intellij.spi.psi

Class SPIFile

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.source.PsiFileImpl

com.intellij.extapi.psi.PsiFileBase

com.intellij.spi.psi.SPIFile

All Implemented Interfaces:

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

public class SPIFile
extends PsiFileBase

Nested Class Summary

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

Queryable.Contributor, Queryable.PrintInfo, Queryable.Util

Field Summary

Fields inherited from class com.intellij.psi.impl.source.PsiFileImpl

BUILDING_STUB, myContentElementType, myManager, 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

Constructor and Description
SPIFile(FileViewProvider viewProvider)

Method Summary

Modifier and Type	Method and Description
FileType	getFileType() Returns the file type for the file.
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.

Methods inherited from class com.intellij.extapi.psi.PsiFileBase

accept, getLanguage, getParserDefinition

Methods inherited from class com.intellij.psi.impl.source.PsiFileImpl

acceptChildren, add, addAfter, addBefore, addRange, addRangeAfter, addRangeBefore, assertReadAccessAllowed, beforeAstChange, calcStubTree, calcTreeElement, canNavigate, canNavigateToSource, checkAdd, checkDelete, checkSetName, clearCaches, clone, cloneImpl, copy, createContentLeafElement, createFileElement, delete, deleteChildRange, derefStub, findChildByClass, findChildrenByClass, findElementAt, findReferenceAt, getChildren, getContainingDirectory, getContainingFile, getContentElementType, getContext, getElementTypeForStubBuilder, getFileElementType, getFirstChild, getGreenStub, getGreenStubTree, getLastChild, getManager, getModificationStamp, getName, getNavigationElement, getNextSibling, getNode, getOriginalElement, getOriginalFile, getParent, getPresentation, getPrevSibling, getProject, getPsiRoots, getResolveScope, getStartOffsetInParent, getStub, getStubbedSpine, getStubTree, getText, getTextLength, getTextOffset, getTextRange, getTreeElement, getUseScope, getViewProvider, getVirtualFile, init, isContentsLoaded, isDirectory, isEquivalentTo, isPhysical, isTemplateDataFile, isValid, isWritable, markInvalidated, navigate, onContentReload, processChildren, processDeclarations, putInfo, putInfo, replace, setContentElementType, setName, setOriginalFile, setTreeElementPointer, subtreeChanged, textContains, textMatches, textMatches, textToCharArray, toString

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

Constructor Detail

SPIFile

public SPIFile(FileViewProvider viewProvider)

Method Detail

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

Overrides:

getReference in class PsiFileImpl

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

Overrides:

getReferences in class PsiFileImpl

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

getFileType

public FileType getFileType()

Description copied from interface: PsiFile

Returns the file type for the file.

Returns:

the file type instance.