Package com.intellij.designer.model

Class EmptyXmlTag

java.lang.Object

com.intellij.designer.model.EmptyXmlTag

All Implemented Interfaces:

PsiExternalReferenceHost, Iconable, UserDataHolder, PsiMetaOwner, PsiElement, PsiNamedElement, XmlElement, XmlNamedReferenceHost, XmlTag, XmlTagChild

public class EmptyXmlTag
extends java.lang.Object
implements XmlTag

Nested Class Summary

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

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields

Modifier and Type	Field and Description
static XmlTag	INSTANCE

Fields inherited from interface com.intellij.psi.xml.XmlTag

EMPTY

Fields inherited from interface com.intellij.psi.PsiNamedElement

EMPTY_ARRAY

Fields inherited from interface com.intellij.psi.xml.XmlTagChild

EMPTY_ARRAY

Fields inherited from interface com.intellij.psi.xml.XmlElement

DEPENDING_ELEMENT, DO_NOT_VALIDATE, INCLUDING_ELEMENT

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
EmptyXmlTag()

Method Summary

Modifier and Type	Method and Description
void	accept(PsiElementVisitor visitor) Passes the element to the specified visitor.
void	acceptChildren(PsiElementVisitor visitor) Passes the children of the element to the specified visitor.
PsiElement	add(PsiElement element) Adds a child to this PSI element.
PsiElement	addAfter(PsiElement element, PsiElement anchor) Adds a child to this PSI element, after the specified anchor element.
PsiElement	addBefore(PsiElement element, PsiElement anchor) Adds a child to this PSI element, before the specified anchor element.
PsiElement	addRange(PsiElement first, PsiElement last) Adds a range of elements as children to this PSI element.
PsiElement	addRangeAfter(PsiElement first, PsiElement last, PsiElement anchor) Adds a range of elements as children to this PSI element, after the specified anchor element.
PsiElement	addRangeBefore(PsiElement first, PsiElement last, PsiElement anchor) Adds a range of elements as children to this PSI element, before the specified anchor element.
XmlTag	addSubTag(XmlTag subTag, boolean first)
void	checkAdd(PsiElement element) Checks if it is possible to add the specified element as a child to this element, and throws an exception if the add is not possible.
void	checkDelete() Checks if it is possible to delete the specified element from the tree, and throws an exception if the add is not possible.
void	collapseIfEmpty()
PsiElement	copy() Creates a copy of the file containing the PSI element and returns the corresponding element in the created copy.
XmlTag	createChildTag(java.lang.String localName, java.lang.String namespace, java.lang.String bodyText, boolean enforceNamespacesDeep) Creates a new child tag
void	delete() Deletes this PSI element from the tree.
void	deleteChildRange(PsiElement first, PsiElement last) Deletes a range of children of this PSI element from the tree.
PsiElement	findElementAt(int offset) Finds a leaf PSI element at the specified offset from the start of the text range of this node.
XmlTag	findFirstSubTag(java.lang.String qname)
PsiReference	findReferenceAt(int offset) Finds a reference at the specified offset from the start of the text range of this node.
XmlTag []	findSubTags(java.lang.String qname)
XmlTag []	findSubTags(java.lang.String localName, java.lang.String namespace)
XmlAttribute	getAttribute(java.lang.String qname) Returns a tag attribute by qualified name.
XmlAttribute	getAttribute(java.lang.String name, java.lang.String namespace)
XmlAttribute []	getAttributes()
java.lang.String	getAttributeValue(java.lang.String qname) Returns a tag attribute value by qualified name.
java.lang.String	getAttributeValue(java.lang.String name, java.lang.String namespace)
PsiElement []	getChildren() Returns the array of children for the PSI element.
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.
<T> T	getCopyableUserData(Key<T> key) Returns a copyable user data object attached to this element.
XmlElementDescriptor	getDescriptor()
PsiElement	getFirstChild() Returns the first child of the PSI element.
javax.swing.Icon	getIcon(int flags)
Language	getLanguage() Returns the language of the PSI element.
PsiElement	getLastChild() Returns the last child of the PSI element.
java.lang.String	getLocalName()
java.util.Map<java.lang.String,java.lang.String>	getLocalNamespaceDeclarations()
PsiManager	getManager() Returns the PSI manager for the project to which the PSI element belongs.
PsiMetaData	getMetaData()
java.lang.String	getName() Returns the name of the element.
java.lang.String	getNamespace()
java.lang.String	getNamespaceByPrefix(java.lang.String prefix)
java.lang.String	getNamespacePrefix()
PsiElement	getNavigationElement() Returns the PSI element which should be used as a navigation target when navigation to this PSI element is requested.
PsiElement	getNextSibling() Returns the next sibling of the PSI element.
XmlTagChild	getNextSiblingInTag()
ASTNode	getNode() Returns the AST node corresponding to the element.
XmlNSDescriptor	getNSDescriptor(java.lang.String namespace, boolean strict)
PsiElement	getOriginalElement() Returns the PSI element which corresponds to this element and belongs to either the project source path or class path.
PsiElement	getParent() Returns the parent of the PSI element.
XmlTag	getParentTag()
java.lang.String	getPrefixByNamespace(java.lang.String namespace)
PsiElement	getPrevSibling() Returns the previous sibling of the PSI element.
XmlTagChild	getPrevSiblingInTag()
Project	getProject() Returns the project to which the PSI element belongs.
PsiReference	getReference() Returns the reference from this PSI element to another PSI element (or elements), if one exists.
PsiReference []	getReferences() Returns all references from this PSI element to other PSI elements.
GlobalSearchScope	getResolveScope() Returns the scope in which the declarations for the references in this PSI element are searched.
int	getStartOffsetInParent() Returns the text offset of the PSI element relative to its parent.
XmlTag []	getSubTags()
java.lang.String	getSubTagText(java.lang.String qname)
java.lang.String	getText() Returns the text of the PSI element.
int	getTextLength() Returns the length of text of the PSI element.
int	getTextOffset() Returns the offset in the file to which the caret should be placed when performing the navigation to the element.
TextRange	getTextRange() Returns the text range in the document occupied by the PSI element.
<T> T	getUserData(Key<T> key)
SearchScope	getUseScope() Returns the scope in which references to this element are searched.
XmlTagValue	getValue()
boolean	hasNamespaceDeclarations()
boolean	isEmpty()
boolean	isEquivalentTo(PsiElement another) This method shouldn't be called by clients directly, because there are no guarantees of it being symmetric.
boolean	isPhysical() Checks if an actual source or class file corresponds to the element.
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.)
java.lang.String[]	knownNamespaces()
boolean	processDeclarations(PsiScopeProcessor processor, ResolveState state, PsiElement lastParent, PsiElement place) Passes the declarations contained in this PSI element and its children for processing to the specified scope processor.
boolean	processElements(PsiElementProcessor processor, PsiElement place)
<T> void	putCopyableUserData(Key<T> key, T value) Attaches a copyable user data object to this element.
<T> void	putUserData(Key<T> key, T value) Add a new user data value to this object.
PsiElement	replace(PsiElement newElement) Replaces this PSI element (along with all its children) with another element (along with the children).
XmlAttribute	setAttribute(java.lang.String qname, java.lang.String value)
XmlAttribute	setAttribute(java.lang.String name, java.lang.String namespace, java.lang.String value)
PsiElement	setName(java.lang.String name) Renames the element.
boolean	textContains(char c) Checks if the text of this element contains the specified character.
boolean	textMatches(java.lang.CharSequence text) Checks if the text of this PSI element is equal to the specified character sequence.
boolean	textMatches(PsiElement element) Checks if the text of this PSI element is equal to the text of the specified PSI element.
char []	textToCharArray() Returns the text of the PSI element as a character array.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.intellij.psi.xml.XmlTag

