Package net.sourceforge.pmd.lang.xml.rule

Class AbstractDomXmlRule

java.lang.Object

net.sourceforge.pmd.properties.AbstractPropertySource

net.sourceforge.pmd.lang.rule.AbstractRule

net.sourceforge.pmd.lang.xml.rule.AbstractXmlRule

net.sourceforge.pmd.lang.xml.rule.AbstractDomXmlRule

All Implemented Interfaces:

net.sourceforge.pmd.lang.rule.ImmutableLanguage, net.sourceforge.pmd.properties.PropertySource, net.sourceforge.pmd.Rule

public class AbstractDomXmlRule
extends AbstractXmlRule

This is a base class for XML Java bases rules that which to visit the nodes using the DOM. Subclasses should override the DOM appropriate method and can call super to visit children.

Field Summary

Fields inherited from class net.sourceforge.pmd.lang.xml.rule.AbstractXmlRule

COALESCING_DESCRIPTOR, EXPAND_ENTITY_REFERENCES_DESCRIPTOR, IGNORING_COMMENTS_DESCRIPTOR, IGNORING_ELEMENT_CONTENT_WHITESPACE_DESCRIPTOR, NAMESPACE_AWARE_DESCRIPTOR, VALIDATING_DESCRIPTOR, XINCLUDE_AWARE_DESCRIPTOR

Fields inherited from class net.sourceforge.pmd.properties.AbstractPropertySource

propertyDescriptors, propertyValuesByDescriptor

Fields inherited from interface net.sourceforge.pmd.Rule

VIOLATION_SUPPRESS_REGEX_DESCRIPTOR, VIOLATION_SUPPRESS_XPATH_DESCRIPTOR

Constructor Summary

Constructors

Constructor	Description
AbstractDomXmlRule()

Method Summary

Modifier and Type	Method	Description
protected void	visit(XmlNode node, net.sourceforge.pmd.RuleContext ctx)
protected void	visit(XmlNode node, org.w3c.dom.Attr attr, net.sourceforge.pmd.RuleContext ctx)
protected void	visit(XmlNode node, org.w3c.dom.CharacterData characterData, net.sourceforge.pmd.RuleContext ctx)
protected void	visit(XmlNode node, org.w3c.dom.Comment comment, net.sourceforge.pmd.RuleContext ctx)
protected void	visit(XmlNode node, org.w3c.dom.Document document, net.sourceforge.pmd.RuleContext ctx)
protected void	visit(XmlNode node, org.w3c.dom.DocumentType documentType, net.sourceforge.pmd.RuleContext ctx)
protected void	visit(XmlNode node, org.w3c.dom.Element element, net.sourceforge.pmd.RuleContext ctx)
protected void	visit(XmlNode node, org.w3c.dom.EntityReference entityReference, net.sourceforge.pmd.RuleContext ctx)
protected void	visit(XmlNode node, org.w3c.dom.Entity entity, net.sourceforge.pmd.RuleContext ctx)
protected void	visit(XmlNode node, org.w3c.dom.Notation notation, net.sourceforge.pmd.RuleContext ctx)
protected void	visit(XmlNode node, org.w3c.dom.ProcessingInstruction processingInstruction, net.sourceforge.pmd.RuleContext ctx)
protected void	visit(XmlNode node, org.w3c.dom.Text text, net.sourceforge.pmd.RuleContext ctx)
protected void	visitAttributeNodes(XmlNode node, org.w3c.dom.Node domNode, net.sourceforge.pmd.RuleContext ctx)
protected void	visitDomNode(XmlNode node, org.w3c.dom.Node domNode, net.sourceforge.pmd.RuleContext ctx)

Methods inherited from class net.sourceforge.pmd.lang.xml.rule.AbstractXmlRule

apply, getParserOptions, visitAll

Methods inherited from class net.sourceforge.pmd.lang.rule.AbstractRule

