Package com.intellij.util.xml.impl

Class DomInvocationHandler

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.util.xml.impl.DomInvocationHandler

All Implemented Interfaces:

UserDataHolder, UserDataHolderEx, AnnotatedElement, DomElement

Direct Known Subclasses:

AttributeChildInvocationHandler, CollectionElementInvocationHandler, DomRootInvocationHandler, IndexedElementInvocationHandler

public abstract class DomInvocationHandler
extends UserDataHolderBase
implements DomElement

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.reflect.Method	ACCEPT_CHILDREN_METHOD
static java.lang.reflect.Method	ACCEPT_METHOD
protected DomStub	myStub

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

EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DomInvocationHandler(java.lang.reflect.Type type, DomParentStrategy parentStrategy, EvaluatedXmlName tagName, AbstractDomChildDescriptionImpl childDescription, DomManagerImpl manager, boolean dynamic, DomStub stub)

Method Summary

Modifier and Type	Method and Description
void	accept(DomElementVisitor visitor)
void	acceptChildren(DomElementVisitor visitor)
DomElement	addCollectionChild(CollectionChildDescriptionImpl description, java.lang.reflect.Type type, int index)
protected void	addRequiredChildren()
protected void	assertValid()
protected java.lang.String	checkValidity()
void	copyFrom(DomElement other)
protected XmlTag	createChildTag(EvaluatedXmlName tagName)
EvaluatedXmlName	createEvaluatedXmlName(XmlName xmlName)
protected void	createFixedChildrenTags(EvaluatedXmlName tagName, FixedChildDescriptionImpl description, int count)
<T extends DomElement> T	createMockCopy(boolean physical)
protected DomElement	createPathStableCopy()
<T extends DomElement> T	createStableCopy()
protected void	deleteTag(XmlTag tag)
protected void	detach()
XmlTag	ensureTagExists()
XmlElement	ensureXmlElementExists()
boolean	equals(java.lang.Object o)
boolean	exists()
protected void	fireUndefinedEvent()
<T extends java.lang.annotation.Annotation> T	getAnnotation(java.lang.Class<T> annotationClass)
AbstractDomChildDescriptionImpl	getChildDescription()
protected <T extends java.lang.annotation.Annotation> T	getClassAnnotation(java.lang.Class<T> annotationClass)
java.util.List<? extends DomElement>	getCollectionChildren(AbstractCollectionChildDescription description)
java.util.List<? extends DomElement>	getCollectionChildren(AbstractCollectionChildDescription description, boolean processIncludes)
java.lang.reflect.Type	getDomElementType()
XmlFile	getFile()
DomGenericInfoEx	getGenericInfo()
DomManagerImpl	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()
DomElement	getProxy()
java.lang.Class<?>	getRawType()
GlobalSearchScope	getResolveScope()
protected Converter	getScalarConverter()
DomStub	getStub()
protected java.lang.String	getValue()
XmlElement	getXmlElement() Returns the underlying XML element/file.
java.lang.String	getXmlElementName()
java.lang.String	getXmlElementNamespace()
java.lang.String	getXmlElementNamespaceKey()
EvaluatedXmlName	getXmlName()
XmlTag	getXmlTag()
int	hashCode()
java.lang.Object	invoke(java.lang.Object proxy, java.lang.reflect.Method method, java.lang.Object[] args)
protected boolean	isAttribute()
boolean	isValid()
protected java.lang.reflect.Type	narrowType(java.lang.reflect.Type nominalType)
protected XmlElement	recomputeXmlElement(DomInvocationHandler parentHandler)
protected abstract XmlTag	setEmptyXmlTag()
protected void	setValue(java.lang.String value)
protected void	setXmlElement(XmlElement element)
java.lang.String	toString()
void	undefine() Removes all corresponding XML content.
protected abstract void	undefineInternal()

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

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

getUserData, putUserData

Field Detail

ACCEPT_METHOD

public static final java.lang.reflect.Method ACCEPT_METHOD

ACCEPT_CHILDREN_METHOD

public static final java.lang.reflect.Method ACCEPT_CHILDREN_METHOD

myStub

protected DomStub myStub

Constructor Detail

DomInvocationHandler

protected DomInvocationHandler(java.lang.reflect.Type type,
                               DomParentStrategy parentStrategy,
                               EvaluatedXmlName tagName,
                               AbstractDomChildDescriptionImpl childDescription,
                               DomManagerImpl manager,
                               boolean dynamic,
                               DomStub stub)

Method Detail

narrowType

protected java.lang.reflect.Type narrowType(java.lang.reflect.Type nominalType)

getParent

public DomElement getParent()

Specified by:

getParent in interface DomElement

assertValid

protected final void assertValid()

getStub

public DomStub getStub()

getDomElementType

