Package com.intellij.psi.impl.source.tree

Class PsiCommentImpl

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.source.tree.TreeElement

com.intellij.psi.impl.source.tree.LeafElement

com.intellij.psi.impl.source.tree.LeafPsiElement

com.intellij.psi.impl.source.tree.PsiCommentImpl

All Implemented Interfaces:

ASTNode, NavigationItem, Iconable, UserDataHolder, UserDataHolderEx, Navigatable, PsiComment, PsiElement, PsiLanguageInjectionHost, java.lang.Cloneable

Direct Known Subclasses:

PsiCoreCommentImpl

public class PsiCommentImpl
extends LeafPsiElement
implements PsiComment, PsiLanguageInjectionHost

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.psi.PsiLanguageInjectionHost

PsiLanguageInjectionHost.InjectedPsiVisitor, PsiLanguageInjectionHost.Shred

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.source.tree.TreeElement

EMPTY_ARRAY

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.navigation.NavigationItem

EMPTY_NAVIGATION_ITEM_ARRAY

Constructor Summary

Constructors

Constructor and Description
PsiCommentImpl(IElementType type, java.lang.CharSequence text)

Method Summary

Modifier and Type	Method and Description
void	accept(PsiElementVisitor visitor) Passes the element to the specified visitor.
LiteralTextEscaper<PsiCommentImpl>	createLiteralTextEscaper()
PsiReference []	getReferences() Returns all references from this PSI element to other PSI elements.
IElementType	getTokenType() Returns the token type of the comment (like JavaTokenType.END_OF_LINE_COMMENT or JavaTokenType.C_STYLE_COMMENT).
boolean	isValidHost()
java.lang.String	toString() toString() should never be presented to the user.
PsiLanguageInjectionHost	updateText(java.lang.String text) Update the host element using the provided text of the injected file.

Methods inherited from class com.intellij.psi.impl.source.tree.LeafPsiElement

acceptChildren, add, addAfter, addBefore, addRange, addRangeAfter, addRangeBefore, canNavigate, canNavigateToSource, checkAdd, checkDelete, copy, delete, deleteChildRange, findElementAt, findReferenceAt, getChildren, getContainingFile, getContext, getFirstChild, getLanguage, getLastChild, getName, getNavigationElement, getNextSibling, getNode, getOriginalElement, getParent, getPresentation, getPrevSibling, getProject, getPsi, getReference, getResolveScope, getUseScope, isEquivalentTo, isPhysical, isValid, isWritable, navigate, processDeclarations, replace

Methods inherited from class com.intellij.psi.impl.source.tree.LeafElement

acceptTree, addChild, addChild, addChildren, addLeaf, charAt, clone, copyTo, findChildByType, findChildByType, findChildByType, findChildByType, findLeafElementAt, getCachedLength, getChars, getChildren, getFirstChildNode, getLastChildNode, getPsi, getText, getTextLength, hc, rawReplaceWithText, removeChild, removeRange, replaceAllChildrenToChildrenOf, replaceChild, replaceWithText, textContains, textMatches, textMatches, textToCharArray

Methods inherited from class com.intellij.psi.impl.source.tree.TreeElement

clearCaches, copyElement, equals, getElementType, getManager, getStartOffset, getStartOffsetInParent, getTextOffset, getTextRange, getTreeNext, getTreeParent, getTreePrev, invalidate, onInvalidated, rawInsertAfterMe, rawInsertBeforeMe, rawRemove, rawRemoveUpTo, rawRemoveUpToLast, rawReplaceWithList, textMatches, 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, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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, getOriginalElement, getOwnReferences, getParent, getPrevSibling, getProject, getReference, 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.lang.ASTNode

getCopyableUserData, putCopyableUserData

Constructor Detail

PsiCommentImpl

public PsiCommentImpl(IElementType type,
                      java.lang.CharSequence text)

Method Detail

getTokenType

public IElementType getTokenType()

Description copied from interface: PsiComment

Returns the token type of the comment (like JavaTokenType.END_OF_LINE_COMMENT or JavaTokenType.C_STYLE_COMMENT).

Specified by:

getTokenType in interface PsiComment

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 LeafPsiElement

Parameters:

visitor - the visitor to pass the element to.

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 LeafPsiElement

getReferences

public PsiReference [] getReferences()

Description copied from interface: PsiElement

Returns all references from this PSI element to other PSI elements. An element can have multiple references when, for example, the element is a string literal containing multiple sub-strings which are valid full-qualified class names. If an element contains only one text fragment which acts as a reference but the reference has multiple possible targets, PsiPolyVariantReference should be used instead of returning multiple references.

Actually, it's preferable to call PsiReferenceService.getReferences(com.intellij.psi.PsiElement, com.intellij.psi.PsiReferenceService.Hints) instead as it allows adding references by plugins when the element implements ContributedReferenceHost.

Specified by:

getReferences in interface PsiElement

Overrides:

getReferences in class LeafPsiElement

Returns:

the array of references, or an empty array if the element has no associated references.

See Also:

PsiReferenceService.getReferences(com.intellij.psi.PsiElement, com.intellij.psi.PsiReferenceService.Hints), ReferencesSearch

isValidHost

public boolean isValidHost()

Specified by:

isValidHost in interface PsiLanguageInjectionHost

Returns:

true if this instance can accept injections, false otherwise

updateText

public PsiLanguageInjectionHost updateText(java.lang.String text)

Description copied from interface: PsiLanguageInjectionHost

Update the host element using the provided text of the injected file. It may be required to escape characters from text in accordance with the host language syntax. The implementation may delegate to ElementManipulators.handleContentChange(PsiElement, String) if ElementManipulator implementation is registered for this element class.

Specified by:

updateText in interface PsiLanguageInjectionHost

Parameters:

text - text of the injected file

Returns:

the updated instance

createLiteralTextEscaper

public LiteralTextEscaper<PsiCommentImpl> createLiteralTextEscaper()

Specified by:

createLiteralTextEscaper in interface PsiLanguageInjectionHost

Returns:

LiteralTextEscaper instance which will be used to convert the content of this host element to the content of injected file