DomFileElementImpl (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.util.xml.impl.DomFileElementImpl<T>

All Implemented Interfaces:: ModificationTracker, UserDataHolder, SemElement, AnnotatedElement, DomElement, DomFileElement<T>

public class DomFileElementImpl<T extends DomElement>
extends java.lang.Object
implements DomFileElement<T>, SemElement

Field Summary
- Fields inherited from interface com.intellij.util.xml.DomElement
  EMPTY_ARRAY
- Fields inherited from interface com.intellij.openapi.util.ModificationTracker
  EVER_CHANGED, NEVER_CHANGED

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DomFileElementImpl(XmlFile file, EvaluatedXmlNameImpl rootTagName, DomFileDescription<T> fileDescription, FileStub stub)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accept(DomElementVisitor visitor)`
`void`	`acceptChildren(DomElementVisitor visitor)`
`java.lang.String`	`checkValidity()`
`void`	`copyFrom(DomElement other)`
`<T extends DomElement> T`	`createMockCopy(boolean physical)`
`<T extends DomElement> T`	`createStableCopy()`
`XmlTag`	`ensureTagExists()`
`XmlElement`	`ensureXmlElementExists()`
`boolean`	`equals(java.lang.Object o)`
`boolean`	`exists()`
`<T extends java.lang.annotation.Annotation> T`	`getAnnotation(java.lang.Class<T> annotationClass)`
`AbstractDomChildrenDescription`	`getChildDescription()`
`java.lang.reflect.Type`	`getDomElementType()`
`XmlFile`	`getFile()`
`DomFileDescription<T>`	`getFileDescription()`
`DomGenericInfo`	`getGenericInfo()`
`DomManagerImpl`	`getManager()`
`long`	`getModificationCount()`
`Module`	`getModule()`
`DomNameStrategy`	`getNameStrategy()`
`XmlFile`	`getOriginalFile()`
`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()`
`<T extends DomElement> DomFileElementImpl<T>`	`getRoot()`
`T`	`getRootElement()`
`java.lang.Class<T>`	`getRootElementClass()`
`protected DomRootInvocationHandler`	`getRootHandler()`
`XmlTag`	`getRootTag()`
`<T> T`	`getUserData(Key<T> key)`
`XmlElement`	`getXmlElement()` Returns the underlying XML element/file.
`java.lang.String`	`getXmlElementName()`
`java.lang.String`	`getXmlElementNamespace()`
`java.lang.String`	`getXmlElementNamespaceKey()`
`XmlTag`	`getXmlTag()`
`int`	`hashCode()`
`boolean`	`isValid()`
`<T> void`	`putUserData(Key<T> key, T value)` Add a new user data value to this object.
`java.lang.String`	`toString()`
`void`	`undefine()` Removes all corresponding XML content.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DomFileElementImpl
```
protected DomFileElementImpl(XmlFile file,
                             EvaluatedXmlNameImpl rootTagName,
                             DomFileDescription<T> fileDescription,
                             FileStub stub)
```
- Method Detail
  - getFile
```
public final XmlFile getFile()
```
    Specified by:
    
    getFile in interface DomFileElement<T extends DomElement>
  - getOriginalFile
```
public XmlFile getOriginalFile()
```
    Specified by:
    
    getOriginalFile in interface DomFileElement<T extends DomElement>
  - getRootTag
```
public XmlTag getRootTag()
```
    Specified by:
    
    getRootTag in interface DomFileElement<T extends DomElement>
  - 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
  - getManager
```
public final DomManagerImpl getManager()
```
    Specified by:
    
    getManager in interface DomElement
  - getDomElementType
```
public final java.lang.reflect.Type getDomElementType()
```
    Specified by:
    
    getDomElementType in interface DomElement
  - getChildDescription
```
public AbstractDomChildrenDescription getChildDescription()
```
    Specified by:
    
    getChildDescription in interface DomElement
  - getNameStrategy
```
public DomNameStrategy getNameStrategy()
```
    Specified by:
    
    getNameStrategy in interface DomElement
  - getPresentation
```
public ElementPresentation getPresentation()
```
    Specified by:
    
    getPresentation in interface DomElement
  - getResolveScope
```
public GlobalSearchScope getResolveScope()
```
    Specified by:
    
    getResolveScope in interface DomElement
  - getParentOfType
```
public <T extends DomElement> T getParentOfType(java.lang.Class<T> requiredClass,
                                                boolean strict)
```
    Description copied from interface: DomElement
    
    Walk up the DOM tree searching for element of requiredClass type
    Specified by:
    
    getParentOfType in interface DomElement
    
    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
```
public Module getModule()
```
    Specified by:
    
    getModule in interface DomElement
  - copyFrom
```
public void copyFrom(DomElement other)
```
    Specified by:
    
    copyFrom in interface DomElement
  - createMockCopy
```
public final <T extends DomElement> T createMockCopy(boolean physical)
```
    Specified by:
    
    createMockCopy in interface DomElement
  - createStableCopy
```
public final <T extends DomElement> T createStableCopy()
```
    Specified by:
    
    createStableCopy in interface DomElement
    
    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'.
  - getXmlElementNamespace
```
public java.lang.String getXmlElementNamespace()
```
    Specified by:
    
    getXmlElementNamespace in interface DomElement
  - getXmlElementNamespaceKey
```
public java.lang.String getXmlElementNamespaceKey()
```
    Specified by:
    
    getXmlElementNamespaceKey in interface DomElement
    
    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
  - getRootElement
```
public final T getRootElement()
```
    Specified by:
    
    getRootElement in interface DomFileElement<T extends DomElement>
  - getRootElementClass
```
public java.lang.Class<T> getRootElementClass()
```
    Specified by:
    
    getRootElementClass in interface DomFileElement<T extends DomElement>
  - getFileDescription
```
public DomFileDescription<T> getFileDescription()
```
    Specified by:
    
    getFileDescription in interface DomFileElement<T extends DomElement>
  - getRootHandler
```
protected final DomRootInvocationHandler getRootHandler()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getAnnotation
```
public <T extends java.lang.annotation.Annotation> T getAnnotation(java.lang.Class<T> annotationClass)
```
    Specified by:
    
    getAnnotation in interface AnnotatedElement
  - getXmlTag
```
public final XmlTag getXmlTag()
```
    Specified by:
    
    getXmlTag in interface DomElement
  - getRoot
```
public <T extends DomElement> DomFileElementImpl<T> getRoot()
```
  - getParent
```
public DomElement getParent()
```
    Specified by:
    
    getParent in interface DomElement
  - ensureTagExists
```
public final XmlTag ensureTagExists()
```
    Specified by:
    
    ensureTagExists in interface DomElement
  - getXmlElement
```
public final XmlElement getXmlElement()
```
    Description copied from interface: DomElement
    
    Returns the underlying XML element/file.
    
    Specified by:
    
    getXmlElement in interface DomElement
    
    Returns:
    
    XmlFile, XmlTag or XmlAttribute
  - ensureXmlElementExists
```
public final XmlElement ensureXmlElementExists()
```
    Specified by:
    
    ensureXmlElementExists in interface DomElement
  - undefine
```
public void undefine()
```
    Description copied from interface: DomElement
    
    Removes all corresponding XML content. In case of being collection member, invalidates the element.
    
    Specified by:
    
    undefine in interface DomElement
  - isValid
```
public final boolean isValid()
```
    Specified by:
    
    isValid in interface DomElement
  - exists
```
public boolean exists()
```
    Specified by:
    
    exists in interface DomElement
    
    Returns:
    
    true if corresponding XML element exists
  - checkValidity
```
public java.lang.String checkValidity()
```
  - getGenericInfo
```
public final DomGenericInfo getGenericInfo()
```
    Specified by:
    
    getGenericInfo in interface DomElement
  - getXmlElementName
```
public java.lang.String getXmlElementName()
```
    Specified by:
    
    getXmlElementName in interface DomElement
  - accept
```
public void accept(DomElementVisitor visitor)
```
    Specified by:
    
    accept in interface DomElement
  - acceptChildren
```
public void acceptChildren(DomElementVisitor visitor)
```
    Specified by:
    
    acceptChildren in interface DomElement
  - 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
  - getModificationCount
```
public final long getModificationCount()
```
    Specified by:
    
    getModificationCount in interface ModificationTracker

Class DomFileElementImpl<T extends DomElement>

Field Summary

Fields inherited from interface com.intellij.util.xml.DomElement

Fields inherited from interface com.intellij.openapi.util.ModificationTracker

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DomFileElementImpl

Method Detail

getFile

getOriginalFile

getRootTag

equals

hashCode

getManager

getDomElementType

getChildDescription

getNameStrategy

getPresentation

getResolveScope

getParentOfType

getModule

copyFrom

createMockCopy

createStableCopy

getXmlElementNamespace

getXmlElementNamespaceKey

getRootElement

getRootElementClass

getFileDescription

getRootHandler

toString

getAnnotation

getXmlTag

getRoot

getParent

ensureTagExists

getXmlElement

ensureXmlElementExists

undefine

isValid

exists

checkValidity

getGenericInfo

getXmlElementName

accept

acceptChildren

getUserData

putUserData

getModificationCount