Package com.intellij.psi

Interface PsiJavaFile

All Superinterfaces:

Iconable, Navigatable, NavigatablePsiElement, NavigationItem, PsiCheckedRenameElement, PsiClassOwner, PsiElement, PsiFile, PsiFileSystemItem, PsiImportHolder, PsiNamedElement, UserDataHolder

All Known Implementing Classes:

ClsFileImpl, JShellFileImpl, PsiJavaFileBaseImpl, PsiJavaFileImpl

public interface PsiJavaFile
extends PsiImportHolder, PsiClassOwner

Represents a Java, JSP or .class file.

Field Summary

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

Method Summary

Modifier and Type	Method and Description
PsiJavaCodeReferenceElement	findImportReferenceTo(PsiClass aClass) Returns the single-class import statement which references the specified class, or null if there is no such statement.
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.
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.

Methods inherited from interface com.intellij.psi.PsiImportHolder

importClass

Methods inherited from interface com.intellij.psi.PsiClassOwner

getClasses, setPackageName

Methods inherited from interface com.intellij.psi.PsiFile

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

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

Method Detail

getPackageStatement

PsiPackageStatement getPackageStatement()

Returns the package statement contained in the file.

Returns:

the package statement, or null if one is missing.

getPackageName

java.lang.String getPackageName()

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

Specified by:

getPackageName in interface PsiClassOwner

Returns:

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

getImportList

PsiImportList getImportList()

Returns the import list contained in the file.

Returns:

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

getOnDemandImports

PsiElement [] getOnDemandImports(boolean includeImplicit,
                                 @Deprecated
                                 boolean checkIncludes)

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

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

PsiClass [] getSingleClassImports(@Deprecated
                                  boolean checkIncludes)

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

Parameters:

checkIncludes - deprecated, no longer used.

Returns:

the list of PsiClass elements for the import.

getImplicitlyImportedPackages

java.lang.String [] getImplicitlyImportedPackages()

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

Returns:

the list of implicitly imported package names.

getImplicitlyImportedPackageReferences

PsiJavaCodeReferenceElement [] getImplicitlyImportedPackageReferences()

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

Returns:

the list of implicitly imported package reference elements.

findImportReferenceTo

PsiJavaCodeReferenceElement findImportReferenceTo(PsiClass aClass)

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

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

LanguageLevel getLanguageLevel()

getModuleDeclaration

PsiJavaModule getModuleDeclaration()

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