Package com.intellij.util.xml.impl

Class DomManagerImpl

java.lang.Object

com.intellij.openapi.util.SimpleModificationTracker

com.intellij.openapi.util.CompositeModificationTracker

com.intellij.util.xml.DomManager

com.intellij.util.xml.impl.DomManagerImpl

All Implemented Interfaces:

ModificationTracker

public final class DomManagerImpl
extends DomManager

Field Summary

Fields inherited from class com.intellij.util.xml.DomManager

MOCK_ELEMENT_MODULE

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

EVER_CHANGED, NEVER_CHANGED

Constructor Summary

Constructors

Constructor and Description
DomManagerImpl(Project project)

Method Summary

Modifier and Type	Method and Description
void	addDomEventListener(DomEventListener listener, Disposable parentDisposable)
<T extends DomElement> T	createMockElement(java.lang.Class<T> aClass, Module module, boolean physical)
ModelMerger	createModelMerger()
<T extends DomElement> T	createStableValue(Factory<? extends T> provider) Creates DOM element of needed type, that is wrapper around real DOM element.
<T> T	createStableValue(Factory<? extends T> provider, Condition<? super T> validator)
AbstractDomChildrenDescription	findChildrenDescription(XmlTag tag, DomElement parent)
java.util.Set<DomFileDescription<?>>	getAcceptingOtherRootTagNameDescriptions()
DomApplicationComponent	getApplicationComponent()
java.lang.String	getComponentName()
ConverterManager	getConverterManager()
GenericAttributeValue<?>	getDomElement(XmlAttribute attribute)
DomElement	getDomElement(XmlTag element)
DomFileDescription<?>	getDomFileDescription(PsiElement element)
DomInvocationHandler	getDomHandler(XmlElement xml)
static DomInvocationHandler	getDomInvocationHandler(DomElement proxy)
static DomManagerImpl	getDomManager(Project project)
java.util.Set<DomFileDescription<?>>	getFileDescriptions(java.lang.String rootTagName)
<T extends DomElement> DomFileElementImpl<T>	getFileElement(XmlFile file)
<T extends DomElement> DomFileElementImpl<T>	getFileElement(XmlFile file, java.lang.Class<T> domClass)
<T extends DomElement> DomFileElementImpl<T>	getFileElement(XmlFile file, java.lang.Class<T> aClass, java.lang.String rootTagName)
DomGenericInfo	getGenericInfo(java.lang.reflect.Type type)
DomElement	getIdentityScope(DomElement element)
static DomInvocationHandler	getNotNullHandler(DomElement proxy)
Project	getProject()
long	getPsiModificationCount()
DomElement	getResolvingScope(GenericDomValue<?> element)
static com.intellij.util.xml.impl.StableInvocationHandler<?>	getStableInvocationHandler(java.lang.Object proxy)
TypeChooserManager	getTypeChooserManager()
boolean	isDomFile(PsiFile file)
boolean	isMockElement(DomElement element)
void	registerFileDescription(DomFileDescription<?> description) Registers a new DomFileDescription within the manager.
<T extends DomElement> void	registerFileDescription(DomFileDescription<T> description, Disposable parentDisposable)

Methods inherited from class com.intellij.util.xml.DomManager

getDomFileDescription

Methods inherited from class com.intellij.openapi.util.CompositeModificationTracker

getModificationCount

Methods inherited from class com.intellij.openapi.util.SimpleModificationTracker

incModificationCount

Methods inherited from class java.lang.Object

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

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

getModificationCount

Constructor Detail

DomManagerImpl

public DomManagerImpl(Project project)

Method Detail

getPsiModificationCount

public long getPsiModificationCount()

getDomManager

public static DomManagerImpl getDomManager(Project project)

addDomEventListener

public void addDomEventListener(DomEventListener listener,
                                Disposable parentDisposable)

Specified by:

addDomEventListener in class DomManager

getConverterManager

public final ConverterManager getConverterManager()

Specified by:

getConverterManager in class DomManager

Returns:

ConverterManager instance

createModelMerger

public final ModelMerger createModelMerger()

Specified by:

createModelMerger in class DomManager

getGenericInfo

public final DomGenericInfo getGenericInfo(java.lang.reflect.Type type)

Specified by:

getGenericInfo in class DomManager

Parameters:

type - Type. Only Class and ParameterizedType are allowed

Returns:

DomGenericInfo instance for the desired type

getDomInvocationHandler

public static DomInvocationHandler getDomInvocationHandler(DomElement proxy)

getNotNullHandler

public static DomInvocationHandler getNotNullHandler(DomElement proxy)

getStableInvocationHandler

public static com.intellij.util.xml.impl.StableInvocationHandler<?> getStableInvocationHandler(java.lang.Object proxy)

getApplicationComponent

public DomApplicationComponent getApplicationComponent()

getProject

public final Project getProject()

Specified by:

getProject in class DomManager

getFileElement

