Package net.sourceforge.pmd.lang.xml.ast

Class XmlNodeWrapper

java.lang.Object

net.sourceforge.pmd.lang.ast.AbstractNode

net.sourceforge.pmd.lang.xml.ast.AbstractDomNodeProxy

net.sourceforge.pmd.lang.xml.ast.XmlNodeWrapper

All Implemented Interfaces:

Node, AttributeNode, XmlNode, Node

Direct Known Subclasses:

XmlParser.RootXmlNode

public class XmlNodeWrapper
extends AbstractDomNodeProxy
implements XmlNode

Proxy wrapping an XML DOM node (Node) to implement PMD interfaces.

Since:

6.1.0

Author:

Clément Fournier

Field Summary

Fields inherited from class net.sourceforge.pmd.lang.xml.ast.AbstractDomNodeProxy

node

Fields inherited from class net.sourceforge.pmd.lang.ast.AbstractNode

beginColumn, beginLine, childIndex, children, endColumn, endLine, firstToken, id, lastToken, parent

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Fields inherited from interface net.sourceforge.pmd.lang.xml.ast.XmlNode

BEGIN_COLUMN, BEGIN_LINE, END_COLUMN, END_LINE

Constructor Summary

Constructors

Constructor	Description
XmlNodeWrapper(XmlParser parser, Node domNode)

Method Summary

Modifier and Type	Method	Description
Document	getAsDocument()
Iterator<Attribute>	getAttributeIterator()	Deprecated. use getXPathAttributesIterator()
int	getBeginColumn()
int	getBeginLine()
Node	getChild(int index)
DataFlowNode	getDataFlowNode()
int	getEndColumn()
int	getEndLine()
String	getImage()
Node	getNode()	Provide access to the underlying DOM node.
int	getNumChildren()
Object	getUserData()
Iterator<Attribute>	getXPathAttributesIterator()
String	getXPathNodeName()
boolean	hasImageEqualTo(String image)
boolean	isFindBoundary()
void	jjtAddChild(Node child, int index)
void	jjtClose()
XmlNode	jjtGetChild(int index)
int	jjtGetChildIndex()
int	jjtGetId()
int	jjtGetNumChildren()
XmlNode	jjtGetParent()
void	jjtSetChildIndex(int index)
void	jjtSetParent(Node parent)
void	remove()
void	removeChildAtIndex(int childIndex)
void	setDataFlowNode(DataFlowNode dataFlowNode)
void	setImage(String image)
void	setUserData(Object userData)
String	toString()

Methods inherited from class net.sourceforge.pmd.lang.xml.ast.AbstractDomNodeProxy

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Methods inherited from class net.sourceforge.pmd.lang.ast.AbstractNode

appendElement, children, findChildNodesWithXPath, findChildrenOfType, findDescendantsOfType, findDescendantsOfType, findDescendantsOfType, getFirstChildOfType, getFirstDescendantOfType, getFirstParentOfAnyType, getFirstParentOfType, getIndexInParent, getNthParent, getParent, getParentsOfType, getUserMap, hasDecendantOfAnyType, hasDescendantMatchingXPath, hasDescendantOfAnyType, hasDescendantOfType, isSingleLine, jjtGetFirstToken, jjtGetLastToken, jjtOpen, jjtSetFirstToken, jjtSetLastToken, testingOnlySetBeginColumn, testingOnlySetBeginLine, testingOnlySetEndColumn, testingOnlySetEndLine

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.pmd.lang.ast.Node

children, findChildNodesWithXPath, findChildrenOfType, findDescendantsOfType, findDescendantsOfType, findDescendantsOfType, getFirstChildOfType, getFirstDescendantOfType, getFirstParentOfAnyType, getFirstParentOfType, getIndexInParent, getNthParent, getParent, getParentsOfType, getUserMap, hasDescendantMatchingXPath, hasDescendantOfType, jjtOpen

Constructor Detail

XmlNodeWrapper

public XmlNodeWrapper(XmlParser parser,
                      Node domNode)

Method Detail

jjtClose

public void jjtClose()

Specified by:

jjtClose in interface Node

Overrides:

jjtClose in class AbstractNode

jjtSetParent

public void jjtSetParent(Node parent)

Specified by:

jjtSetParent in interface Node

Overrides:

jjtSetParent in class AbstractNode

jjtGetParent

public XmlNode jjtGetParent()

Specified by:

