Package com.intellij.psi

Interface PsiPackage

All Superinterfaces:

Iconable, JvmAnnotatedElement, JvmElement, JvmModifiersOwner, JvmNamedElement, JvmPackage, Navigatable, NavigationItem, PsiCheckedRenameElement, PsiDirectoryContainer, PsiElement, PsiJvmModifiersOwner, PsiModifierListOwner, PsiNamedElement, PsiQualifiedNamedElement, UserDataHolder

All Known Implementing Classes:

MigrationPackageImpl, PsiPackageImpl

public interface PsiPackage
extends PsiCheckedRenameElement, NavigationItem, PsiJvmModifiersOwner, PsiDirectoryContainer, PsiQualifiedNamedElement, JvmPackage

Represents a Java package.

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 PsiPackage[]	EMPTY_ARRAY
static java.lang.String	PACKAGE_INFO_CLASS
static java.lang.String	PACKAGE_INFO_CLS_FILE
static java.lang.String	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

Method Summary

Modifier and Type	Method and Description
boolean	containsClassNamed(java.lang.String name)
PsiClass []	findClassByShortName(java.lang.String name, GlobalSearchScope scope)
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.
java.lang.String	getName() Returns the name of the element.
PsiPackage	getParentPackage() Returns the parent of the package.
java.lang.String	getQualifiedName() Returns the full-qualified name of the package.
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.
VirtualFile []	occursInPackagePrefixes() Returns source roots that this package occurs in package prefixes of.

Methods inherited from interface com.intellij.psi.PsiCheckedRenameElement

checkSetName

Methods inherited from interface com.intellij.navigation.NavigationItem

getPresentation

Methods inherited from interface com.intellij.pom.Navigatable

canNavigate, canNavigateToSource, navigate

Methods inherited from interface com.intellij.psi.PsiJvmModifiersOwner

getAnnotation, getAnnotations, getSourceElement, hasAnnotation, hasModifier

Methods inherited from interface com.intellij.psi.PsiModifierListOwner

getModifierList, hasModifierProperty

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

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, getNode, getOriginalElement, getOwnReferences, getParent, 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

Field Detail

PACKAGE_INFO_CLASS

static final java.lang.String PACKAGE_INFO_CLASS

See Also:

Constant Field Values

PACKAGE_INFO_FILE

static final java.lang.String PACKAGE_INFO_FILE

See Also:

Constant Field Values

PACKAGE_INFO_CLS_FILE

static final java.lang.String PACKAGE_INFO_CLS_FILE

See Also:

Constant Field Values

EMPTY_ARRAY

static final PsiPackage[] EMPTY_ARRAY

Method Detail

getQualifiedName

java.lang.String getQualifiedName()

Returns the full-qualified name of the package.

Specified by:

getQualifiedName in interface JvmPackage

Specified by:

getQualifiedName in interface PsiQualifiedNamedElement

Returns:

the full-qualified name, or an empty string for the default package.

getParentPackage

PsiPackage getParentPackage()

Returns the parent of the package.

Specified by:

getParentPackage in interface JvmPackage

Returns:

the parent package, or null for the default package.

getSubPackages

PsiPackage [] getSubPackages()

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

Returns:

the array of subpackages.

getSubPackages

PsiPackage [] getSubPackages(GlobalSearchScope scope)

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

Parameters:

scope - the scope in which packages are searched.

Returns:

the array of subpackages.

getClasses

PsiClass [] getClasses()

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

Returns:

the array of classes.

getClasses

PsiClass [] getClasses(GlobalSearchScope scope)

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

Parameters:

scope - the scope in which directories are searched.

Returns:

the array of classes.

getFiles

PsiFile [] getFiles(GlobalSearchScope scope)

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

getAnnotationList

PsiModifierList getAnnotationList()

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

Returns:

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

handleQualifiedNameChange

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.

Parameters:

newQualifiedName - the new qualified name of the package.

occursInPackagePrefixes

VirtualFile [] occursInPackagePrefixes()

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

Returns:

the array of virtual files for the source roots.

getName

java.lang.String getName()

Description copied from interface: PsiNamedElement

Returns the name of the element.

Specified by:

getName in interface JvmNamedElement

Specified by:

getName in interface JvmPackage

Specified by:

getName in interface NavigationItem

Specified by:

getName in interface PsiNamedElement

Specified by:

getName in interface PsiQualifiedNamedElement

Returns:

the element name.

containsClassNamed

boolean containsClassNamed(java.lang.String name)

findClassByShortName

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