getHostName, getRealNs, isCaseSensitive

Methods inherited from interface com.intellij.psi.xml.XmlElement

skipValidation

Methods inherited from interface com.intellij.psi.PsiElement

getOwnReferences, getTextRangeInParent, toString

Field Detail

INSTANCE

public static XmlTag INSTANCE

Constructor Detail

EmptyXmlTag

public EmptyXmlTag()

Method Detail

getName

public java.lang.String getName()

Description copied from interface: PsiNamedElement

Returns the name of the element.

Specified by:

getName in interface PsiNamedElement

Specified by:

getName in interface XmlTag

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.

getNamespace

public java.lang.String getNamespace()

Specified by:

getNamespace in interface XmlTag

getLocalName

public java.lang.String getLocalName()

Specified by:

getLocalName in interface XmlTag

getDescriptor

public XmlElementDescriptor getDescriptor()

Specified by:

getDescriptor in interface XmlTag

getAttributes

public XmlAttribute [] getAttributes()

Specified by:

getAttributes in interface XmlTag

getAttribute

public XmlAttribute getAttribute(java.lang.String name,
                                 java.lang.String namespace)

Specified by:

getAttribute in interface XmlTag

getAttribute

public XmlAttribute getAttribute(java.lang.String qname)

Description copied from interface: XmlTag