jjtGetParent in interface Node

Overrides:

jjtGetParent in class AbstractNode

jjtAddChild

public void jjtAddChild(Node child,
                        int index)

Specified by:

jjtAddChild in interface Node

Overrides:

jjtAddChild in class AbstractNode

jjtSetChildIndex

public void jjtSetChildIndex(int index)

Specified by:

jjtSetChildIndex in interface Node

Overrides:

jjtSetChildIndex in class AbstractNode

jjtGetChildIndex

public int jjtGetChildIndex()

Specified by:

jjtGetChildIndex in interface Node

Overrides:

jjtGetChildIndex in class AbstractNode

jjtGetChild

public XmlNode jjtGetChild(int index)

Specified by:

jjtGetChild in interface Node

Overrides:

jjtGetChild in class AbstractNode

getChild

public Node getChild(int index)

Specified by:

getChild in interface Node

Overrides:

getChild in class AbstractNode

jjtGetNumChildren

public int jjtGetNumChildren()

Specified by:

jjtGetNumChildren in interface Node

Overrides:

jjtGetNumChildren in class AbstractNode

getNumChildren

public int getNumChildren()

Specified by:

getNumChildren in interface Node

Overrides:

getNumChildren in class AbstractNode

jjtGetId

public int jjtGetId()

Specified by:

jjtGetId in interface Node

Overrides:

jjtGetId in class AbstractNode

getImage

public String getImage()

Specified by:

getImage in interface Node

Overrides:

getImage in class AbstractNode

setImage

public void setImage(String image)

Specified by:

setImage in interface Node

Overrides:

setImage in class AbstractNode

hasImageEqualTo

public boolean hasImageEqualTo(String image)

Specified by:

hasImageEqualTo in interface Node

Overrides:

hasImageEqualTo in class AbstractNode

getBeginLine

public int getBeginLine()

Specified by:

getBeginLine in interface Node

Overrides:

getBeginLine in class AbstractNode

getBeginColumn

public int getBeginColumn()

Specified by:

getBeginColumn in interface Node

Overrides:

getBeginColumn in class AbstractNode

getEndLine

public int getEndLine()

Specified by:

getEndLine in interface Node

Overrides:

getEndLine in class AbstractNode

getEndColumn

public int getEndColumn()

Specified by:

getEndColumn in interface Node

Overrides:

getEndColumn in class AbstractNode

getDataFlowNode

public DataFlowNode getDataFlowNode()

Specified by:

getDataFlowNode in interface Node

Overrides:

getDataFlowNode in class AbstractNode

setDataFlowNode

public void setDataFlowNode(DataFlowNode dataFlowNode)

Specified by:

setDataFlowNode in interface Node

Overrides:

setDataFlowNode in class AbstractNode

isFindBoundary

public boolean isFindBoundary()

Specified by:

isFindBoundary in interface Node

Overrides:

isFindBoundary in class AbstractNode

getAsDocument

public Document getAsDocument()

Specified by:

getAsDocument in interface Node

Overrides:

getAsDocument in class AbstractNode

getUserData

public Object getUserData()

Specified by:

getUserData in interface Node

Overrides:

getUserData in class AbstractNode

setUserData

public void setUserData(Object userData)

Specified by:

setUserData in interface Node

Overrides:

setUserData in class AbstractNode

remove

public void remove()

Specified by:

remove in interface Node

Overrides:

remove in class AbstractNode

removeChildAtIndex

public void removeChildAtIndex(int childIndex)

Specified by:

removeChildAtIndex in interface Node

Overrides:

removeChildAtIndex in class AbstractNode

getXPathNodeName

public String getXPathNodeName()

Specified by:

getXPathNodeName in interface Node

Overrides:

getXPathNodeName in class AbstractNode

toString

public String toString()

Overrides:

toString in class AbstractNode

getXPathAttributesIterator

public Iterator<Attribute> getXPathAttributesIterator()

Specified by:

getXPathAttributesIterator in interface Node

Overrides:

getXPathAttributesIterator in class AbstractNode

getAttributeIterator

@Deprecated
public Iterator<Attribute> getAttributeIterator()

Deprecated.

use getXPathAttributesIterator()

Specified by:

getAttributeIterator in interface AttributeNode

getNode

public Node getNode()

Description copied from interface: XmlNode

Provide access to the underlying DOM node.

Specified by:

getNode in interface XmlNode

Returns:

The DOM node.