Package com.intellij.psi

Interface PsiImportList

All Superinterfaces:

Iconable, PsiElement, UserDataHolder

All Known Subinterfaces:

JspxImportList

All Known Implementing Classes:

PsiImportListImpl

public interface PsiImportList
extends PsiElement

Represents the list of import statements contained in a Java or JSP file.

See Also:

PsiJavaFile.getImportList()

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 ArrayFactory<PsiImportList>	ARRAY_FACTORY
static PsiImportList[]	EMPTY_ARRAY

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
PsiImportStatement	findOnDemandImportStatement(java.lang.String packageName) Searches the list for an on-demand import statement importing the specified class.
PsiImportStatement	findSingleClassImportStatement(java.lang.String qName) Searches the list for a single-class import statement importing the specified class.
PsiImportStatementBase	findSingleImportStatement(java.lang.String name) Searches the list for a single import or import static statement importing the specified identifier.
PsiImportStatementBase []	getAllImportStatements() Returns all import statements contained in the list.
PsiImportStatement []	getImportStatements() Returns the non-static import statements contained in the list.
PsiImportStaticStatement []	getImportStaticStatements() Returns the static import statements contained in the list.
boolean	isReplaceEquivalent(PsiImportList otherList) Checks if replacing this import list with the specified import list will cause no modifications to the file.

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

EMPTY_ARRAY

static final PsiImportList[] EMPTY_ARRAY

ARRAY_FACTORY

static final ArrayFactory<PsiImportList> ARRAY_FACTORY

Method Detail

getImportStatements

PsiImportStatement [] getImportStatements()

Returns the non-static import statements contained in the list.

Returns:

the array of non-static import statements.

getImportStaticStatements

PsiImportStaticStatement [] getImportStaticStatements()

Returns the static import statements contained in the list.

Returns:

the array of static import statements.

getAllImportStatements

PsiImportStatementBase [] getAllImportStatements()

Returns all import statements contained in the list.

Returns:

the array of import statements.

findSingleClassImportStatement

PsiImportStatement findSingleClassImportStatement(java.lang.String qName)

Searches the list for a single-class import statement importing the specified class.

Parameters:

qName - the full-qualified name of the imported class.

Returns:

the import statement, or null if one was not found.

findOnDemandImportStatement

PsiImportStatement findOnDemandImportStatement(java.lang.String packageName)

Searches the list for an on-demand import statement importing the specified class.

Parameters:

packageName - the name of the imported package.

Returns:

the import statement, or null if one was not found.

findSingleImportStatement

PsiImportStatementBase findSingleImportStatement(java.lang.String name)

Searches the list for a single import or import static statement importing the specified identifier.

Parameters:

name - the name of the imported class or method.

Returns:

the import statement, or null if one was not found.

isReplaceEquivalent

boolean isReplaceEquivalent(PsiImportList otherList)

Checks if replacing this import list with the specified import list will cause no modifications to the file.

Parameters:

otherList - the list to check possibility to replace with.

Returns:

true if replacing will not cause modifications; false otherwise.