Package com.intellij.psi.impl.compiled

Class ClsFileImpl

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.PsiElementBase

com.intellij.psi.impl.file.PsiBinaryFileImpl

com.intellij.psi.impl.compiled.ClsFileImpl

All Implemented Interfaces:

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

public class ClsFileImpl
extends PsiBinaryFileImpl
implements PsiJavaFile, PsiFileWithStubSupport, PsiFileEx, Queryable, PsiClassOwnerEx, PsiCompiledFile

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 Attribute[]	EMPTY_ATTRIBUTES

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

Constructor Summary

Constructors

Constructor and Description
ClsFileImpl(FileViewProvider viewProvider)

Method Summary

Modifier and Type	Method and Description
void	accept(PsiElementVisitor visitor) Passes the element to the specified visitor.
void	appendMirrorText(int indentLevel, java.lang.StringBuilder buffer) Deprecated. Shouldn't be called from outside or overridden
static PsiJavaFileStub	buildFileStub(VirtualFile file, byte [] bytes)
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.
static java.lang.CharSequence	decompile(VirtualFile file)
PsiElement	findElementAt(int offset) Finds a leaf PSI element at the specified offset from the start of the text range of this node.
PsiJavaCodeReferenceElement	findImportReferenceTo(PsiClass aClass) Returns the single-class import statement which references the specified class, or null if there is no such statement.
PsiReference	findReferenceAt(int offset) Finds a reference at the specified offset from the start of the text range of this node.
PsiFile	getCachedMirror()
PsiElement []	getChildren() Returns the array of children for the PSI element.
PsiClass []	getClasses()
java.util.Set<java.lang.String>	getClassNames()
PsiFile	getContainingFile() Returns the file containing the PSI element.
PsiFile	getDecompiledPsiFile()
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()
PsiElement	getMirror() Returns the corresponding PSI element in a decompiled file created by the IDE from the library element.
PsiJavaModule	getModuleDeclaration() Returns a Java module declaration element, or null if the file is not a module-info one.
PsiElement	getNavigationElement() Returns the PSI element which should be used as a navigation target when navigation to this PSI element is requested.
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.
int	getStartOffsetInParent() Returns the text offset of the PSI element relative to its parent.
PsiClassHolderFileStub<?>	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.
boolean	importClass(PsiClass aClass) Adds an import statement for importing the specified class.
boolean	isContentsLoaded()
boolean	isValid() Checks if this PSI element is valid.
void	onContentReload()
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)
void	setMirror(TreeElement element) Deprecated. Shouldn't be called from outside or overridden
PsiElement	setName(java.lang.String name) Renames the element.
void	setPackageName(java.lang.String packageName)
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.file.PsiBinaryFileImpl

add, addAfter, addBefore, checkAdd, checkDelete, copy, delete, getContainingDirectory, getContext, getFileType, getManager, getModificationStamp, getName, getNode, getOriginalFile, getParent, getParentDirectory, getPsiRoots, getViewProvider, getVirtualFile, isDirectory, isPhysical, isWritable, markInvalidated, processChildren, replace, subtreeChanged, textMatches, textMatches

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

acceptChildren, addRange, addRangeAfter, addRangeBefore, canNavigate, canNavigateToSource, deleteChildRange, findChildByClass, findChildrenByClass, findNotNullChildByClass, getFirstChild, getLastChild, getNextSibling, getOriginalElement, getPresentation, getPrevSibling, getProject, getReference, getReferences, getResolveScope, getUseScope, isEquivalentTo, navigate, notNullChild, textContains

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, 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, wait, wait, wait

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

markInvalidated

Field Detail

EMPTY_ATTRIBUTES

public static final Attribute[] EMPTY_ATTRIBUTES

Constructor Detail

ClsFileImpl

public ClsFileImpl(FileViewProvider viewProvider)

Method Detail

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

Overrides:

getContainingFile in class PsiBinaryFileImpl

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

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

Overrides:

isValid in class PsiBinaryFileImpl

Returns:

true if the element is valid, false otherwise.

See Also:

PsiUtilCore.ensureValid(PsiElement)

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 PsiBinaryFileImpl

Returns:

the language instance.

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

Overrides:

getChildren in class PsiBinaryFileImpl

Returns:

