Package com.intellij.psi.impl.light

Class LightJavaModule

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.PsiElementBase

com.intellij.psi.impl.light.LightElement

com.intellij.psi.impl.light.LightJavaModule

All Implemented Interfaces:

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

public class LightJavaModule
extends LightElement
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.psi.impl.light.LightElement

myManager

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

Method Summary

Modifier and Type	Method and Description
static java.lang.String	claimedModuleName(VirtualFile manifest)
boolean	equals(java.lang.Object obj)
static LightJavaModule	findModule(PsiManager manager, VirtualFile root) The method is expected to be called on roots obtained from JavaAutoModuleNameIndex/JavaSourceModuleNameIndex
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.
static LightJavaModule	getModule(PsiManager manager, VirtualFile root) Deprecated. method scope was extended, use findModule(com.intellij.psi.PsiManager, com.intellij.openapi.vfs.VirtualFile) instead
java.lang.String	getName() Returns the name of the element.
PsiJavaModuleReferenceElement	getNameIdentifier()
PsiElement	getNavigationElement() Returns the PSI element which should be used as a navigation target when navigation to this PSI element is requested.
java.lang.Iterable<PsiPackageAccessibilityStatement>	getOpens()
ItemPresentation	getPresentation()
java.lang.Iterable<PsiProvidesStatement>	getProvides()
java.lang.Iterable<PsiRequiresStatement>	getRequires()
VirtualFile	getRootVirtualFile()
java.lang.Iterable<PsiUsesStatement>	getUses()
int	hashCode()
boolean	hasModifierProperty(java.lang.String name) Checks if the element has the specified modifier.
static java.lang.String	moduleName(java.lang.String name) Implements a name deriving for automatic modules as described in ModuleFinder.of(Path...) method documentation.
static java.lang.String	moduleName(VirtualFile jarRoot)
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.light.LightElement

accept, add, addAfter, addBefore, checkAdd, checkDelete, copy, delete, findElementAt, getChildren, getContainingFile, getLanguage, getManager, getNextSibling, getNode, getParent, getPrevSibling, getStartOffsetInParent, getText, getTextLength, getTextOffset, getTextRange, isPhysical, isValid, isWritable, replace, setNavigationElement, textMatches, textMatches, textToCharArray

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

acceptChildren, addRange, addRangeAfter, addRangeBefore, canNavigate, canNavigateToSource, deleteChildRange, findChildByClass, findChildrenByClass, findNotNullChildByClass, findReferenceAt, getContext, getFirstChild, getLastChild, getOriginalElement, getProject, getReference, getReferences, getResolveScope, getUseScope, isEquivalentTo, navigate, notNullChild, processDeclarations, textContains

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, 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.pom.Navigatable

canNavigate, canNavigateToSource, navigate

Methods inherited from interface com.intellij.psi.PsiNameIdentifierOwner

getIdentifyingElement

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, 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

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

Method Detail

getRootVirtualFile

public VirtualFile getRootVirtualFile()

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

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

getPresentation

public ItemPresentation getPresentation()

Specified by:

getPresentation in interface NavigationItem

Overrides:

getPresentation in class PsiElementBase

getNavigationElement

public PsiElement getNavigationElement()

Description copied from interface: PsiElement

Returns the PSI element which should be used as a navigation target when navigation to this PSI element is requested. The method can either return this or substitute a different element if this element does not have an associated file and offset. (For example, if the source code of a library is attached to a project, the navigation element for a compiled library class is its source class.)

Specified by:

getNavigationElement in interface PsiElement

Overrides:

getNavigationElement in class LightElement

Returns:

the navigation target element.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

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

Specified by:

toString in class LightElement

getModule

@Deprecated
public static LightJavaModule getModule(PsiManager manager,
                                        VirtualFile root)

Deprecated. method scope was extended, use findModule(com.intellij.psi.PsiManager, com.intellij.openapi.vfs.VirtualFile) instead

findModule

public static LightJavaModule findModule(PsiManager manager,
                                         VirtualFile root)

The method is expected to be called on roots obtained from JavaAutoModuleNameIndex/JavaSourceModuleNameIndex

moduleName

public static java.lang.String moduleName(VirtualFile jarRoot)

claimedModuleName

public static java.lang.String claimedModuleName(VirtualFile manifest)

moduleName

public static java.lang.String moduleName(java.lang.String name)

Implements a name deriving for automatic modules as described in ModuleFinder.of(Path...) method documentation.

Please note that the result may not be a valid module name when the source contains a sequence that starts with a digit (e.g. "org.7gnomes..."). One may validate the result with PsiNameHelper.isValidModuleName(java.lang.String, com.intellij.psi.PsiElement).

Parameters:

name - a .jar file name without extension

See Also:

ModuleFinder.of(Path...)