Returns a tag attribute by qualified name.

Specified by:

getAttribute in interface XmlTag

Parameters:

qname - qualified attribute name, like "ns:name" or "name".

Returns:

null if the attribute not exist.

See Also:

XmlTag.getAttribute(String, String)

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String name,
                                          java.lang.String namespace)

Specified by:

getAttributeValue in interface XmlTag

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String qname)

Description copied from interface: XmlTag

Returns a tag attribute value by qualified name.

Specified by:

getAttributeValue in interface XmlTag

Parameters:

qname - qualified attribute name, like "ns:name" or "name".

Returns:

null if the attribute not exist.

See Also:

XmlTag.getAttributeValue(String, String)

setAttribute

public XmlAttribute setAttribute(java.lang.String name,
                                 java.lang.String namespace,
                                 java.lang.String value)
                          throws IncorrectOperationException

Specified by:

setAttribute in interface XmlTag

Throws:

IncorrectOperationException

setAttribute

public XmlAttribute setAttribute(java.lang.String qname,
                                 java.lang.String value)
                          throws IncorrectOperationException

Specified by:

setAttribute in interface XmlTag

Throws:

IncorrectOperationException

createChildTag

public XmlTag createChildTag(java.lang.String localName,
                             java.lang.String namespace,
                             java.lang.String bodyText,
                             boolean enforceNamespacesDeep)

Description copied from interface: XmlTag

Creates a new child tag

Specified by:

createChildTag in interface XmlTag

Parameters:

localName - new tag's name

namespace - new tag's namespace

bodyText - pass null to create collapsed tag, empty string means creating expanded one

enforceNamespacesDeep - if you pass some xml tags to bodyText parameter, this flag sets namespace prefixes for them

Returns:

created tag. Use XmlTag.addSubTag(XmlTag, boolean)} to add it to parent

addSubTag

public XmlTag addSubTag(XmlTag subTag,
                        boolean first)

Specified by:

addSubTag in interface XmlTag

getSubTags

public XmlTag [] getSubTags()

Specified by:

getSubTags in interface XmlTag

findSubTags

public XmlTag [] findSubTags(java.lang.String qname)

Specified by:

findSubTags in interface XmlTag

findSubTags

public XmlTag [] findSubTags(java.lang.String localName,
                             java.lang.String namespace)

Specified by:

findSubTags in interface XmlTag

Parameters:

localName - non-qualified tag name.

namespace - if null, name treated as qualified name to find.

findFirstSubTag

public XmlTag findFirstSubTag(java.lang.String qname)

Specified by:

findFirstSubTag in interface XmlTag

getNamespacePrefix

public java.lang.String getNamespacePrefix()

Specified by:

getNamespacePrefix in interface XmlTag

getNamespaceByPrefix

public java.lang.String getNamespaceByPrefix(java.lang.String prefix)

Specified by:

getNamespaceByPrefix in interface XmlTag

