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

Class PsiLiteralExpressionImpl

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

com.intellij.psi.impl.source.tree.java.PsiLiteralExpressionImpl

All Implemented Interfaces:

NavigationItem, Iconable, UserDataHolder, UserDataHolderEx, Navigatable, ContributedReferenceHost, NavigatablePsiElement, PsiAnnotationMemberValue, PsiElement, PsiExpression, PsiLanguageInjectionHost, PsiLiteral, PsiLiteralExpression, PsiLiteralValue, StubBasedPsiElement<PsiLiteralStub>, java.lang.Cloneable

public class PsiLiteralExpressionImpl
extends JavaStubPsiElement<PsiLiteralStub>
implements PsiLiteralExpression, PsiLanguageInjectionHost, ContributedReferenceHost

Nested Class Summary

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

Iconable.IconFlags, Iconable.LastComputedIcon

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

PsiLanguageInjectionHost.InjectedPsiVisitor, PsiLanguageInjectionHost.Shred

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

ARRAY_FACTORY, EMPTY_ARRAY, EXPRESSION_TO_TYPE

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

EMPTY_NAVIGATABLE_ELEMENT_ARRAY

Fields inherited from interface com.intellij.navigation.NavigationItem

EMPTY_NAVIGATION_ITEM_ARRAY

Constructor Summary

Constructors

Constructor and Description
PsiLiteralExpressionImpl(ASTNode node)
PsiLiteralExpressionImpl(PsiLiteralStub stub)

Method Summary

Modifier and Type	Method and Description
void	accept(PsiElementVisitor visitor) Passes the element to the specified visitor.
LiteralTextEscaper<PsiLiteralExpressionImpl>	createLiteralTextEscaper()
java.lang.String	getCanonicalText()
PsiElement []	getChildren() Returns the array of children for the PSI element.
java.lang.String	getInnerText()
IElementType	getLiteralElementType()
PsiReference []	getReferences() Returns all references from this PSI element to other PSI elements.
java.lang.String	getText() Returns the text of the PSI element.
int	getTextBlockIndent()
java.lang.String []	getTextBlockLines()
java.lang.String	getTextBlockText()
PsiType	getType() Returns the type of the expression.
java.lang.Object	getValue() Returns the value of the literal expression (an Integer for an integer constant, a String for a string literal, and so on).
boolean	isValidHost()
static boolean	parseStringCharacters(java.lang.String chars, java.lang.StringBuilder outChars, int [] sourceOffsets)
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.JavaStubPsiElement

acceptChildren, add, addAfter, addBefore, calcTreeElement, checkAdd, clone, cloneImpl, delete, deleteChildRange, getLanguage, getTextOffset, 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, getTextLength, getTextRange, putCopyableUserData, replaceChildInternal, subtreeChanged, textContains, textMatches, textToCharArray

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

canNavigate, canNavigateToSource, findChildByClass, findChildrenByClass, findNotNullChildByClass, findReferenceAt, getName, getNavigationElement, getOriginalElement, getPresentation, getReference, getResolveScope, getUseScope, 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.psi.PsiElement

acceptChildren, add, addAfter, addBefore, addRange, addRangeAfter, addRangeBefore, checkAdd, checkDelete, copy, delete, deleteChildRange, findElementAt, findReferenceAt, getContainingFile, getContext, getCopyableUserData, getFirstChild, getLanguage, getLastChild, getManager, getNavigationElement, getNextSibling, getNode, getOriginalElement, getOwnReferences, getParent, getPrevSibling, getProject, getReference, getResolveScope, getStartOffsetInParent, 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.StubBasedPsiElement

getElementType, getStub

Constructor Detail

PsiLiteralExpressionImpl

public PsiLiteralExpressionImpl(PsiLiteralStub stub)

PsiLiteralExpressionImpl

public PsiLiteralExpressionImpl(ASTNode node)

Method Detail

getChildren

public PsiElement [] getChildren()

Description copied from interface: PsiElement

Returns the array of children for the PSI element. Important: In some implementations children are only composite elements, i.e. not a leaf elements

Specified by:

getChildren in interface PsiElement

Overrides:

getChildren in class JavaStubPsiElement<PsiLiteralStub>

Returns:

the array of child elements.

getType

public PsiType getType()

Description copied from interface: PsiExpression

Returns the type of the expression.

Specified by:

getType in interface PsiExpression

Returns:

the expression type, or null if the type is not known.

getLiteralElementType

public IElementType getLiteralElementType()

getCanonicalText

public java.lang.String getCanonicalText()

getText

public java.lang.String getText()

Description copied from interface: PsiElement

Returns the text of the PSI element.

Note: This call requires traversing whole subtree, so it can be expensive for composite elements, and should be avoided if possible.

Specified by:

getText in interface PsiElement

Overrides:

getText in class ASTDelegatePsiElement

Returns:

the element text.

See Also:

PsiElement.textMatches(java.lang.CharSequence), PsiElement.textContains(char)

getValue

public java.lang.Object getValue()

Description copied from interface: PsiLiteralValue

Returns the value of the literal expression (an Integer for an integer constant, a String for a string literal, and so on).

Specified by:

getValue in interface PsiLiteralValue

Returns:

the value of the expression, or null if the parsing of the literal failed.

getInnerText

public java.lang.String getInnerText()

getTextBlockText

public java.lang.String getTextBlockText()

getTextBlockIndent

public int getTextBlockIndent()

getTextBlockLines

public java.lang.String [] getTextBlockLines()

parseStringCharacters

public static boolean parseStringCharacters(java.lang.String chars,
                                            java.lang.StringBuilder outChars,
                                            int [] sourceOffsets)

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.

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

isValidHost

public boolean isValidHost()

Specified by:

isValidHost in interface PsiLanguageInjectionHost

Returns:

true if this instance can accept injections, false otherwise

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 ContributedReferenceHost

Specified by:

getReferences in interface PsiElement

Overrides:

getReferences in class PsiElementBase

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

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