Package com.intellij.psi.impl

Class PomTargetPsiElementImpl

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.PsiElementBase

com.intellij.psi.impl.FakePsiElement

com.intellij.psi.impl.RenameableFakePsiElement

com.intellij.psi.impl.PomTargetPsiElementImpl

All Implemented Interfaces:

ItemPresentation, NavigationItem, Iconable, UserDataHolder, UserDataHolderEx, Navigatable, PomTargetPsiElement, PsiMetaData, PsiMetaOwner, PsiPresentableMetaData, NavigatablePsiElement, PsiElement, PsiNamedElement, java.lang.Cloneable

public class PomTargetPsiElementImpl
extends RenameableFakePsiElement
implements PomTargetPsiElement

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

FLAGS_LOCKED, ICON_PLACEHOLDER

Fields inherited from interface com.intellij.psi.PsiElement

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

Fields inherited from interface com.intellij.psi.PsiNamedElement

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

Constructor Summary

Constructors

Constructor and Description
PomTargetPsiElementImpl(Project project, PomTarget target)
PomTargetPsiElementImpl(PsiTarget target)

Method Summary

Modifier and Type	Method and Description
boolean	canNavigate() Indicates whether this instance supports navigation of any kind.
boolean	canNavigateToSource() Indicates whether this instance supports navigation to source (that means some kind of editor).
boolean	equals(java.lang.Object o)
PsiFile	getContainingFile() Returns the file containing the PSI element.
PsiElement	getContext() Returns the element which should be used as the parent of this element in a tree up walk during a resolve operation.
javax.swing.Icon	getIcon()
Language	getLanguage() Returns the language of the PSI element.
java.lang.String	getLocationString() Returns the location of the object (for example, the package of a class).
java.lang.String	getName() Returns the name of the element.
PsiElement	getNavigationElement() Returns the PSI element which should be used as a navigation target when navigation to this PSI element is requested.
PsiElement	getParent() Returns the parent of the PSI element.
Project	getProject() Returns the project to which the PSI element belongs.
PomTarget	getTarget()
java.lang.String	getTypeName()
int	hashCode()
boolean	isEquivalentTo(PsiElement another) This method shouldn't be called by clients directly, because there are no guarantees of it being symmetric.
boolean	isValid() Checks if this PSI element is valid.
boolean	isWritable() Checks if the contents of the element can be modified (if it belongs to a non-read-only source file.)
void	navigate(boolean requestFocus) Open editor and select/navigate to the object there if possible.
PsiElement	setName(java.lang.String name) Renames the element.

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

getDeclaration, getIcon, getManager, getMetaData, getName, getTextRange, init

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

findElementAt, getChildren, getElementIcon, getFirstChild, getIcon, getLastChild, getNextSibling, getNode, getPresentableText, getPresentation, getPrevSibling, getStartOffsetInParent, getText, getTextLength, getTextOffset, isPhysical, textContains, textToCharArray

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

accept, acceptChildren, add, addAfter, addBefore, addRange, addRangeAfter, addRangeBefore, checkAdd, checkDelete, copy, delete, deleteChildRange, findChildByClass, findChildrenByClass, findNotNullChildByClass, findReferenceAt, getOriginalElement, getReference, getReferences, getResolveScope, getUseScope, notNullChild, processDeclarations, replace, textMatches, textMatches

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

buildRowIcon, computeBaseIcon, createLayeredIcon, getAdjustedBaseIcon, getBaseIcon, 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, toString, wait, wait, wait

Methods inherited from interface com.intellij.psi.PsiElement

accept, acceptChildren, add, addAfter, addBefore, addRange, addRangeAfter, addRangeBefore, checkAdd, checkDelete, copy, delete, deleteChildRange, findElementAt, findReferenceAt, getChildren, getCopyableUserData, getFirstChild, getLastChild, getManager, getNextSibling, getNode, getOriginalElement, getOwnReferences, getPrevSibling, getReference, getReferences, getResolveScope, getStartOffsetInParent, getText, getTextLength, getTextOffset, getTextRange, getTextRangeInParent, getUseScope, isPhysical, 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

Methods inherited from interface com.intellij.psi.meta.PsiMetaData

getDependences, getDependencies

Constructor Detail

PomTargetPsiElementImpl

public PomTargetPsiElementImpl(PsiTarget target)

PomTargetPsiElementImpl

public PomTargetPsiElementImpl(Project project,
                               PomTarget target)

Method Detail

getTarget

public PomTarget getTarget()

Specified by:

getTarget in interface PomTargetPsiElement

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 PsiMetaData

Specified by:

getName in interface PsiNamedElement

Specified by:

getName in class RenameableFakePsiElement

Returns:

the element name.

isWritable

public boolean isWritable()

Description copied from interface: PsiElement

Checks if the contents of the element can be modified (if it belongs to a non-read-only source file.)

Specified by:

isWritable in interface PsiElement

Overrides:

isWritable in class PsiElementBase

Returns:

true if the element can be modified, false otherwise.

getTypeName

public java.lang.String getTypeName()

Specified by:

getTypeName in interface PsiPresentableMetaData

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 PsiElementBase

Returns:

the navigation target element.

getIcon

public javax.swing.Icon getIcon()

Specified by:

getIcon in interface PsiPresentableMetaData

