Package com.intellij.psi.impl.source

Class PsiJavaModuleImpl

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.PsiElementBase

com.intellij.extapi.psi.ASTDelegatePsiElement

com.intellij.extapi.psi.StubBasedPsiElementBase<T>

com.intellij.psi.impl.source.JavaStubPsiElement<PsiJavaModuleStub>

com.intellij.psi.impl.source.PsiJavaModuleImpl

All Implemented Interfaces:

NavigationItem, Iconable, UserDataHolder, UserDataHolderEx, Navigatable, NavigatablePsiElement, PsiElement, PsiJavaDocumentedElement, PsiJavaModule, PsiModifierListOwner, PsiNamedElement, PsiNameIdentifierOwner, StubBasedPsiElement<PsiJavaModuleStub>, java.lang.Cloneable

public class PsiJavaModuleImpl
extends JavaStubPsiElement<PsiJavaModuleStub>
implements PsiJavaModule

Nested Class Summary

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

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields inherited from class com.intellij.extapi.psi.StubBasedPsiElementBase

CREATION_TRACE, ourTraceStubAstBinding

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

FLAGS_LOCKED, ICON_PLACEHOLDER

Fields inherited from interface com.intellij.psi.PsiJavaModule

AUTO_MODULE_NAME, JAVA_BASE, MODULE_INFO_CLASS, MODULE_INFO_CLS_FILE, MODULE_INFO_FILE, UPGRADEABLE

Fields inherited from interface com.intellij.psi.NavigatablePsiElement

EMPTY_NAVIGATABLE_ELEMENT_ARRAY

Fields inherited from interface com.intellij.navigation.NavigationItem

EMPTY_NAVIGATION_ITEM_ARRAY

Fields inherited from interface com.intellij.psi.PsiNamedElement

EMPTY_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

Constructor Summary

Constructors

Constructor and Description
PsiJavaModuleImpl(ASTNode node)
PsiJavaModuleImpl(PsiJavaModuleStub stub)

Method Summary

Modifier and Type	Method and Description
void	accept(PsiElementVisitor visitor) Passes the element to the specified visitor.
PsiDocComment	getDocComment() Returns the JavaDoc comment for the element, or null when the element has no JavaDoc comment.
java.lang.Iterable<PsiPackageAccessibilityStatement>	getExports()
PsiModifierList	getModifierList() Returns the list of modifiers for the element.
java.lang.String	getName() Returns the name of the element.
PsiJavaModuleReferenceElement	getNameIdentifier()
java.lang.Iterable<PsiPackageAccessibilityStatement>	getOpens()
PsiElement	getOriginalElement() Returns the PSI element which corresponds to this element and belongs to either the project source path or class path.
ItemPresentation	getPresentation()
java.lang.Iterable<PsiProvidesStatement>	getProvides()
java.lang.Iterable<PsiRequiresStatement>	getRequires()
int	getTextOffset() Returns the offset in the file to which the caret should be placed when performing the navigation to the element.
java.lang.Iterable<PsiUsesStatement>	getUses()
SearchScope	getUseScope() Returns the scope in which references to this element are searched.
boolean	hasModifierProperty(java.lang.String name) Checks if the element has the specified modifier.
PsiElement	setName(java.lang.String name) Renames the element.
java.lang.String	toString() toString() should never be presented to the user.

Methods inherited from class com.intellij.psi.impl.source.JavaStubPsiElement

acceptChildren, add, addAfter, addBefore, calcTreeElement, checkAdd, clone, cloneImpl, delete, deleteChildRange, getChildren, getLanguage, replace

Methods inherited from class com.intellij.extapi.psi.StubBasedPsiElementBase

getContainingFile, getContext, getElementType, getGreenStub, getManager, getNode, getParent, getParentByStub, getParentByTree, getProject, getRequiredStubOrPsiChild, getStub, getStubOrPsiChild, getStubOrPsiChildren, getStubOrPsiChildren, getStubOrPsiChildren, getStubOrPsiChildren, getStubOrPsiParentOfType, isPhysical, isValid, isWritable, setNode, setSubstrateRef

Methods inherited from class com.intellij.extapi.psi.ASTDelegatePsiElement