getPrefixByNamespace

public java.lang.String getPrefixByNamespace(java.lang.String namespace)

Specified by:

getPrefixByNamespace in interface XmlTag

knownNamespaces

public java.lang.String[] knownNamespaces()

Specified by:

knownNamespaces in interface XmlTag

hasNamespaceDeclarations

public boolean hasNamespaceDeclarations()

Specified by:

hasNamespaceDeclarations in interface XmlTag

getLocalNamespaceDeclarations

public java.util.Map<java.lang.String,java.lang.String> getLocalNamespaceDeclarations()

Specified by:

getLocalNamespaceDeclarations in interface XmlTag

Returns:

map keys: prefixes values: namespaces

getValue

public XmlTagValue getValue()

Specified by:

getValue in interface XmlTag

getNSDescriptor

public XmlNSDescriptor getNSDescriptor(java.lang.String namespace,
                                       boolean strict)

Specified by:

getNSDescriptor in interface XmlTag

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface XmlTag

collapseIfEmpty

public void collapseIfEmpty()

Specified by:

collapseIfEmpty in interface XmlTag

getSubTagText

public java.lang.String getSubTagText(java.lang.String qname)

Specified by:

getSubTagText in interface XmlTag

getParentTag

public XmlTag getParentTag()

Specified by:

getParentTag in interface XmlTagChild

getNextSiblingInTag

public XmlTagChild getNextSiblingInTag()

Specified by:

getNextSiblingInTag in interface XmlTagChild

getPrevSiblingInTag

public XmlTagChild getPrevSiblingInTag()

Specified by:

getPrevSiblingInTag in interface XmlTagChild

processElements

public boolean processElements(PsiElementProcessor processor,
                               PsiElement place)

Specified by:

processElements in interface XmlElement

getProject

public Project getProject()
                   throws PsiInvalidElementAccessException

Description copied from interface: PsiElement

Returns the project to which the PSI element belongs.

Specified by:

getProject in interface PsiElement

Returns:

the project instance.

Throws:

PsiInvalidElementAccessException - if this element is invalid

getLanguage

public Language getLanguage()

Description copied from interface: PsiElement

Returns the language of the PSI element.

Specified by:

getLanguage in interface PsiElement

Returns:

the language instance.

getManager

public PsiManager getManager()

Description copied from interface: PsiElement

Returns the PSI manager for the project to which the PSI element belongs.

Specified by:

getManager in interface PsiElement

Returns:

the PSI manager instance.

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

Returns:

the array of child elements.

getParent

public PsiElement getParent()

Description copied from interface: PsiElement

Returns the parent of the PSI element.

Specified by:

getParent in interface PsiElement

Returns:

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

getFirstChild

public PsiElement getFirstChild()

Description copied from interface: PsiElement

Returns the first child of the PSI element.

Specified by:

getFirstChild in interface PsiElement

Returns:

the first child, or null if the element has no children.

getLastChild

public PsiElement getLastChild()

Description copied from interface: PsiElement

Returns the last child of the PSI element.

Specified by:

getLastChild in interface PsiElement

Returns:

the last child, or null if the element has no children.

getNextSibling

public PsiElement getNextSibling()

Description copied from interface: PsiElement

Returns the next sibling of the PSI element.

Specified by:

getNextSibling in interface PsiElement

Returns:

the next sibling, or null if the node is the last in the list of siblings.

getPrevSibling

public PsiElement getPrevSibling()

Description copied from interface: PsiElement

Returns the previous sibling of the PSI element.

Specified by:

getPrevSibling in interface PsiElement

Returns:

the previous sibling, or null if the node is the first in the list of siblings.

getContainingFile

public PsiFile getContainingFile()
                          throws PsiInvalidElementAccessException

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

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

Throws:

PsiInvalidElementAccessException - if this element is invalid

getTextRange

public TextRange getTextRange()

Description copied from interface: PsiElement

Returns the text range in the document occupied by the PSI element.

Note: it works in O(tree_depth) time, which can be slow in deep trees, so invoking this method should be avoided if possible.