public final java.lang.reflect.Type getDomElementType()

Specified by:

getDomElementType in interface DomElement

getValue

protected java.lang.String getValue()

setValue

protected void setValue(java.lang.String value)

copyFrom

public void copyFrom(DomElement other)

Specified by:

copyFrom in interface DomElement

createStableCopy

public <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'.

createPathStableCopy

protected DomElement createPathStableCopy()

createMockCopy

public final <T extends DomElement> T createMockCopy(boolean physical)

Specified by:

createMockCopy in interface DomElement

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

getModule

public final Module getModule()

Specified by:

getModule in interface DomElement

ensureTagExists

public XmlTag ensureTagExists()

Specified by:

ensureTagExists in interface DomElement

getXmlElement

public XmlElement getXmlElement()

Description copied from interface: DomElement

Returns the underlying XML element/file.

Specified by:

getXmlElement in interface DomElement

Returns:

XmlFile, XmlTag or XmlAttribute

exists

public boolean exists()

Specified by:

exists in interface DomElement

Returns:

true if corresponding XML element exists

ensureXmlElementExists

public XmlElement ensureXmlElementExists()

Specified by:

ensureXmlElementExists in interface DomElement

createChildTag

protected final XmlTag createChildTag(EvaluatedXmlName tagName)

isValid

public final boolean isValid()

Specified by:

isValid in interface DomElement

checkValidity

protected java.lang.String checkValidity()

getGenericInfo

public final DomGenericInfoEx getGenericInfo()

Specified by:

getGenericInfo in interface DomElement

undefineInternal

protected abstract void undefineInternal()

undefine

public final 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

deleteTag

protected final void deleteTag(XmlTag tag)

fireUndefinedEvent

protected final void fireUndefinedEvent()

setEmptyXmlTag

protected abstract XmlTag setEmptyXmlTag()

addRequiredChildren

protected void addRequiredChildren()

getXmlElementName

public final java.lang.String getXmlElementName()

Specified by:

getXmlElementName in interface DomElement

getXmlName

public final EvaluatedXmlName getXmlName()

accept

public void accept(DomElementVisitor visitor)

Specified by:

accept in interface DomElement

acceptChildren

public void acceptChildren(DomElementVisitor visitor)

Specified by:

acceptChildren in interface DomElement

getScalarConverter

protected final Converter getScalarConverter()

getChildDescription

public AbstractDomChildDescriptionImpl getChildDescription()

Specified by:

getChildDescription in interface DomElement

getAnnotation

public <T extends java.lang.annotation.Annotation> T getAnnotation(java.lang.Class<T> annotationClass)

Specified by:

getAnnotation in interface AnnotatedElement

getClassAnnotation

protected <T extends java.lang.annotation.Annotation> T getClassAnnotation(java.lang.Class<T> annotationClass)

getProxy

public final DomElement getProxy()

getFile

public final XmlFile getFile()

getNameStrategy

public DomNameStrategy getNameStrategy()

Specified by:

getNameStrategy in interface DomElement

isAttribute

protected boolean isAttribute()

getPresentation

public ElementPresentation getPresentation()

Specified by:

getPresentation in interface DomElement

getResolveScope

public final GlobalSearchScope getResolveScope()

Specified by:

getResolveScope in interface DomElement

getParentOfType

public final <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

invoke

public final java.lang.Object invoke(java.lang.Object proxy,
                                     java.lang.reflect.Method method,
                                     java.lang.Object[] args)
                              throws java.lang.Throwable

Throws:

java.lang.Throwable

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

getRawType

public final java.lang.Class<?> getRawType()

getXmlTag

public XmlTag getXmlTag()

Specified by:

getXmlTag in interface DomElement

recomputeXmlElement

protected XmlElement recomputeXmlElement(DomInvocationHandler parentHandler)

detach

protected final void detach()

setXmlElement

protected final void setXmlElement(XmlElement element)

getManager

public final DomManagerImpl getManager()

Specified by:

getManager in interface DomElement

addCollectionChild

public final DomElement addCollectionChild(CollectionChildDescriptionImpl description,
                                           java.lang.reflect.Type type,
                                           int index)
                                    throws IncorrectOperationException

Throws:

IncorrectOperationException

createFixedChildrenTags

protected final void createFixedChildrenTags(EvaluatedXmlName tagName,
                                             FixedChildDescriptionImpl description,
                                             int count)

createEvaluatedXmlName

public final EvaluatedXmlName createEvaluatedXmlName(XmlName xmlName)

getCollectionChildren

public java.util.List<? extends DomElement> getCollectionChildren(AbstractCollectionChildDescription description)

getCollectionChildren

public java.util.List<? extends DomElement> getCollectionChildren(AbstractCollectionChildDescription description,
                                                                  boolean processIncludes)

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