Package com.intellij.psi.impl.source

Class PsiJavaFileBaseImpl

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.source.PsiFileImpl

com.intellij.psi.impl.source.PsiJavaFileBaseImpl

All Implemented Interfaces:

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

Direct Known Subclasses:

JShellFileImpl, PsiJavaFileImpl

public abstract class PsiJavaFileBaseImpl
extends PsiFileImpl
implements PsiJavaFile

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

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

BATCH_REFERENCE_PROCESSING

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PsiJavaFileBaseImpl(IElementType elementType, IElementType contentElementType, FileViewProvider viewProvider)

Method Summary

Modifier and Type	Method and Description
void	accept(PsiElementVisitor visitor) Passes the element to the specified visitor.
void	clearCaches() Invalidate any file-specific cache in this method.
PsiJavaCodeReferenceElement	findImportReferenceTo(PsiClass aClass) Returns the single-class import statement which references the specified class, or null if there is no such statement.
PsiClass []	getClasses()
PsiJavaCodeReferenceElement []	getImplicitlyImportedPackageReferences() returns the list of reference elements for the implicitly imported packages (for example, java.lang).
java.lang.String []	getImplicitlyImportedPackages() Returns the list of names of implicitly imported packages (for example, java.lang).
PsiImportList	getImportList() Returns the import list contained in the file.
Language	getLanguage() Returns the language of the PSI element.
LanguageLevel	getLanguageLevel()
PsiJavaModule	getModuleDeclaration() Returns a Java module declaration element, or null if the file is not a module-info one.
PsiElement []	getOnDemandImports(boolean includeImplicit, boolean checkIncludes) Returns the list of classes or packages which have been imported on demand (for example, javax.swing.*)
java.lang.String	getPackageName() Returns the name of the package to which the file belongs.
PsiPackageStatement	getPackageStatement() Returns the package statement contained in the file.
PsiClass []	getSingleClassImports(boolean checkIncludes) Returns the list of classes which have been imported as single-class imports.
boolean	importClass(PsiClass aClass) Adds an import statement for importing the specified class.
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	setOriginalFile(PsiFile originalFile)
void	setPackageName(java.lang.String packageName)
void	subtreeChanged() Called by the PSI framework when the contents of the file changes.

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, 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, getReference, getReferences, 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, putInfo, putInfo, replace, setContentElementType, setName, setTreeElementPointer, 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

Methods inherited from interface com.intellij.psi.PsiFile

getContainingDirectory, getFileElementType, getFileType, getModificationStamp, getNode, getOriginalFile, getParent, getPsiRoots, getViewProvider, getVirtualFile

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.navigation.NavigationItem

getPresentation

Methods inherited from interface com.intellij.pom.Navigatable

canNavigate, canNavigateToSource, navigate

Constructor Detail

PsiJavaFileBaseImpl

protected PsiJavaFileBaseImpl(IElementType elementType,
                              IElementType contentElementType,
                              FileViewProvider viewProvider)

Method Detail

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

Overrides:

subtreeChanged in class PsiFileImpl

getClasses

public PsiClass [] getClasses()

Specified by:

getClasses in interface PsiClassOwner

Returns:

classes owned by this element.

getPackageStatement

public PsiPackageStatement getPackageStatement()

Description copied from interface: PsiJavaFile

Returns the package statement contained in the file.

Specified by:

getPackageStatement in interface PsiJavaFile

Returns:

the package statement, or null if one is missing.

getPackageName

public java.lang.String getPackageName()

Description copied from interface: PsiJavaFile

Returns the name of the package to which the file belongs.

Specified by:

getPackageName in interface PsiClassOwner

Specified by:

getPackageName in interface PsiJavaFile

Returns:

the name specified in the package statement, or an empty string for a JSP page or file which has no package statement.

setPackageName

public void setPackageName(java.lang.String packageName)
                    throws IncorrectOperationException

Specified by:

setPackageName in interface PsiClassOwner

Throws:

IncorrectOperationException

getImportList

public PsiImportList getImportList()

Description copied from interface: PsiJavaFile

Returns the import list contained in the file.

Specified by:

getImportList in interface PsiJavaFile

Returns:

the import list, or null if this element represents a compiled class.

getOnDemandImports

public PsiElement [] getOnDemandImports(boolean includeImplicit,
                                        boolean checkIncludes)

Description copied from interface: PsiJavaFile

Returns the list of classes or packages which have been imported on demand (for example, javax.swing.*)

Specified by:

getOnDemandImports in interface PsiJavaFile

Parameters:

includeImplicit - if true, implicitly imported packages (like java.lang) are included.

checkIncludes - deprecated, no longer used

Returns:

the list of PsiClass or PsiPackage elements for the imports.

getSingleClassImports

public PsiClass [] getSingleClassImports(boolean checkIncludes)

Description copied from interface: PsiJavaFile

Returns the list of classes which have been imported as single-class imports.

Specified by:

getSingleClassImports in interface PsiJavaFile

Parameters:

checkIncludes - deprecated, no longer used.

Returns:

the list of PsiClass elements for the import.

findImportReferenceTo

public PsiJavaCodeReferenceElement findImportReferenceTo(PsiClass aClass)

Description copied from interface: PsiJavaFile

Returns the single-class import statement which references the specified class, or null if there is no such statement.

Specified by:

findImportReferenceTo in interface PsiJavaFile

Parameters:

aClass - the class to return the import statement for.

Returns:

the Java code reference under the import statement, or null if there is no such statement.

getImplicitlyImportedPackages

public java.lang.String [] getImplicitlyImportedPackages()

Description copied from interface: PsiJavaFile

Returns the list of names of implicitly imported packages (for example, java.lang).

Specified by:

getImplicitlyImportedPackages in interface PsiJavaFile

Returns:

the list of implicitly imported package names.

getImplicitlyImportedPackageReferences

public PsiJavaCodeReferenceElement [] getImplicitlyImportedPackageReferences()

Description copied from interface: PsiJavaFile

returns the list of reference elements for the implicitly imported packages (for example, java.lang).

Specified by:

getImplicitlyImportedPackageReferences in interface PsiJavaFile

Returns:

the list of implicitly imported package reference elements.

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

Overrides:

processDeclarations in class PsiFileImpl

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.

accept

public void accept(PsiElementVisitor visitor)

Description copied from interface: PsiElement

Passes the element to the specified visitor.

Specified by:

accept in interface PsiElement

Parameters:

visitor - the visitor to pass the element to.

getLanguage

public Language getLanguage()

Description copied from interface: PsiElement

Returns the language of the PSI element.

Specified by:

getLanguage in interface PsiElement

Overrides:

getLanguage in class PsiFileImpl

Returns:

the language instance.

importClass

public boolean importClass(PsiClass aClass)

Description copied from interface: PsiImportHolder

Adds an import statement for importing the specified class.

Specified by:

importClass in interface PsiImportHolder

Parameters:

aClass - the class to import.

Returns:

true if the import statement was added successfully, false otherwise.

getLanguageLevel

public LanguageLevel getLanguageLevel()

Specified by:

getLanguageLevel in interface PsiJavaFile

getModuleDeclaration

public PsiJavaModule getModuleDeclaration()

Description copied from interface: PsiJavaFile

Returns a Java module declaration element, or null if the file is not a module-info one.

Specified by:

getModuleDeclaration in interface PsiJavaFile

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

Overrides:

clearCaches in class PsiFileImpl

setOriginalFile

public void setOriginalFile(PsiFile originalFile)

Overrides:

setOriginalFile in class PsiFileImpl