Specified by:

getTextRange in interface PsiElement

Returns:

the text range.

getStartOffsetInParent

public int getStartOffsetInParent()

Description copied from interface: PsiElement

Returns the text offset of the PSI element relative to its parent.

Specified by:

getStartOffsetInParent in interface PsiElement

Returns:

the relative offset.

getTextLength

public int getTextLength()

Description copied from interface: PsiElement

Returns the length of text of the PSI element.

Specified by:

getTextLength in interface PsiElement

Returns:

the text length.

findElementAt

public PsiElement findElementAt(int offset)

Description copied from interface: PsiElement

Finds a leaf PSI element at the specified offset from the start of the text range of this node.

Specified by:

findElementAt in interface PsiElement

Parameters:

offset - the relative offset for which the PSI element is requested.

Returns:

the element at the offset, or null if none is found.

findReferenceAt

public PsiReference findReferenceAt(int offset)

Description copied from interface: PsiElement

Finds a reference at the specified offset from the start of the text range of this node.

Specified by:

findReferenceAt in interface PsiElement

Parameters:

offset - the relative offset for which the reference is requested.

Returns:

the reference at the offset, or null if none is found.

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

Returns:

the offset of the PSI element.

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

Returns:

the element text.

See Also:

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

textToCharArray

public char [] textToCharArray()

Description copied from interface: PsiElement

Returns the text of the PSI element as a character array.

Specified by:

textToCharArray in interface PsiElement

Returns:

the element text as a character array.

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

Returns:

the navigation target 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

Returns:

the original element.

textMatches

public boolean textMatches(java.lang.CharSequence text)

Description copied from interface: PsiElement

Checks if the text of this PSI element is equal to the specified character sequence.

Specified by:

textMatches in interface PsiElement

Parameters:

text - the character sequence to compare with.

Returns:

true if the text is equal, false otherwise.

textMatches

public boolean textMatches(PsiElement element)

Description copied from interface: PsiElement

Checks if the text of this PSI element is equal to the text of the specified PSI element.

Specified by:

textMatches in interface PsiElement

Parameters:

element - the element to compare the text with.

Returns:

true if the text is equal, false otherwise.

textContains

public boolean textContains(char c)

Description copied from interface: PsiElement

Checks if the text of this element contains the specified character.

Specified by:

textContains in interface PsiElement

Parameters:

c - the character to search for.

Returns:

true if the character is found, false otherwise.

accept

public void accept(PsiElementVisitor visitor)

Description copied from interface: PsiElement

Passes the element to the specified visitor.

Specified by:

accept in interface PsiElement

Parameters:

visitor - the visitor to pass the element to.

acceptChildren

public void acceptChildren(PsiElementVisitor visitor)

Description copied from interface: PsiElement

Passes the children of the element to the specified visitor.

Specified by:

acceptChildren in interface PsiElement

Parameters:

visitor - the visitor to pass the children to.

copy

public PsiElement copy()

Description copied from interface: PsiElement

Creates a copy of the file containing the PSI element and returns the corresponding element in the created copy. Resolve operations performed on elements in the copy of the file will resolve to elements in the copy, not in the original file.

Specified by:

copy in interface PsiElement

Returns:

the element in the file copy corresponding to this element.

add

public PsiElement add(PsiElement element)
               throws IncorrectOperationException

Description copied from interface: PsiElement

Adds a child to this PSI element.

Specified by:

add in interface PsiElement

Parameters:

element - the child element to add.

Returns:

the element which was actually added (either element or its copy).

Throws:

IncorrectOperationException - if the modification is not supported or not possible for some reason.

addBefore

public PsiElement addBefore(PsiElement element,
                            PsiElement anchor)
                     throws IncorrectOperationException

Description copied from interface: PsiElement

Adds a child to this PSI element, before the specified anchor element.

Specified by:

addBefore in interface PsiElement

Parameters:

element - the child element to add.

anchor - the anchor before which the child element is inserted (must be a child of this PSI element)

Returns:

the element which was actually added (either element or its copy).

Throws:

IncorrectOperationException - if the modification is not supported or not possible for some reason.

addAfter

public PsiElement addAfter(PsiElement element,
                           PsiElement anchor)
                    throws IncorrectOperationException

Description copied from interface: PsiElement

Adds a child to this PSI element, after the specified anchor element.

Specified by:

addAfter in interface PsiElement

Parameters:

element - the child element to add.

anchor - the anchor after which the child element is inserted (must be a child of this PSI element)

Returns:

the element which was actually added (either element or its copy).

Throws:

IncorrectOperationException - if the modification is not supported or not possible for some reason.

checkAdd

public void checkAdd(PsiElement element)
              throws IncorrectOperationException

Description copied from interface: PsiElement

Checks if it is possible to add the specified element as a child to this element, and throws an exception if the add is not possible. Does not actually modify anything.

Specified by:

checkAdd in interface PsiElement

Parameters:

element - the child element to check the add possibility.

Throws:

IncorrectOperationException - if the modification is not supported or not possible for some reason.

addRange

public PsiElement addRange(PsiElement first,
                           PsiElement last)
                    throws IncorrectOperationException

Description copied from interface: PsiElement

Adds a range of elements as children to this PSI element.

Specified by:

addRange in interface PsiElement

Parameters:

first - the first child element to add.

last - the last child element to add (must have the same parent as first)

Returns:

the first child element which was actually added (either first or its copy).

Throws:

IncorrectOperationException - if the modification is not supported or not possible for some reason.

addRangeBefore

public PsiElement addRangeBefore(PsiElement first,
                                 PsiElement last,
                                 PsiElement anchor)
                          throws IncorrectOperationException

Description copied from interface: PsiElement

Adds a range of elements as children to this PSI element, before the specified anchor element.

Specified by:

addRangeBefore in interface PsiElement

Parameters:

first - the first child element to add.

last - the last child element to add (must have the same parent as first)

anchor - the anchor before which the child element is inserted (must be a child of this PSI element)

Returns:

the first child element which was actually added (either first or its copy).

Throws:

IncorrectOperationException - if the modification is not supported or not possible for some reason.

addRangeAfter

public PsiElement addRangeAfter(PsiElement first,
                                PsiElement last,
                                PsiElement anchor)
                         throws IncorrectOperationException

Description copied from interface: PsiElement

Adds a range of elements as children to this PSI element, after the specified anchor element.

Specified by:

addRangeAfter in interface PsiElement

Parameters:

first - the first child element to add.

last - the last child element to add (must have the same parent as first)

anchor - the anchor after which the child element is inserted (must be a child of this PSI element)

Returns:

the first child element which was actually added (either first or its copy).

Throws:

IncorrectOperationException - if the modification is not supported or not possible for some reason.

delete

public void delete()
            throws IncorrectOperationException

Description copied from interface: PsiElement

Deletes this PSI element from the tree.

Specified by:

delete in interface PsiElement

Throws:

IncorrectOperationException - if the modification is not supported or not possible for some reason (for example, the file containing the element is read-only).

checkDelete

public void checkDelete()
                 throws IncorrectOperationException

Description copied from interface: PsiElement

Checks if it is possible to delete the specified element from the tree, and throws an exception if the add is not possible. Does not actually modify anything.

Specified by:

checkDelete in interface PsiElement

Throws:

IncorrectOperationException - if the modification is not supported or not possible for some reason.

deleteChildRange

public void deleteChildRange(PsiElement first,
                             PsiElement last)
                      throws IncorrectOperationException

Description copied from interface: PsiElement

Deletes a range of children of this PSI element from the tree.

Specified by:

deleteChildRange in interface PsiElement

Parameters:

first - the first child to delete (must be a child of this PSI element)

last - the last child to delete (must be a child of this PSI element)

Throws:

IncorrectOperationException - if the modification is not supported or not possible for some reason.

replace

public PsiElement replace(PsiElement newElement)
                   throws IncorrectOperationException

Description copied from interface: PsiElement