isValid

public boolean isValid()

Description copied from interface: PsiElement

Checks if this PSI element is valid. Valid elements and their hierarchy members can be accessed for reading and writing. Valid elements can still correspond to underlying documents whose text is different, when those documents have been changed and not yet committed (PsiDocumentManager.commitDocument(com.intellij.openapi.editor.Document)). (In this case an attempt to change PSI will result in an exception). Any access to invalid elements results in PsiInvalidElementAccessException. Once invalid, elements can't become valid again. Elements become invalid in following cases:

• They have been deleted via PSI operation (PsiElement.delete())
• They have been deleted as a result of an incremental reparse (document commit)
• Their containing file has been changed externally, or renamed so that its PSI had to be rebuilt from scratch

Specified by:

isValid in interface PsiElement

Overrides:

isValid in class PsiElementBase

Returns:

true if the element is valid, false otherwise.

See Also:

PsiUtilCore.ensureValid(PsiElement)

setName

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

Description copied from interface: PsiNamedElement

Renames the element.

Specified by:

setName in interface PsiNamedElement

Overrides:

setName in class FakePsiElement

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.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isEquivalentTo

public boolean isEquivalentTo(PsiElement another)

Description copied from interface: PsiElement

This method shouldn't be called by clients directly, because there are no guarantees of it being symmetric. It's called by PsiManager.areElementsEquivalent(PsiElement, PsiElement) internally, which clients should invoke instead.

Implementations of this method should return true if the parameter is resolve-equivalent to this, i.e. it represents the same entity from the language perspective. See also PsiManager.areElementsEquivalent(PsiElement, PsiElement) documentation.

Specified by:

isEquivalentTo in interface PsiElement

Overrides:

isEquivalentTo in class PsiElementBase

getContext

public PsiElement getContext()

Description copied from interface: PsiElement

Returns the element which should be used as the parent of this element in a tree up walk during a resolve operation. For most elements, this returns getParent(), but the context can be overridden for some elements like code fragments (see JavaCodeFragmentFactory.createCodeBlockCodeFragment(String, PsiElement, boolean)).

Specified by:

getContext in interface PsiElement

Overrides:

getContext in class PsiElementBase

Returns:

the resolve context element.

getParent

public PsiElement getParent()

Description copied from interface: PsiElement

Returns the parent of the PSI element.

Specified by:

getParent in interface PsiElement

Overrides:

getParent in class RenameableFakePsiElement

Returns:

the parent of the element, or null if the element has no parent.

navigate

public void navigate(boolean requestFocus)

Description copied from interface: Navigatable

Open editor and select/navigate to the object there if possible. Just do nothing if navigation is not possible like in case of a package

Specified by:

navigate in interface Navigatable

Overrides:

navigate in class PsiElementBase

Parameters:

requestFocus - true if focus requesting is necessary

canNavigate

public boolean canNavigate()

Description copied from interface: Navigatable

Indicates whether this instance supports navigation of any kind. Usually this method is called to ensure that navigation is possible. Note that it is not called if navigation to source is supported, i.e. Navigatable.canNavigateToSource() returns true. We assume that this method should return true in such case, so implement this method respectively.

Specified by:

canNavigate in interface Navigatable

Overrides:

canNavigate in class PsiElementBase

Returns:

false if navigation is not possible for any reason.

canNavigateToSource

public boolean canNavigateToSource()

Description copied from interface: Navigatable

Indicates whether this instance supports navigation to source (that means some kind of editor). Note that navigation can be supported even if this method returns false. In such cases it is not recommended to do batch navigation for all navigatables available via CommonDataKeys.NAVIGATABLE_ARRAY, because it may lead to opening several modal dialogs. Use OpenSourceUtil.navigate(com.intellij.pom.Navigatable...) to process such arrays correctly.

Specified by:

canNavigateToSource in interface Navigatable

Overrides:

canNavigateToSource in class PsiElementBase

Returns:

false if navigation to source is not possible for any reason.

getContainingFile

public PsiFile getContainingFile()

Description copied from interface: PsiElement

Returns the file containing the PSI element.

Note: this method might need to traverse the whole AST up, which can be slow in deep trees, so invoking this method should be avoided if possible.

Specified by:

getContainingFile in interface PsiElement

Overrides:

getContainingFile in class RenameableFakePsiElement

Returns:

the file instance, or null if the PSI element is not contained in a file (for example, the element represents a package or directory).

getLanguage

public Language getLanguage()

Description copied from interface: PsiElement

Returns the language of the PSI element.

Specified by:

getLanguage in interface PsiElement

Overrides:

getLanguage in class RenameableFakePsiElement

Returns:

the language instance.

getProject

public Project getProject()

Description copied from interface: PsiElement

Returns the project to which the PSI element belongs.

Specified by:

getProject in interface PsiElement

Overrides:

getProject in class RenameableFakePsiElement

Returns:

the project instance.

getLocationString

public java.lang.String getLocationString()

Description copied from interface: ItemPresentation

Returns the location of the object (for example, the package of a class). The location string is used by some renderers and usually displayed as grayed text next to the item name.

Specified by:

getLocationString in interface ItemPresentation

Overrides:

getLocationString in class FakePsiElement

Returns:

the location description, or null if none is applicable.