DomFileDescription (Unofficial IntelliJ Community Edition API docs)

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

Direct Known Subclasses:

AntFileDescription, AppEngineWebFileDescription, MergingFileDescription, MockDomFileDescription, RngDomFileDescription
```
public class DomFileDescription<T>
extends java.lang.Object
```
Use com.intellij.dom.fileMetaData to register.

See Also:

MergingFileDescription

Field Summary

Fields
Modifier and Type	Field and Description
`static ExtensionPointName<DomFileDescription>`	`EP_NAME` Deprecated. use `com.intellij.dom.fileMetaData` extension instead
`protected java.lang.Class<T>`	`myRootElementClass`
`protected java.lang.String`	`myRootTagName`

Constructor Summary

Constructors
Constructor and Description
`DomFileDescription(java.lang.Class<T> rootElementClass, java.lang.String rootTagName, java.lang.String... allPossibleRootTagNamespaces)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`acceptsOtherRootTagNames()`
`DomElementsAnnotator`	`createAnnotator()` Create custom DOM annotator that will be used when error-highlighting DOM.
`java.util.List<java.lang.String>`	`getAllowedNamespaces(java.lang.String namespaceKey, XmlFile file)` Consider using `DomService.getXmlFileHeader(XmlFile)` when implementing this.
`java.lang.String []`	`getAllPossibleRootTagNamespaces()`
`java.util.Set<?>`	`getDependencyItems(XmlFile file)` Get dependency items (the same, as in `CachedValue`) for file.
`javax.swing.Icon`	`getFileIcon(int flags)`
`DomElement`	`getIdentityScope(DomElement element)`
`java.util.Map<java.lang.Class<? extends DomElement>,java.lang.Class<? extends DomElement>>`	`getImplementations()`
`java.util.List<DomReferenceInjector>`	`getReferenceInjectors()`
`DomElement`	`getResolveScope(GenericDomValue<?> reference)`
`java.lang.Class<T>`	`getRootElementClass()`
`java.lang.String`	`getRootTagName()`
`protected DomElement`	`getScopeFromAnnotation(DomElement element)`
`int`	`getStubVersion()` Deprecated. define "stubVersion" of `com.intellij.dom.fileMetaData` extension instead
`TypeChooserManager`	`getTypeChooserManager()`
`int`	`getVersion()` Deprecated. use "domVersion" attribute of `com.intellij.dom.fileMetaData` extension instead
`boolean`	`hasStubs()` Deprecated. define "stubVersion" of `com.intellij.dom.fileMetaData` extension instead
`protected void`	`initializeFileDescription()` The right place to call `registerNamespacePolicy(String, String...)` `registerTypeChooser(Type, TypeChooser)` `registerReferenceInjector(DomReferenceInjector)`
`boolean`	`isAutomaticHighlightingEnabled()`
`boolean`	`isMyFile(XmlFile file, Module module)`
`<Dom extends DomElement> void`	`registerImplementation(java.lang.Class<Dom> domElementClass, java.lang.Class<? extends Dom> implementationClass)` Deprecated. use dom.implementation extension point instead
`protected void`	`registerNamespacePolicy(java.lang.String namespaceKey, NotNullFunction<XmlTag,java.util.List<java.lang.String>> policy)` Deprecated. use `registerNamespacePolicy(String, String...)` or override `getAllowedNamespaces(String, XmlFile)` instead
`void`	`registerNamespacePolicy(java.lang.String namespaceKey, java.lang.String... namespaces)`
`protected void`	`registerReferenceInjector(DomReferenceInjector injector)`
`protected void`	`registerTypeChooser(java.lang.reflect.Type aClass, TypeChooser typeChooser)`
`java.lang.String`	`toString()`

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

- Field Detail
  - EP_NAME
```
@Deprecated
public static final ExtensionPointName<DomFileDescription> EP_NAME
```
    Deprecated. use com.intellij.dom.fileMetaData extension instead
  - myRootElementClass
```
protected final java.lang.Class<T> myRootElementClass
```
  - myRootTagName
```
protected final java.lang.String myRootTagName
```
- Constructor Detail
  - DomFileDescription
```
public DomFileDescription(java.lang.Class<T> rootElementClass,
                          java.lang.String rootTagName,
                          java.lang.String... allPossibleRootTagNamespaces)
```
- Method Detail
  - getAllPossibleRootTagNamespaces
```
public java.lang.String [] getAllPossibleRootTagNamespaces()
```
  - registerImplementation
```
@Deprecated
public final <Dom extends DomElement> void registerImplementation(java.lang.Class<Dom> domElementClass,
                                                                  java.lang.Class<? extends Dom> implementationClass)
```
    Deprecated. use dom.implementation extension point instead
    
    Register an implementation class to provide additional functionality for DOM elements.
    
    Parameters:
    
    domElementClass - interface class.
    
    implementationClass - abstract implementation class.
    
    See Also:
    
    initializeFileDescription()
  - registerNamespacePolicy
```
@Deprecated
protected final void registerNamespacePolicy(java.lang.String namespaceKey,
                                             NotNullFunction<XmlTag,java.util.List<java.lang.String>> policy)
