Package com.intellij.util.xml

Interface DomElement

All Superinterfaces:

AnnotatedElement, UserDataHolder

All Known Subinterfaces:

AbstractMethodParams, AnyName, AppEngineWebApp, DomFileElement<T>, GenericAttributeValue<T>, GenericDomValue<T>, Name, NsName, OpenNameClasses, RngAttribute, RngChoice, RngData, RngDefine, RngDiv, RngDomElement, RngElement, RngEmpty, RngExcept, RngExternalRef, RngGrammar, RngGrammarContent, RngGroup, RngInclude, RngIncludeContent, RngInterleave, RngList, RngMixed, RngNotAllowed, RngOneOrMore, RngOpenPattern, RngOpenPatterns, RngOptional, RngParam, RngParentRef, RngRef, RngStart, RngText, RngValue, RngZeroOrMore

All Known Implementing Classes:

AntDomAnt, AntDomAntCall, AntDomAntCallParam, AntDomAntlib, AntDomBasenameTask, AntDomBuildnumberTask, AntDomChecksumTask, AntDomClasspath, AntDomClasspathComponent, AntDomCustomClasspathComponent, AntDomCustomElement, AntDomDirname, AntDomDirSet, AntDomElement, AntDomExecTask, AntDomFileList, AntDomFileSet, AntDomFilesProviderImpl, AntDomImport, AntDomInclude, AntDomIncludingDirective, AntDomInputTask, AntDomLengthTask, AntDomLoadFileTask, AntDomMacroDef, AntDomMacrodefAttribute, AntDomMacrodefElement, AntDomMacrodefText, AntDomNamedElement, AntDomPath, AntDomPathElement, AntDomPresetDef, AntDomProject, AntDomProperty, AntDomPropertyDefiningElement, AntDomPropertyDefiningTask, AntDomPropertyDefiningTaskWithDefaultValue, AntDomScriptDef, AntDomScriptdefAttribute, AntDomScriptdefElement, AntDomSequentialTask, AntDomTarget, AntDomTaskdef, AntDomTempFile, AntDomTimestampTask, AntDomTimestampTaskFormat, AntDomTypeDef, AntDomWhichResourceTask, AttributeChildInvocationHandler, CollectionElementInvocationHandler, DomFileElementImpl, DomInvocationHandler, DomRootInvocationHandler, IndexedElementInvocationHandler, RngDefineImpl, RngDomElementBase, RngGrammarImpl, RngIncludeImpl, RngRefImpl

public interface DomElement
extends AnnotatedElement, UserDataHolder

Base interface for DOM elements. Every DOM interface should extend this one.

Field Summary

Fields

Modifier and Type	Field and Description
static DomElement[]	EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
void	accept(DomElementVisitor visitor)
void	acceptChildren(DomElementVisitor visitor)
void	copyFrom(DomElement other)
<T extends DomElement> T	createMockCopy(boolean physical)
<T extends DomElement> T	createStableCopy()
XmlTag	ensureTagExists()
XmlElement	ensureXmlElementExists()
boolean	exists()
AbstractDomChildrenDescription	getChildDescription()
java.lang.reflect.Type	getDomElementType()
DomGenericInfo	getGenericInfo()
DomManager	getManager()
Module	getModule()
DomNameStrategy	getNameStrategy()
DomElement	getParent()
<T extends DomElement> T	getParentOfType(java.lang.Class<T> requiredClass, boolean strict) Walk up the DOM tree searching for element of requiredClass type
ElementPresentation	getPresentation()
GlobalSearchScope	getResolveScope()
XmlElement	getXmlElement() Returns the underlying XML element/file.
java.lang.String	getXmlElementName()
java.lang.String	getXmlElementNamespace()
java.lang.String	getXmlElementNamespaceKey()
XmlTag	getXmlTag()
boolean	isValid()
void	undefine() Removes all corresponding XML content.

Methods inherited from interface com.intellij.util.xml.AnnotatedElement

getAnnotation

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Field Detail

EMPTY_ARRAY

static final DomElement[] EMPTY_ARRAY

Method Detail

getXmlTag

XmlTag getXmlTag()

getXmlElement

XmlElement getXmlElement()

Returns the underlying XML element/file.

Returns:

XmlFile, XmlTag or XmlAttribute

getParent

DomElement getParent()

ensureTagExists

XmlTag ensureTagExists()

ensureXmlElementExists

XmlElement ensureXmlElementExists()

undefine

void undefine()

Removes all corresponding XML content. In case of being collection member, invalidates the element.

isValid

boolean isValid()

exists

boolean exists()

Returns:

true if corresponding XML element exists

getGenericInfo

DomGenericInfo getGenericInfo()

getXmlElementName

java.lang.String getXmlElementName()

getXmlElementNamespace

java.lang.String getXmlElementNamespace()

getXmlElementNamespaceKey

java.lang.String getXmlElementNamespaceKey()

Returns:

namespace key if this element or one of its ancestors is annotated with Namespace, or null otherwise, which means that namespace should be equal to that of the element's parent

accept

void accept(DomElementVisitor visitor)

acceptChildren

void acceptChildren(DomElementVisitor visitor)

getManager

DomManager getManager()

getDomElementType

java.lang.reflect.Type getDomElementType()

getChildDescription

AbstractDomChildrenDescription getChildDescription()

getNameStrategy

DomNameStrategy getNameStrategy()

getPresentation

ElementPresentation getPresentation()

getResolveScope

GlobalSearchScope getResolveScope()

getParentOfType

<T extends DomElement> T getParentOfType(java.lang.Class<T> requiredClass,
                                         boolean strict)

Walk up the DOM tree searching for element of requiredClass type

Parameters:

requiredClass - parent element's type

strict -

• strict = false: if the current element is already of the correct type, then it is returned.
• strict = true: the returned element must be higher in the hierarchy.

Returns:

the parent of requiredClass type

getModule

Module getModule()

copyFrom

void copyFrom(DomElement other)

createMockCopy

<T extends DomElement> T createMockCopy(boolean physical)

createStableCopy

<T extends DomElement> T createStableCopy()

Returns:

stable element (see DomManager.createStableValue(com.intellij.openapi.util.Factory)}), that holds the complete 'XPath' to this element in XML. If this element is in collection, and something is inserted before it, the stable copy behaviour may be unexpected. So use this method only when you are sure that nothing serious will happen during the lifetime of the stable copy. The most usual use case is when one creates something inside WriteCommandAction and wants to use it outside the action. Due to formatting done on the command finish the element may become invalidated, but the stable copy will survive, because nothing in fact has changed in its 'XPath'.