Package com.intellij.psi.impl.file

Class PsiPackageImpl

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.PsiElementBase

com.intellij.psi.impl.file.PsiPackageBase

com.intellij.psi.impl.file.PsiPackageImpl

All Implemented Interfaces:

JvmAnnotatedElement, JvmElement, JvmModifiersOwner, JvmNamedElement, JvmPackage, NavigationItem, Queryable, Iconable, UserDataHolder, UserDataHolderEx, Navigatable, NavigatablePsiElement, PsiCheckedRenameElement, PsiDirectoryContainer, PsiElement, PsiJvmModifiersOwner, PsiModifierListOwner, PsiNamedElement, PsiPackage, PsiQualifiedNamedElement, java.lang.Cloneable

Direct Known Subclasses:

MigrationPackageImpl

public class PsiPackageImpl
extends PsiPackageBase
implements PsiPackage, Queryable

Nested Class Summary

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

Iconable.IconFlags, Iconable.LastComputedIcon

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

FLAGS_LOCKED, ICON_PLACEHOLDER

Fields inherited from interface com.intellij.psi.PsiPackage

EMPTY_ARRAY, PACKAGE_INFO_CLASS, PACKAGE_INFO_CLS_FILE, PACKAGE_INFO_FILE

Fields inherited from interface com.intellij.navigation.NavigationItem

EMPTY_NAVIGATION_ITEM_ARRAY

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

Constructor Summary

Constructors

Constructor and Description
PsiPackageImpl(PsiManager manager, java.lang.String qualifiedName)

Method Summary

Modifier and Type	Method and Description
void	accept(PsiElementVisitor visitor) Passes the element to the specified visitor.
protected GlobalSearchScope	allScope()
boolean	canNavigate() Indicates whether this instance supports navigation of any kind.
boolean	containsClassNamed(java.lang.String name)
PsiClass []	findClassByShortName(java.lang.String name, GlobalSearchScope scope)
protected PsiPackageImpl	findPackage(java.lang.String qName)
protected java.util.Collection<PsiDirectory>	getAllDirectories(boolean includeLibrarySources)
PsiModifierList	getAnnotationList() Returns the list of package-level annotations for the package.
PsiClass []	getClasses() Returns the list of classes in all directories corresponding to the package.
PsiClass []	getClasses(GlobalSearchScope scope) Returns the list of classes in directories corresponding to the package in the specified search scope.
PsiFile []	getFiles(GlobalSearchScope scope) Returns the list of all files in the package, restricted by the specified scope.
Language	getLanguage() Returns the language of the PSI element.
PsiModifierList	getModifierList() Returns the list of modifiers for the element.
PsiPackageImpl	getParentPackage() Returns the parent of the package.
ItemPresentation	getPresentation()
PsiPackage []	getSubPackages() Returns the list of subpackages of this package under all source roots of the project.
PsiPackage []	getSubPackages(GlobalSearchScope scope) Returns the list of subpackages of this package in the specified search scope.
void	handleQualifiedNameChange(java.lang.String newQualifiedName) This method must be invoked on the package after all directories corresponding to it have been renamed/moved accordingly to qualified name change.
boolean	hasModifierProperty(java.lang.String name) Checks if the element has the specified modifier.
boolean	isValid() Checks if this PSI element is valid.
boolean	mayHaveContentInScope(GlobalSearchScope scope)
void	navigate(boolean requestFocus) Open editor and select/navigate to the object there if possible.
VirtualFile []	occursInPackagePrefixes() Returns source roots that this package occurs in package prefixes of.
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.
java.lang.String	toString() toString() should never be presented to the user.

Methods inherited from class com.intellij.psi.impl.file.PsiPackageBase

add, addAfter, addBefore, canNavigateToSource, checkAdd, checkDelete, checkSetName, copy, delete, equals, findElementAt, getAllDirectories, getChildren, getContainingFile, getDirectories, getDirectories, getElementIcon, getManager, getName, getNode, getParent, getQualifiedName, getStartOffsetInParent, getText, getTextLength, getTextOffset, getTextRange, hashCode, isPhysical, isWritable, putInfo, replace, setName, textMatches, textMatches, textToCharArray

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

acceptChildren, addRange, addRangeAfter, addRangeBefore, deleteChildRange, findChildByClass, findChildrenByClass, findNotNullChildByClass, findReferenceAt, getContext, getFirstChild, getLastChild, getNavigationElement, getNextSibling, getOriginalElement, getPrevSibling, getProject, getReference, getReferences, getResolveScope, getUseScope, isEquivalentTo, notNullChild, textContains

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

buildRowIcon, computeBaseIcon, createLayeredIcon, getAdjustedBaseIcon, getBaseIcon, 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

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.intellij.psi.PsiPackage

getName, getQualifiedName

Methods inherited from interface com.intellij.psi.PsiCheckedRenameElement

checkSetName

Methods inherited from interface com.intellij.pom.Navigatable

canNavigateToSource

Methods inherited from interface com.intellij.psi.PsiJvmModifiersOwner

getAnnotation, getAnnotations, getSourceElement, hasAnnotation, hasModifier

Methods inherited from interface com.intellij.lang.jvm.JvmElement

accept