```
    Deprecated. use registerNamespacePolicy(String, String...) or override getAllowedNamespaces(String, XmlFile) instead
    
    Parameters:
    
    namespaceKey - namespace identifier
    
    policy - function that takes XML file root tag and returns (maybe empty) list of possible namespace URLs or DTD public ids. This function shouldn't use DOM since it may be not initialized for the file at the moment
    
    See Also:
    
    Namespace
  - registerNamespacePolicy
```
public final void registerNamespacePolicy(java.lang.String namespaceKey,
                                          java.lang.String... namespaces)
```
    Parameters:
    
    namespaceKey - namespace identifier
    
    namespaces - XML namespace or DTD public or system id value for the given namespaceKey
    
    See Also:
    
    Namespace
  - getAllowedNamespaces
```
public java.util.List<java.lang.String> getAllowedNamespaces(java.lang.String namespaceKey,
                                                             XmlFile file)
```
    Consider using DomService.getXmlFileHeader(XmlFile) when implementing this.
  - getVersion
```
@Deprecated
public int getVersion()
```
    Deprecated. use "domVersion" attribute of com.intellij.dom.fileMetaData extension instead
    
    Returns:
    
    some version. Override and change (e.g. super.getVersion()+1) when after some changes some files stopped being described by this description or vice versa, so that the DomService.getDomFileCandidates(Class, com.intellij.openapi.project.Project, com.intellij.psi.search.GlobalSearchScope) index is rebuilt correctly.
  - registerTypeChooser
```
protected final void registerTypeChooser(java.lang.reflect.Type aClass,
                                         TypeChooser typeChooser)
```
  - getTypeChooserManager
```
public final TypeChooserManager getTypeChooserManager()
```
  - registerReferenceInjector
```
protected final void registerReferenceInjector(DomReferenceInjector injector)
```
  - getReferenceInjectors
```
public java.util.List<DomReferenceInjector> getReferenceInjectors()
```
  - isAutomaticHighlightingEnabled
```
public boolean isAutomaticHighlightingEnabled()
```
  - getFileIcon
```
public javax.swing.Icon getFileIcon(int flags)
```
  - initializeFileDescription
```
protected void initializeFileDescription()
```
    The right place to call
  - createAnnotator
```
public DomElementsAnnotator createAnnotator()
```
    Create custom DOM annotator that will be used when error-highlighting DOM. The results will be collected to DomElementsProblemsHolder. The highlighting will be most probably done in an BasicDomElementsInspection instance.
    
    Returns:
    
    Annotator or null
  - getImplementations
```
public final java.util.Map<java.lang.Class<? extends DomElement>,java.lang.Class<? extends DomElement>> getImplementations()
```
  - getRootElementClass
```
public final java.lang.Class<T> getRootElementClass()
```
  - getRootTagName
```
public final java.lang.String getRootTagName()
```
  - isMyFile
```
public boolean isMyFile(XmlFile file,
                        Module module)
```
  - acceptsOtherRootTagNames
```
public boolean acceptsOtherRootTagNames()
```
  - getDependencyItems
```
public java.util.Set<?> getDependencyItems(XmlFile file)
```
    Get dependency items (the same, as in CachedValue) for file. On any dependency item change, the isMyFile(XmlFile, Module) method will be invoked once more to ensure that the file description still accepts this file.
    
    Parameters:
    
    file - XML file to get dependencies of
    
    Returns:
    
    dependency item set
  - getResolveScope
```
public DomElement getResolveScope(GenericDomValue<?> reference)
```
    Parameters:
    
    reference - DOM reference
    
    Returns:
    
    element, whose all children will be searched for declaration
  - getIdentityScope
```
public DomElement getIdentityScope(DomElement element)
```
    Parameters:
    
    element - DOM element
    
    Returns:
    
    element, whose direct children names will be compared by name. Basically it's parameter element's parent (see ParentScopeProvider).
  - getScopeFromAnnotation
```
protected final DomElement getScopeFromAnnotation(DomElement element)
```
  - hasStubs
```
@Deprecated
public boolean hasStubs()
```
    Deprecated. define "stubVersion" of com.intellij.dom.fileMetaData extension instead
    
    See Also:
    
    Stubbed
  - getStubVersion
```
@Deprecated
public int getStubVersion()
```
    Deprecated. define "stubVersion" of com.intellij.dom.fileMetaData extension instead
    
    See Also:
    
    Stubbed
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class DomFileDescription<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EP_NAME

myRootElementClass

myRootTagName

Constructor Detail

DomFileDescription

Method Detail

getAllPossibleRootTagNamespaces

registerImplementation

registerNamespacePolicy

registerNamespacePolicy

getAllowedNamespaces

getVersion

registerTypeChooser

getTypeChooserManager

registerReferenceInjector

getReferenceInjectors

isAutomaticHighlightingEnabled

getFileIcon

initializeFileDescription

createAnnotator

getImplementations

getRootElementClass

getRootTagName

isMyFile

acceptsOtherRootTagNames

getDependencyItems

getResolveScope

getIdentityScope

getScopeFromAnnotation

hasStubs

getStubVersion

toString