public final <T extends DomElement> DomFileElementImpl<T> getFileElement(XmlFile file,
                                                                         java.lang.Class<T> aClass,
                                                                         java.lang.String rootTagName)

Specified by:

getFileElement in class DomManager

getFileDescriptions

public final java.util.Set<DomFileDescription<?>> getFileDescriptions(java.lang.String rootTagName)

getAcceptingOtherRootTagNameDescriptions

public final java.util.Set<DomFileDescription<?>> getAcceptingOtherRootTagNameDescriptions()

getComponentName

public final java.lang.String getComponentName()

getFileElement

public final <T extends DomElement> DomFileElementImpl<T> getFileElement(XmlFile file)

Specified by:

getFileElement in class DomManager

getFileElement

public final <T extends DomElement> DomFileElementImpl<T> getFileElement(XmlFile file,
                                                                         java.lang.Class<T> domClass)

Specified by:

getFileElement in class DomManager

Parameters:

file - XML file

domClass - desired DOM element class

Returns:

New or cached DOM file element for the given file. All registered DomFileDescriptions are asked if they are responsible for the file DomFileDescription.isMyFile(XmlFile, Module). If there is a DomFileDescription that is responsible for the file, but its DomFileDescription.getRootElementClass() result is incompatible with domClass parameter, null is returned

getDomElement

public final DomElement getDomElement(XmlTag element)

Specified by:

getDomElement in class DomManager

Parameters:

element - tag

Returns:

DOM element for the given tag. If DOM isn't initialized for the containing file, it will be initialized

getDomElement

public GenericAttributeValue<?> getDomElement(XmlAttribute attribute)

Specified by:

getDomElement in class DomManager

Parameters:

attribute - attribute

Returns:

DOM element for the given XML attribute. If DOM isn't initialized for the containing file, it will be initialized

getDomHandler

public DomInvocationHandler getDomHandler(XmlElement xml)

findChildrenDescription

public AbstractDomChildrenDescription findChildrenDescription(XmlTag tag,
                                                              DomElement parent)

Specified by:

findChildrenDescription in class DomManager

isDomFile

public final boolean isDomFile(PsiFile file)

getDomFileDescription

public final DomFileDescription<?> getDomFileDescription(PsiElement element)

createMockElement

public final <T extends DomElement> T createMockElement(java.lang.Class<T> aClass,
                                                        Module module,
                                                        boolean physical)

Specified by:

createMockElement in class DomManager

Parameters:

aClass - Desired DOM element class

module - One may wish the result to think that it is in a particular module

physical - see PsiElement.isPhysical()

Returns:

DOM element which doesn't have any real file under itself. A mock file is created for it. See PsiFileFactory.createFileFromText(String, com.intellij.openapi.fileTypes.FileType, CharSequence, long, boolean, boolean)

isMockElement

public final boolean isMockElement(DomElement element)

Specified by:

isMockElement in class DomManager

Parameters:

element - DOM element

Returns:

true if this element was created by DomManager.createMockElement(Class, Module, boolean) method

createStableValue

public final <T extends DomElement> T createStableValue(Factory<? extends T> provider)

Description copied from class: DomManager

Creates DOM element of needed type, that is wrapper around real DOM element. Once the wrapped element becomes invalid, a new value is requested from provider parameter, so there's a possibility to restore the functionality. The resulting element will also implement StableElement interface.

Specified by:

createStableValue in class DomManager

Parameters:

provider - provides values to be wrapped

Returns:

stable DOM element

createStableValue

public final <T> T createStableValue(Factory<? extends T> provider,
                                     Condition<? super T> validator)

Specified by:

createStableValue in class DomManager

registerFileDescription

public final <T extends DomElement> void registerFileDescription(DomFileDescription<T> description,
                                                                 Disposable parentDisposable)

registerFileDescription

public final void registerFileDescription(DomFileDescription<?> description)

Description copied from class: DomManager

Registers a new DomFileDescription within the manager. The description parameter describes some DOM parameters and restrictions to the particular XML files, that need DOM support. Should be called on ProjectComponent loading.

Specified by:

registerFileDescription in class DomManager

Parameters:

description - The description in question

getResolvingScope

public final DomElement getResolvingScope(GenericDomValue<?> element)

Specified by:

getResolvingScope in class DomManager

Parameters:

element - reference element

Returns:

element that represents the resolve scope for the given reference. DomResolveConverter uses this method to resolve DOM references. This result's subtree will be traversed recursively searching for the reference target. See Resolve annotation.

getIdentityScope

public final DomElement getIdentityScope(DomElement element)

Specified by:

getIdentityScope in class DomManager

Parameters:

element - Named DOM element

Returns:

The scope within which the element's name identity will be checked by DomHighlightingHelper.checkNameIdentity(DomElement, com.intellij.util.xml.highlighting.DomElementAnnotationHolder)

getTypeChooserManager

public TypeChooserManager getTypeChooserManager()

Specified by:

getTypeChooserManager in class DomManager

Returns:

TypeChooserManager instance