addExample, addRuleChainVisit, addRuleChainVisit, addViolation, addViolation, addViolation, addViolationWithMessage, addViolationWithMessage, addViolationWithMessage, deepCopy, deepCopyValuesTo, end, equals, getDescription, getExamples, getExternalInfoUrl, getLanguage, getMaximumLanguageVersion, getMessage, getMinimumLanguageVersion, getName, getPriority, getPropertySourceType, getRuleChainVisits, getRuleClass, getRuleSetName, getSince, hashCode, isDeprecated, isDfa, isMultifile, isRuleChain, isTypeResolution, setDeprecated, setDescription, setDfa, setExternalInfoUrl, setLanguage, setMaximumLanguageVersion, setMessage, setMinimumLanguageVersion, setMultifile, setName, setPriority, setRuleClass, setRuleSetName, setSince, setTypeResolution, setUsesDFA, setUsesMultifile, setUsesTypeResolution, start, usesDFA, usesMultifile, usesRuleChain, usesTypeResolution

Methods inherited from class net.sourceforge.pmd.properties.AbstractPropertySource

copyPropertyDescriptors, copyPropertyValues, definePropertyDescriptor, dysfunctionReason, getOverriddenPropertiesByPropertyDescriptor, getOverriddenPropertyDescriptors, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, ignoredProperties, isPropertyOverridden, setProperty, setProperty, useDefaultValueFor, usesDefaultValues

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.pmd.properties.PropertySource

definePropertyDescriptor, dysfunctionReason, getOverriddenPropertiesByPropertyDescriptor, getOverriddenPropertyDescriptors, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, ignoredProperties, isPropertyOverridden, setProperty, setProperty, useDefaultValueFor, usesDefaultValues

Constructor Detail

AbstractDomXmlRule

public AbstractDomXmlRule()

Method Detail

visit

protected void visit(XmlNode node,
                     net.sourceforge.pmd.RuleContext ctx)

Overrides:

visit in class AbstractXmlRule

visitDomNode

protected void visitDomNode(XmlNode node,
                            org.w3c.dom.Node domNode,
                            net.sourceforge.pmd.RuleContext ctx)

visitAttributeNodes

protected void visitAttributeNodes(XmlNode node,
                                   org.w3c.dom.Node domNode,
                                   net.sourceforge.pmd.RuleContext ctx)

visit

protected void visit(XmlNode node,
                     org.w3c.dom.Attr attr,
                     net.sourceforge.pmd.RuleContext ctx)

visit

protected void visit(XmlNode node,
                     org.w3c.dom.CharacterData characterData,
                     net.sourceforge.pmd.RuleContext ctx)

visit

protected void visit(XmlNode node,
                     org.w3c.dom.Comment comment,
                     net.sourceforge.pmd.RuleContext ctx)

visit

protected void visit(XmlNode node,
                     org.w3c.dom.Document document,
                     net.sourceforge.pmd.RuleContext ctx)

visit

protected void visit(XmlNode node,
                     org.w3c.dom.DocumentType documentType,
                     net.sourceforge.pmd.RuleContext ctx)

visit

protected void visit(XmlNode node,
                     org.w3c.dom.Element element,
                     net.sourceforge.pmd.RuleContext ctx)

visit

protected void visit(XmlNode node,
                     org.w3c.dom.Entity entity,
                     net.sourceforge.pmd.RuleContext ctx)

visit

protected void visit(XmlNode node,
                     org.w3c.dom.EntityReference entityReference,
                     net.sourceforge.pmd.RuleContext ctx)

visit

protected void visit(XmlNode node,
                     org.w3c.dom.Notation notation,
                     net.sourceforge.pmd.RuleContext ctx)

visit

protected void visit(XmlNode node,
                     org.w3c.dom.ProcessingInstruction processingInstruction,
                     net.sourceforge.pmd.RuleContext ctx)

visit

protected void visit(XmlNode node,
                     org.w3c.dom.Text text,
                     net.sourceforge.pmd.RuleContext ctx)