addInternal, addRange, addRangeAfter, addRangeBefore, checkDelete, copy, deleteChildInternal, findChildByFilter, findChildByType, findChildByType, findChildrenByType, findChildrenByType, findChildrenByType, findChildrenByType, findElementAt, findLastChildByType, findNotNullChildByType, findNotNullChildByType, getCopyableUserData, getFirstChild, getLastChild, getNextSibling, getPrevSibling, getStartOffsetInParent, getText, getTextLength, getTextRange, putCopyableUserData, replaceChildInternal, subtreeChanged, textContains, textMatches, textToCharArray

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

canNavigate, canNavigateToSource, findChildByClass, findChildrenByClass, findNotNullChildByClass, findReferenceAt, getNavigationElement, getReference, getReferences, getResolveScope, isEquivalentTo, navigate, notNullChild, processDeclarations, textMatches

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, copyCopyableDataTo, copyUserDataTo, getUserData, getUserDataString, getUserMap, isUserDataEmpty, 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.pom.Navigatable

canNavigate, canNavigateToSource, navigate

Methods inherited from interface com.intellij.psi.PsiNameIdentifierOwner

getIdentifyingElement

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, getLanguage, getLastChild, getManager, getNavigationElement, getNextSibling, getNode, getOwnReferences, getParent, getPrevSibling, getProject, getReference, getReferences, getResolveScope, getStartOffsetInParent, getText, getTextLength, getTextRange, getTextRangeInParent, isEquivalentTo, isPhysical, isValid, isWritable, processDeclarations, 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.psi.PsiModifierListOwner

getAnnotation, getAnnotations, hasAnnotation, hasModifier

Methods inherited from interface com.intellij.psi.StubBasedPsiElement

getElementType, getStub

Constructor Detail

PsiJavaModuleImpl

public PsiJavaModuleImpl(PsiJavaModuleStub stub)

PsiJavaModuleImpl

public PsiJavaModuleImpl(ASTNode node)

Method Detail

getRequires

public java.lang.Iterable<PsiRequiresStatement> getRequires()

Specified by:

getRequires in interface PsiJavaModule

getExports

public java.lang.Iterable<PsiPackageAccessibilityStatement> getExports()

Specified by:

getExports in interface PsiJavaModule

getOpens

public java.lang.Iterable<PsiPackageAccessibilityStatement> getOpens()

Specified by:

getOpens in interface PsiJavaModule

getUses

public java.lang.Iterable<PsiUsesStatement> getUses()

Specified by:

getUses in interface PsiJavaModule

getProvides

public java.lang.Iterable<PsiProvidesStatement> getProvides()

Specified by:

getProvides in interface PsiJavaModule

getNameIdentifier

public PsiJavaModuleReferenceElement getNameIdentifier()

Specified by:

getNameIdentifier in interface PsiJavaModule

Specified by:

getNameIdentifier in interface PsiNameIdentifierOwner

getName

public java.lang.String getName()

Description copied from interface: PsiNamedElement

Returns the name of the element.

Specified by:

getName in interface NavigationItem

Specified by:

getName in interface PsiJavaModule

Specified by:

getName in interface PsiNamedElement

Overrides:

getName in class PsiElementBase

Returns:

the element name.

setName

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

Description copied from interface: PsiNamedElement

Renames the element.

Specified by:

setName in interface PsiNamedElement

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.

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

getDocComment

public PsiDocComment getDocComment()

Description copied from interface: PsiJavaDocumentedElement

Returns the JavaDoc comment for the element, or null when the element has no JavaDoc comment.

Specified by:

getDocComment in interface PsiJavaDocumentedElement

getPresentation

public ItemPresentation getPresentation()

Specified by:

getPresentation in interface NavigationItem

Overrides:

getPresentation in class PsiElementBase

getTextOffset

public 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 JavaStubPsiElement<PsiJavaModuleStub>

Returns:

the offset of the PSI element.

getOriginalElement

public PsiElement getOriginalElement()

Description copied from interface: PsiElement

Returns the PSI element which corresponds to this element and belongs to either the project source path or class path. The method can either return this or substitute a different element if this element does not belong to the source path or class path. (For example, the original element for a library source file is the corresponding compiled class file.)

Specified by:

getOriginalElement in interface PsiElement

Overrides:

getOriginalElement in class PsiElementBase

Returns:

the original element.

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.

getUseScope

public SearchScope getUseScope()

Description copied from interface: PsiElement

Returns the scope in which references to this element are searched.

Specified by:

getUseScope in interface PsiElement

Overrides:

getUseScope in class PsiElementBase

Returns:

the search scope instance.

See Also:

PsiSearchHelper.getUseScope(PsiElement)

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 java.lang.Object