the array of child elements.

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.

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.

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.

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.

getClassNames

public java.util.Set<java.lang.String> getClassNames()

Specified by:

getClassNames in interface PsiClassOwnerEx

Returns:

a set of the short names of the top-level classes defined in this file, as this may be faster than getName() for each of getClasses()

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.

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.

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

setName

public PsiElement setName(java.lang.String name)
                   throws IncorrectOperationException

Description copied from interface: PsiNamedElement

Renames the element.

Specified by:

setName in interface PsiNamedElement

Overrides:

setName in class PsiBinaryFileImpl

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)
                  throws IncorrectOperationException

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

Overrides:

checkSetName in class PsiBinaryFileImpl

Parameters:

name - the new name to check the renaming possibility for.

Throws:

IncorrectOperationException - if the rename is not supported or not possible for some reason.

appendMirrorText

@Deprecated
public void appendMirrorText(int indentLevel,
                             java.lang.StringBuilder buffer)

Deprecated. Shouldn't be called from outside or overridden

setMirror

@Deprecated
public void setMirror(TreeElement element)
               throws ClsElementImpl.InvalidMirrorException

Deprecated. Shouldn't be called from outside or overridden

Throws:

ClsElementImpl.InvalidMirrorException

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

Overrides:

getNavigationElement in class PsiElementBase

Returns:

the navigation target element.

getMirror

public PsiElement getMirror()

Description copied from interface: PsiCompiledElement

Returns the corresponding PSI element in a decompiled file created by the IDE from the library element.

Specified by:

getMirror in interface PsiCompiledElement

Returns:

the counterpart of the element in decompiled file.

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

Overrides:

getText in class PsiBinaryFileImpl

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

Overrides:

getTextLength in class PsiBinaryFileImpl

Returns:

the text length.

getDecompiledPsiFile

public PsiFile getDecompiledPsiFile()

Specified by:

getDecompiledPsiFile in interface PsiCompiledFile

getCachedMirror

public PsiFile getCachedMirror()

accept

public void accept(PsiElementVisitor visitor)

Description copied from interface: PsiElement

Passes the element to the specified visitor.

Specified by:

accept in interface PsiElement

Overrides:

accept in class PsiBinaryFileImpl

Parameters:

visitor - the visitor to pass the element to.

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 PsiBinaryFileImpl

getTextRange

public final 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

Overrides:

getTextRange in class PsiBinaryFileImpl

Returns:

the text range.

getStartOffsetInParent

public final 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

Overrides:

getStartOffsetInParent in class PsiBinaryFileImpl

Returns:

the relative offset.

findElementAt

public final 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

Overrides:

findElementAt in class PsiBinaryFileImpl

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

Overrides:

findReferenceAt in class PsiElementBase

Parameters:

offset - the relative offset for which the reference is requested.

Returns:

the reference at the offset, or null if none is found.

getTextOffset

public final 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

Overrides:

getTextOffset in class PsiBinaryFileImpl

Returns:

the offset of the PSI element.

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

Overrides:

textToCharArray in class PsiBinaryFileImpl

Returns:

the element text as a character array.

getStub

public PsiClassHolderFileStub<?> getStub()

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 PsiElementBase

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.

getStubTree

public StubTree getStubTree()

Specified by:

getStubTree in interface PsiFileWithStubSupport

Returns:

the stub tree for this file, if it's stub-based at all. Will be null after the AST has been loaded (e.g. by calling PsiElement.getNode() or PsiElement.getText().

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

isContentsLoaded

public boolean isContentsLoaded()

Specified by:

isContentsLoaded in interface PsiFileEx

Overrides:

isContentsLoaded in class PsiBinaryFileImpl

onContentReload

public void onContentReload()

Specified by:

onContentReload in interface PsiFileEx

Overrides:

onContentReload in class PsiBinaryFileImpl

putInfo

public void putInfo(java.util.Map<java.lang.String,java.lang.String> info)

Specified by:

putInfo in interface Queryable

Overrides:

putInfo in class PsiBinaryFileImpl

decompile

public static java.lang.CharSequence decompile(VirtualFile file)

buildFileStub

public static PsiJavaFileStub buildFileStub(VirtualFile file,
                                            byte [] bytes)
                                     throws ClsFormatException

Throws:

ClsFormatException