Replaces this PSI element (along with all its children) with another element (along with the children).

Specified by:

replace in interface PsiElement

Parameters:

newElement - the element to replace this element with.

Returns:

the element which was actually inserted in the tree (either newElement or its copy)

Throws:

IncorrectOperationException - if the modification is not supported or not possible for some reason.

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

Returns:

true if the element is valid, false otherwise.

See Also:

PsiUtilCore.ensureValid(PsiElement)

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

Returns:

true if the element can be modified, false otherwise.

getReference

public PsiReference getReference()

Description copied from interface: PsiElement

Returns the reference from this PSI element to another PSI element (or elements), if one exists. If the element has multiple associated references (see PsiElement.getReferences() for an example), returns the first associated reference.

Specified by:

getReference in interface PsiElement

Returns:

the reference instance, or null if the PSI element does not have any associated references.

See Also:

ReferencesSearch

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

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

getCopyableUserData

public <T> T getCopyableUserData(Key<T> key)

Description copied from interface: PsiElement

Returns a copyable user data object attached to this element.

Specified by:

getCopyableUserData in interface PsiElement

Parameters:

key - the key for accessing the user data object.

Returns:

the user data object, or null if no such object is found in the current element.

See Also:

PsiElement.putCopyableUserData(Key, Object)

putCopyableUserData

public <T> void putCopyableUserData(Key<T> key,
                                    T value)

Description copied from interface: PsiElement

Attaches a copyable user data object to this element. Copyable user data objects are copied when the PSI elements are copied.

Specified by:

putCopyableUserData in interface PsiElement

Parameters:

key - the key for accessing the user data object.

value - the user data object to attach.

See Also:

PsiElement.getCopyableUserData(Key)

processDeclarations

public boolean processDeclarations(PsiScopeProcessor processor,
                                   ResolveState state,
                                   PsiElement lastParent,
                                   PsiElement place)

Description copied from interface: PsiElement

Passes the declarations contained in this PSI element and its children for processing to the specified scope processor.

Specified by:

processDeclarations in interface PsiElement

Parameters:

processor - the processor receiving the declarations.

lastParent - the child of this element has been processed during the previous step of the tree up walk (declarations under this element do not need to be processed again)

place - the original element from which the tree up walk was initiated.

Returns:

true if the declaration processing should continue or false if it should be stopped.

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

Returns:

the resolve context element.

isPhysical

public boolean isPhysical()

Description copied from interface: PsiElement

Checks if an actual source or class file corresponds to the element. Non-physical elements include, for example, PSI elements created for the watch expressions in the debugger. Non-physical elements do not generate tree change events. Also, PsiDocumentManager.getDocument(PsiFile) returns null for non-physical elements. Not to be confused with FileViewProvider.isPhysical().

Specified by:

isPhysical in interface PsiElement

Returns:

true if the element is physical, false otherwise.

getResolveScope

public GlobalSearchScope getResolveScope()

Description copied from interface: PsiElement

Returns the scope in which the declarations for the references in this PSI element are searched.

Specified by:

getResolveScope in interface PsiElement

Returns:

the resolve scope instance.

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

Returns:

the search scope instance.

See Also:

PsiSearchHelper.getUseScope(PsiElement)

getNode

public ASTNode getNode()

Description copied from interface: PsiElement

Returns the AST node corresponding to the element.

Specified by:

getNode in interface PsiElement

Returns:

the AST node instance.

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

getIcon

public javax.swing.Icon getIcon(int flags)

Specified by:

getIcon in interface Iconable

getMetaData

public PsiMetaData getMetaData()

Specified by:

getMetaData in interface PsiMetaOwner

getUserData

public <T> T getUserData(Key<T> key)

Specified by:

getUserData in interface UserDataHolder

Returns:

a user data value associated with this object. Doesn't require read action.

putUserData

public <T> void putUserData(Key<T> key,
                            T value)

Description copied from interface: UserDataHolder

Add a new user data value to this object. Doesn't require write action.

Specified by:

putUserData in interface UserDataHolder