Methods inherited from interface com.intellij.psi.PsiDirectoryContainer

getDirectories, getDirectories

Methods inherited from interface com.intellij.psi.PsiNamedElement

setName

Methods inherited from interface com.intellij.psi.PsiElement

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

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.openapi.ui.Queryable

putInfo

Constructor Detail

PsiPackageImpl

public PsiPackageImpl(PsiManager manager,
                      java.lang.String qualifiedName)

Method Detail

getAllDirectories

protected java.util.Collection<PsiDirectory> getAllDirectories(boolean includeLibrarySources)

Specified by:

getAllDirectories in class PsiPackageBase

findPackage

protected PsiPackageImpl findPackage(java.lang.String qName)

Specified by:

findPackage in class PsiPackageBase

handleQualifiedNameChange

public void handleQualifiedNameChange(java.lang.String newQualifiedName)

Description copied from interface: PsiPackage

This method must be invoked on the package after all directories corresponding to it have been renamed/moved accordingly to qualified name change.

Specified by:

handleQualifiedNameChange in interface PsiPackage

Parameters:

newQualifiedName - the new qualified name of the package.

occursInPackagePrefixes

public VirtualFile [] occursInPackagePrefixes()

Description copied from interface: PsiPackage

Returns source roots that this package occurs in package prefixes of.

Specified by:

occursInPackagePrefixes in interface PsiPackage

Returns:

the array of virtual files for the source roots.

getParentPackage

public PsiPackageImpl getParentPackage()

Description copied from interface: PsiPackage

Returns the parent of the package.

Specified by:

getParentPackage in interface JvmPackage

Specified by:

getParentPackage in interface PsiPackage

Overrides:

getParentPackage in class PsiPackageBase

Returns:

the parent package, or null for the default package.

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.

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 PsiElementBase

Returns:

true if the element is valid, false otherwise.

See Also:

PsiUtilCore.ensureValid(PsiElement)

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 PsiElementBase

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 PsiPackageBase

getClasses

public PsiClass [] getClasses()

Description copied from interface: PsiPackage

Returns the list of classes in all directories corresponding to the package.

Specified by:

getClasses in interface PsiPackage

Returns:

the array of classes.

allScope

protected GlobalSearchScope allScope()

getClasses

public PsiClass [] getClasses(GlobalSearchScope scope)

Description copied from interface: PsiPackage

Returns the list of classes in directories corresponding to the package in the specified search scope.

Specified by:

getClasses in interface PsiPackage

Parameters:

scope - the scope in which directories are searched.

Returns:

the array of classes.

getFiles

public PsiFile [] getFiles(GlobalSearchScope scope)

Description copied from interface: PsiPackage

Returns the list of all files in the package, restricted by the specified scope. (This is normally the list of all files in all directories corresponding to the package, but it can be modified by custom language plugins which have a different notion of packages.)

Specified by:

getFiles in interface PsiPackage

getAnnotationList

public PsiModifierList getAnnotationList()

Description copied from interface: PsiPackage

Returns the list of package-level annotations for the package.

Specified by:

getAnnotationList in interface PsiPackage

Returns:

the list of annotations, or null if the package does not have any package-level annotations.

getSubPackages

public PsiPackage [] getSubPackages()

Description copied from interface: PsiPackage

Returns the list of subpackages of this package under all source roots of the project.

Specified by:

getSubPackages in interface PsiPackage

Returns:

the array of subpackages.

getSubPackages

public PsiPackage [] getSubPackages(GlobalSearchScope scope)

Description copied from interface: PsiPackage

Returns the list of subpackages of this package in the specified search scope.

Specified by:

getSubPackages in interface PsiPackage

Parameters:

scope - the scope in which packages are searched.

Returns:

the array of subpackages.

containsClassNamed

public boolean containsClassNamed(java.lang.String name)

Specified by:

containsClassNamed in interface PsiPackage

findClassByShortName

public PsiClass [] findClassByShortName(java.lang.String name,
                                        GlobalSearchScope scope)

Specified by:

findClassByShortName in interface PsiPackage

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.

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

Overrides:

canNavigate in class PsiPackageBase

Returns:

false if navigation is not possible for any reason.

getPresentation

public ItemPresentation getPresentation()

Specified by:

getPresentation in interface NavigationItem

Overrides:

getPresentation in class PsiElementBase

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

Overrides:

navigate in class PsiElementBase

Parameters:

requestFocus - true if focus requesting is necessary

mayHaveContentInScope

public boolean mayHaveContentInScope(GlobalSearchScope scope)

getModifierList

public PsiModifierList getModifierList()

Description copied from interface: PsiModifierListOwner

Returns the list of modifiers for the element.

Specified by:

getModifierList in interface PsiModifierListOwner

Returns:

the list of modifiers, or null if the element (for example, an anonymous inner class) does not have the list of modifiers.

hasModifierProperty

public boolean hasModifierProperty(java.lang.String name)

Description copied from interface: PsiModifierListOwner

Checks if the element has the specified modifier. Possible modifiers are defined as constants in the PsiModifier class.

Specified by:

hasModifierProperty in interface PsiModifierListOwner

Parameters:

name - the name of the modifier to check.

Returns:

true if the element has the modifier, false otherwise